@Generated(value="jsii-pacmak/1.60.0 (build ebcefe6)", date="2022-06-22T23:27:50.605Z") public class CfnConfig extends CfnResource implements IInspectable
Creates a Config
with the specified parameters.
Config objects provide Ground Station with the details necessary in order to schedule and execute satellite contacts.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.groundstation.*; CfnConfig cfnConfig = CfnConfig.Builder.create(this, "MyCfnConfig") .configData(ConfigDataProperty.builder() .antennaDownlinkConfig(AntennaDownlinkConfigProperty.builder() .spectrumConfig(SpectrumConfigProperty.builder() .bandwidth(FrequencyBandwidthProperty.builder() .units("units") .value(123) .build()) .centerFrequency(FrequencyProperty.builder() .units("units") .value(123) .build()) .polarization("polarization") .build()) .build()) .antennaDownlinkDemodDecodeConfig(AntennaDownlinkDemodDecodeConfigProperty.builder() .decodeConfig(DecodeConfigProperty.builder() .unvalidatedJson("unvalidatedJson") .build()) .demodulationConfig(DemodulationConfigProperty.builder() .unvalidatedJson("unvalidatedJson") .build()) .spectrumConfig(SpectrumConfigProperty.builder() .bandwidth(FrequencyBandwidthProperty.builder() .units("units") .value(123) .build()) .centerFrequency(FrequencyProperty.builder() .units("units") .value(123) .build()) .polarization("polarization") .build()) .build()) .antennaUplinkConfig(AntennaUplinkConfigProperty.builder() .spectrumConfig(UplinkSpectrumConfigProperty.builder() .centerFrequency(FrequencyProperty.builder() .units("units") .value(123) .build()) .polarization("polarization") .build()) .targetEirp(EirpProperty.builder() .units("units") .value(123) .build()) .transmitDisabled(false) .build()) .dataflowEndpointConfig(DataflowEndpointConfigProperty.builder() .dataflowEndpointName("dataflowEndpointName") .dataflowEndpointRegion("dataflowEndpointRegion") .build()) .s3RecordingConfig(S3RecordingConfigProperty.builder() .bucketArn("bucketArn") .prefix("prefix") .roleArn("roleArn") .build()) .trackingConfig(TrackingConfigProperty.builder() .autotrack("autotrack") .build()) .uplinkEchoConfig(UplinkEchoConfigProperty.builder() .antennaUplinkConfigArn("antennaUplinkConfigArn") .enabled(false) .build()) .build()) .name("name") // the properties below are optional .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
Modifier and Type | Class and Description |
---|---|
static interface |
CfnConfig.AntennaDownlinkConfigProperty
Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.
|
static interface |
CfnConfig.AntennaDownlinkDemodDecodeConfigProperty
Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.
|
static interface |
CfnConfig.AntennaUplinkConfigProperty
Provides information about how AWS Ground Station should configure an antenna for uplink during a contact.
|
static class |
CfnConfig.Builder
A fluent builder for
CfnConfig . |
static interface |
CfnConfig.ConfigDataProperty
Config objects provide information to Ground Station about how to configure the antenna and how data flows during a contact.
|
static interface |
CfnConfig.DataflowEndpointConfigProperty
Provides information to AWS Ground Station about which IP endpoints to use during a contact.
|
static interface |
CfnConfig.DecodeConfigProperty
Defines decoding settings.
|
static interface |
CfnConfig.DemodulationConfigProperty
Defines demodulation settings.
|
static interface |
CfnConfig.EirpProperty
Defines an equivalent isotropically radiated power (EIRP).
|
static interface |
CfnConfig.FrequencyBandwidthProperty
Defines a bandwidth.
|
static interface |
CfnConfig.FrequencyProperty
Defines a frequency.
|
static interface |
CfnConfig.S3RecordingConfigProperty
Provides information about how AWS Ground Station should save downlink data to S3.
|
static interface |
CfnConfig.SpectrumConfigProperty
Defines a spectrum.
|
static interface |
CfnConfig.TrackingConfigProperty
Provides information about how AWS Ground Station should track the satellite through the sky during a contact.
|
static interface |
CfnConfig.UplinkEchoConfigProperty
Provides information about how AWS Ground Station should echo back uplink transmissions to a dataflow endpoint.
|
static interface |
CfnConfig.UplinkSpectrumConfigProperty
Defines a uplink spectrum.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
Modifier | Constructor and Description |
---|---|
|
CfnConfig(Construct scope,
java.lang.String id,
CfnConfigProps props)
Create a new `AWS::GroundStation::Config`.
|
protected |
CfnConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnConfig(software.amazon.jsii.JsiiObjectRef objRef) |
Modifier and Type | Method and Description |
---|---|
java.lang.String |
getAttrArn()
The ARN of the config, such as `arn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296` .
|
java.lang.String |
getAttrId()
The ID of the config, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` .
|
java.lang.String |
getAttrType()
The type of the config, such as `tracking` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getConfigData()
Object containing the parameters of a config.
|
java.lang.String |
getName()
The name of the config object.
|
TagManager |
getTags()
Tags assigned to a resource.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setConfigData(CfnConfig.ConfigDataProperty value)
Object containing the parameters of a config.
|
void |
setConfigData(IResolvable value)
Object containing the parameters of a config.
|
void |
setName(java.lang.String value)
The name of the config object.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnConfig(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnConfig(Construct scope, java.lang.String id, CfnConfigProps props)
scope
- - scope in which this resource is defined. This parameter is required.id
- - scoped id of the resource. This parameter is required.props
- - resource properties. This parameter is required.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.public java.lang.String getAttrArn()
public java.lang.String getAttrId()
public java.lang.String getAttrType()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public TagManager getTags()
public java.lang.Object getConfigData()
Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.
public void setConfigData(CfnConfig.ConfigDataProperty value)
Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.
public void setConfigData(IResolvable value)
Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.
public java.lang.String getName()
public void setName(java.lang.String value)