Package software.amazon.awscdk.services.groundstation

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.98.0 (build 00b106d)",
           date="2024-05-08T21:35:08.015Z")
@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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html

Nested Class Summary

Nested Classes

Modifier and Type	Class	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 final 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.

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

Fields

Modifier and Type	Field	Description
static final String	CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	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 Type	Method	Description
String	getAttrArn()	The ARN of the config, such as arn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296 .
String	getAttrId()	The ID of the config, such as 9940bf3b-d2ba-427e-9906-842b5e5d2296 .
String	getAttrType()	The type of the config, such as tracking .
protected Map<String,Object>	getCfnProperties()
Object	getConfigData()	Object containing the parameters of a config.
String	getName()	The name of the config object.
TagManager	getTags()	Tag Manager which manages the tags for this resource.
List<CfnTag>	getTagsRaw()	Tags assigned to a resource.
void	inspect(TreeInspector inspector)	Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setConfigData(IResolvable value)	Object containing the parameters of a config.
void	setConfigData(CfnConfig.ConfigDataProperty value)	Object containing the parameters of a config.
void	setName(String value)	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

@Stability(Stable)
public static final String 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

@Stability(Stable)
public void inspect(@NotNull
 TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

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 class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(Stable)
@NotNull
public String getAttrArn()

The ARN of the config, such as arn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296 .

getAttrId

@Stability(Stable)
@NotNull
public String getAttrId()

The ID of the config, such as 9940bf3b-d2ba-427e-9906-842b5e5d2296 .

getAttrType

@Stability(Stable)
@NotNull
public String getAttrType()

The type of the config, such as tracking .

getCfnProperties

@Stability(Stable)
@NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(Stable)
@NotNull
public TagManager getTags()

Tag Manager which manages the tags for this resource.

Specified by:

getTags in interface ITaggable

getConfigData

@Stability(Stable)
@NotNull
public Object getConfigData()

Object containing the parameters of a config.

setConfigData

@Stability(Stable)
public void setConfigData(@NotNull
 IResolvable value)

Object containing the parameters of a config.

setConfigData

@Stability(Stable)
public void setConfigData(@NotNull
 CfnConfig.ConfigDataProperty value)

Object containing the parameters of a config.

getName

@Stability(Stable)
@NotNull
public String getName()

The name of the config object.

setName

@Stability(Stable)
public void setName(@NotNull
 String value)

The name of the config object.

getTagsRaw

@Stability(Stable)
@Nullable
public List<CfnTag> getTagsRaw()

Tags assigned to a resource.

setTagsRaw

@Stability(Stable)
public void setTagsRaw(@Nullable
 List<CfnTag> value)

Tags assigned to a resource.