Class CfnConfig
java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.groundstation.CfnConfig
- All Implemented Interfaces:
IInspectable
,ITaggable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
,software.constructs.IDependable
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)",
date="2024-11-06T23:25:10.883Z")
@Stability(Stable)
public class CfnConfig
extends CfnResource
implements IInspectable, ITaggable
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();
- See Also:
-
Nested Class Summary
Modifier and TypeClassDescriptionstatic interface
Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.static interface
Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.static interface
Provides information about how AWS Ground Station should configure an antenna for uplink during a contact.static final class
A fluent builder forCfnConfig
.static interface
Config objects provide information to Ground Station about how to configure the antenna and how data flows during a contact.static interface
Provides information to AWS Ground Station about which IP endpoints to use during a contact.static interface
Defines decoding settings.static interface
Defines demodulation settings.static interface
Defines an equivalent isotropically radiated power (EIRP).static interface
Defines a bandwidth.static interface
Defines a frequency.static interface
Provides information about how AWS Ground Station should save downlink data to S3.static interface
Defines a spectrum.static interface
Provides information about how AWS Ground Station should track the satellite through the sky during a contact.static interface
Provides information about how AWS Ground Station should echo back uplink transmissions to a dataflow endpoint.static interface
Defines a uplink spectrum.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
Nested classes/interfaces inherited from interface software.amazon.awscdk.ITaggable
ITaggable.Jsii$Default, ITaggable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionprotected
CfnConfig
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnConfig
(software.amazon.jsii.JsiiObjectRef objRef) CfnConfig
(software.constructs.Construct scope, String id, CfnConfigProps props) -
Method Summary
Modifier and TypeMethodDescriptionThe ARN of the config, such asarn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296
.The ID of the config, such as9940bf3b-d2ba-427e-9906-842b5e5d2296
.The type of the config, such astracking
.Object containing the parameters of a config.getName()
The name of the config object.getTags()
Tag Manager which manages the tags for this resource.Tags assigned to a resource.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
setConfigData
(IResolvable value) Object containing the parameters of a config.void
Object containing the parameters of a config.void
The name of the config object.void
setTagsRaw
(List<CfnTag> value) Tags assigned to a resource.Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependency, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, obtainDependencies, obtainResourceDependencies, removeDependency, replaceDependency, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.constructs.Construct
getNode, isConstruct
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnConfig
protected CfnConfig(software.amazon.jsii.JsiiObjectRef objRef) -
CfnConfig
protected CfnConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnConfig
@Stability(Stable) public CfnConfig(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnConfigProps props) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.props
- Resource properties. This parameter is required.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
- tree inspector to collect and process attributes. This parameter is required.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The ARN of the config, such asarn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296
. -
getAttrId
The ID of the config, such as9940bf3b-d2ba-427e-9906-842b5e5d2296
. -
getAttrType
The type of the config, such astracking
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getTags
Tag Manager which manages the tags for this resource. -
getConfigData
Object containing the parameters of a config. -
setConfigData
Object containing the parameters of a config. -
setConfigData
Object containing the parameters of a config. -
getName
The name of the config object. -
setName
The name of the config object. -
getTagsRaw
Tags assigned to a resource. -
setTagsRaw
Tags assigned to a resource.
-