Package software.amazon.awscdk.services.groundstation

Class CfnConfig

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.groundstation.CfnConfig
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:57.120Z") @Stability(Stable) public class CfnConfig extends CfnResource implements IInspectable
A CloudFormation AWS::GroundStation::Config.

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();

  • 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 Construct scope, @NotNull String id, @NotNull CfnConfigProps props)
      Create a new AWS::GroundStation::Config.

      Parameters:
      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.

  • 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()
      Tags assigned to a resource.

    • getConfigData

      @Stability(Stable) @NotNull public Object getConfigData()
      Object containing the parameters of a config.

      Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.

    • setConfigData

      @Stability(Stable) public void setConfigData(@NotNull CfnConfig.ConfigDataProperty value)
      Object containing the parameters of a config.

      Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.

    • setConfigData

      @Stability(Stable) public void setConfigData(@NotNull IResolvable value)
      Object containing the parameters of a config.

      Only one subtype may be specified per config. See the subtype definitions for a description of each config subtype.

    • 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.