CfnConfig

class aws_cdk.aws_groundstation.CfnConfig(scope, id, *, config_data, name, tags=None)

Bases: CfnResource

Creates a Config with the specified parameters.

Config objects provide Ground Station with the details necessary in order to schedule and execute satellite contacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html
CloudformationResource:: AWS::GroundStation::Config
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

cfn_config = groundstation.CfnConfig(self, "MyCfnConfig",
    config_data=groundstation.CfnConfig.ConfigDataProperty(
        antenna_downlink_config=groundstation.CfnConfig.AntennaDownlinkConfigProperty(
            spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
                bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
                    units="units",
                    value=123
                ),
                center_frequency=groundstation.CfnConfig.FrequencyProperty(
                    units="units",
                    value=123
                ),
                polarization="polarization"
            )
        ),
        antenna_downlink_demod_decode_config=groundstation.CfnConfig.AntennaDownlinkDemodDecodeConfigProperty(
            decode_config=groundstation.CfnConfig.DecodeConfigProperty(
                unvalidated_json="unvalidatedJson"
            ),
            demodulation_config=groundstation.CfnConfig.DemodulationConfigProperty(
                unvalidated_json="unvalidatedJson"
            ),
            spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
                bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
                    units="units",
                    value=123
                ),
                center_frequency=groundstation.CfnConfig.FrequencyProperty(
                    units="units",
                    value=123
                ),
                polarization="polarization"
            )
        ),
        antenna_uplink_config=groundstation.CfnConfig.AntennaUplinkConfigProperty(
            spectrum_config=groundstation.CfnConfig.UplinkSpectrumConfigProperty(
                center_frequency=groundstation.CfnConfig.FrequencyProperty(
                    units="units",
                    value=123
                ),
                polarization="polarization"
            ),
            target_eirp=groundstation.CfnConfig.EirpProperty(
                units="units",
                value=123
            ),
            transmit_disabled=False
        ),
        dataflow_endpoint_config=groundstation.CfnConfig.DataflowEndpointConfigProperty(
            dataflow_endpoint_name="dataflowEndpointName",
            dataflow_endpoint_region="dataflowEndpointRegion"
        ),
        s3_recording_config=groundstation.CfnConfig.S3RecordingConfigProperty(
            bucket_arn="bucketArn",
            prefix="prefix",
            role_arn="roleArn"
        ),
        tracking_config=groundstation.CfnConfig.TrackingConfigProperty(
            autotrack="autotrack"
        ),
        uplink_echo_config=groundstation.CfnConfig.UplinkEchoConfigProperty(
            antenna_uplink_config_arn="antennaUplinkConfigArn",
            enabled=False
        )
    ),
    name="name",

    # the properties below are optional
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
config_data (Union[IResolvable, ConfigDataProperty, Dict[str, Any]]) – 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.
name (str) – The name of the config object.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags assigned to a resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

Parameters:: path (str) – The path of the value to delete.
Return type:: None

add_dependency(target)

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

(deprecated) Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use addPropertyOverride or prefix path with “Properties.” (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example:

cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides Example:

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to addOverride will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

path (str) –
- The path of the property, you can use dot notation to override values in complex types. Any intermediate keys will be created as needed.
value (Any) –
- The value. Could be primitive or complex.

Return type:

None

add_property_deletion_override(property_path)

Adds an override that deletes the value of a property from the resource definition.

Parameters:: property_path (str) – The path to the property.
Return type:: None

add_property_override(property_path, value)

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

property_path (str) – The path of the property.
value (Any) – The value.

Return type:

None

apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)

Sets the deletion policy of the resource based on the removal policy specified.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you’ve removed it from the CDK application or because you’ve made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:

Parameters:

policy (Optional[RemovalPolicy]) –
apply_to_update_replace_policy (Optional[bool]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: true
default (Optional[RemovalPolicy]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resource, please consult that specific resource’s documentation.

See:

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

attribute_name (str) – The name of the attribute.
type_hint (Optional[ResolutionTypeHint]) –

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html

Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

Parameters:: inspector (TreeInspector) – tree inspector to collect and process attributes.
Return type:: None

obtain_dependencies()

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Return type:: List[Union[Stack, CfnResource]]

obtain_resource_dependencies()

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

Overrides the auto-generated logical ID with a specific ID.

Parameters:: new_logical_id (str) – The new logical ID to use for this stack element.
Return type:: None

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

target (CfnResource) – The dependency to replace.
new_target (CfnResource) – The new dependency to add.

Return type:

None

to_string()

Returns a string representation of this construct.

Return type:: str
Returns:: a string representation of this resource

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::GroundStation::Config'

attr_arn

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

CloudformationAttribute:: Arn

attr_id

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

CloudformationAttribute:: Id

attr_type

The type of the config, such as tracking .

CloudformationAttribute:: Type

cfn_options: Options for this resource, such as condition, update policy etc.

cfn_resource_type: AWS resource type.

config_data: Object containing the parameters of a config.

creation_stack

return:

the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.

logical_id

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use overrideLogicalId(newLogicalId).

Returns:

the logical ID as a stringified token. This value will only get resolved during synthesis.

name: The name of the config object.

node: The tree node.

ref

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

tags: Tag Manager which manages the tags for this resource.

tags_raw: Tags assigned to a resource.

Static Methods

classmethod is_cfn_element(x)

Returns true if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of instanceof to allow stack elements from different versions of this library to be included in the same stack.

Parameters:

x (Any) –

Return type:

bool

Returns:

The construct as a stack element or undefined if it is not a stack element.

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

Use this method instead of instanceof to properly detect Construct instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the constructs library on disk are seen as independent, completely different libraries. As a consequence, the class Construct in each copy of the constructs library is seen as a different class, and an instance of one class will not test as instanceof the other class. npm install will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the constructs library can be accidentally installed, and instanceof will behave unpredictably. It is safest to avoid using instanceof, and using this type-testing method instead.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Construct.

AntennaDownlinkConfigProperty

class CfnConfig.AntennaDownlinkConfigProperty(*, spectrum_config=None)

Bases: object

Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.

Use an antenna downlink config in a mission profile to receive the downlink data in raw DigIF format.

Parameters:: spectrum_config (Union[IResolvable, SpectrumConfigProperty, Dict[str, Any], None]) – Defines the spectrum configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

antenna_downlink_config_property = groundstation.CfnConfig.AntennaDownlinkConfigProperty(
    spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
        bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
            units="units",
            value=123
        ),
        center_frequency=groundstation.CfnConfig.FrequencyProperty(
            units="units",
            value=123
        ),
        polarization="polarization"
    )
)

Attributes

spectrum_config

Defines the spectrum configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkconfig.html#cfn-groundstation-config-antennadownlinkconfig-spectrumconfig

AntennaDownlinkDemodDecodeConfigProperty

class CfnConfig.AntennaDownlinkDemodDecodeConfigProperty(*, decode_config=None, demodulation_config=None, spectrum_config=None)

Bases: object

Provides information about how AWS Ground Station should configure an antenna for downlink during a contact.

Use an antenna downlink demod decode config in a mission profile to receive the downlink data that has been demodulated and decoded.

Parameters:

decode_config (Union[IResolvable, DecodeConfigProperty, Dict[str, Any], None]) – Defines how the RF signal will be decoded.
demodulation_config (Union[IResolvable, DemodulationConfigProperty, Dict[str, Any], None]) – Defines how the RF signal will be demodulated.
spectrum_config (Union[IResolvable, SpectrumConfigProperty, Dict[str, Any], None]) – Defines the spectrum configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

antenna_downlink_demod_decode_config_property = groundstation.CfnConfig.AntennaDownlinkDemodDecodeConfigProperty(
    decode_config=groundstation.CfnConfig.DecodeConfigProperty(
        unvalidated_json="unvalidatedJson"
    ),
    demodulation_config=groundstation.CfnConfig.DemodulationConfigProperty(
        unvalidated_json="unvalidatedJson"
    ),
    spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
        bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
            units="units",
            value=123
        ),
        center_frequency=groundstation.CfnConfig.FrequencyProperty(
            units="units",
            value=123
        ),
        polarization="polarization"
    )
)

Attributes

decode_config

Defines how the RF signal will be decoded.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-decodeconfig

demodulation_config

Defines how the RF signal will be demodulated.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-demodulationconfig

spectrum_config

Defines the spectrum configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-spectrumconfig

AntennaUplinkConfigProperty

class CfnConfig.AntennaUplinkConfigProperty(*, spectrum_config=None, target_eirp=None, transmit_disabled=None)

Bases: object

Provides information about how AWS Ground Station should configure an antenna for uplink during a contact.

Parameters:

spectrum_config (Union[IResolvable, UplinkSpectrumConfigProperty, Dict[str, Any], None]) – Defines the spectrum configuration.
target_eirp (Union[IResolvable, EirpProperty, Dict[str, Any], None]) – The equivalent isotropically radiated power (EIRP) to use for uplink transmissions. Valid values are between 20.0 to 50.0 dBW.
transmit_disabled (Union[bool, IResolvable, None]) – Whether or not uplink transmit is disabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

antenna_uplink_config_property = groundstation.CfnConfig.AntennaUplinkConfigProperty(
    spectrum_config=groundstation.CfnConfig.UplinkSpectrumConfigProperty(
        center_frequency=groundstation.CfnConfig.FrequencyProperty(
            units="units",
            value=123
        ),
        polarization="polarization"
    ),
    target_eirp=groundstation.CfnConfig.EirpProperty(
        units="units",
        value=123
    ),
    transmit_disabled=False
)

Attributes

spectrum_config

Defines the spectrum configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-spectrumconfig

target_eirp

The equivalent isotropically radiated power (EIRP) to use for uplink transmissions.

Valid values are between 20.0 to 50.0 dBW.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-targeteirp

transmit_disabled

Whether or not uplink transmit is disabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-transmitdisabled

ConfigDataProperty

class CfnConfig.ConfigDataProperty(*, antenna_downlink_config=None, antenna_downlink_demod_decode_config=None, antenna_uplink_config=None, dataflow_endpoint_config=None, s3_recording_config=None, tracking_config=None, uplink_echo_config=None)

Bases: object

Config objects provide information to Ground Station about how to configure the antenna and how data flows during a contact.

Parameters:

antenna_downlink_config (Union[IResolvable, AntennaDownlinkConfigProperty, Dict[str, Any], None]) – Provides information for an antenna downlink config object. Antenna downlink config objects are used to provide parameters for downlinks where no demodulation or decoding is performed by Ground Station (RF over IP downlinks).
antenna_downlink_demod_decode_config (Union[IResolvable, AntennaDownlinkDemodDecodeConfigProperty, Dict[str, Any], None]) – Provides information for a downlink demod decode config object. Downlink demod decode config objects are used to provide parameters for downlinks where the Ground Station service will demodulate and decode the downlinked data.
antenna_uplink_config (Union[IResolvable, AntennaUplinkConfigProperty, Dict[str, Any], None]) – Provides information for an uplink config object. Uplink config objects are used to provide parameters for uplink contacts.
dataflow_endpoint_config (Union[IResolvable, DataflowEndpointConfigProperty, Dict[str, Any], None]) – Provides information for a dataflow endpoint config object. Dataflow endpoint config objects are used to provide parameters about which IP endpoint(s) to use during a contact. Dataflow endpoints are where Ground Station sends data during a downlink contact and where Ground Station receives data to send to the satellite during an uplink contact.
s3_recording_config (Union[IResolvable, S3RecordingConfigProperty, Dict[str, Any], None]) – Provides information for an S3 recording config object. S3 recording config objects are used to provide parameters for S3 recording during downlink contacts.
tracking_config (Union[IResolvable, TrackingConfigProperty, Dict[str, Any], None]) – Provides information for a tracking config object. Tracking config objects are used to provide parameters about how to track the satellite through the sky during a contact.
uplink_echo_config (Union[IResolvable, UplinkEchoConfigProperty, Dict[str, Any], None]) – Provides information for an uplink echo config object. Uplink echo config objects are used to provide parameters for uplink echo during uplink contacts.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

config_data_property = groundstation.CfnConfig.ConfigDataProperty(
    antenna_downlink_config=groundstation.CfnConfig.AntennaDownlinkConfigProperty(
        spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
            bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
                units="units",
                value=123
            ),
            center_frequency=groundstation.CfnConfig.FrequencyProperty(
                units="units",
                value=123
            ),
            polarization="polarization"
        )
    ),
    antenna_downlink_demod_decode_config=groundstation.CfnConfig.AntennaDownlinkDemodDecodeConfigProperty(
        decode_config=groundstation.CfnConfig.DecodeConfigProperty(
            unvalidated_json="unvalidatedJson"
        ),
        demodulation_config=groundstation.CfnConfig.DemodulationConfigProperty(
            unvalidated_json="unvalidatedJson"
        ),
        spectrum_config=groundstation.CfnConfig.SpectrumConfigProperty(
            bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
                units="units",
                value=123
            ),
            center_frequency=groundstation.CfnConfig.FrequencyProperty(
                units="units",
                value=123
            ),
            polarization="polarization"
        )
    ),
    antenna_uplink_config=groundstation.CfnConfig.AntennaUplinkConfigProperty(
        spectrum_config=groundstation.CfnConfig.UplinkSpectrumConfigProperty(
            center_frequency=groundstation.CfnConfig.FrequencyProperty(
                units="units",
                value=123
            ),
            polarization="polarization"
        ),
        target_eirp=groundstation.CfnConfig.EirpProperty(
            units="units",
            value=123
        ),
        transmit_disabled=False
    ),
    dataflow_endpoint_config=groundstation.CfnConfig.DataflowEndpointConfigProperty(
        dataflow_endpoint_name="dataflowEndpointName",
        dataflow_endpoint_region="dataflowEndpointRegion"
    ),
    s3_recording_config=groundstation.CfnConfig.S3RecordingConfigProperty(
        bucket_arn="bucketArn",
        prefix="prefix",
        role_arn="roleArn"
    ),
    tracking_config=groundstation.CfnConfig.TrackingConfigProperty(
        autotrack="autotrack"
    ),
    uplink_echo_config=groundstation.CfnConfig.UplinkEchoConfigProperty(
        antenna_uplink_config_arn="antennaUplinkConfigArn",
        enabled=False
    )
)

Attributes

antenna_downlink_config

Provides information for an antenna downlink config object.

Antenna downlink config objects are used to provide parameters for downlinks where no demodulation or decoding is performed by Ground Station (RF over IP downlinks).

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennadownlinkconfig

antenna_downlink_demod_decode_config

Provides information for a downlink demod decode config object.

Downlink demod decode config objects are used to provide parameters for downlinks where the Ground Station service will demodulate and decode the downlinked data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennadownlinkdemoddecodeconfig

antenna_uplink_config

Provides information for an uplink config object.

Uplink config objects are used to provide parameters for uplink contacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-antennauplinkconfig

dataflow_endpoint_config

Provides information for a dataflow endpoint config object.

Dataflow endpoint config objects are used to provide parameters about which IP endpoint(s) to use during a contact. Dataflow endpoints are where Ground Station sends data during a downlink contact and where Ground Station receives data to send to the satellite during an uplink contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-dataflowendpointconfig

s3_recording_config

Provides information for an S3 recording config object.

S3 recording config objects are used to provide parameters for S3 recording during downlink contacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-s3recordingconfig

tracking_config

Provides information for a tracking config object.

Tracking config objects are used to provide parameters about how to track the satellite through the sky during a contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-trackingconfig

uplink_echo_config

Provides information for an uplink echo config object.

Uplink echo config objects are used to provide parameters for uplink echo during uplink contacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-configdata.html#cfn-groundstation-config-configdata-uplinkechoconfig

DataflowEndpointConfigProperty

class CfnConfig.DataflowEndpointConfigProperty(*, dataflow_endpoint_name=None, dataflow_endpoint_region=None)

Bases: object

Provides information to AWS Ground Station about which IP endpoints to use during a contact.

Parameters:

dataflow_endpoint_name (Optional[str]) – The name of the dataflow endpoint to use during contacts.
dataflow_endpoint_region (Optional[str]) – The region of the dataflow endpoint to use during contacts. When omitted, Ground Station will use the region of the contact.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

dataflow_endpoint_config_property = groundstation.CfnConfig.DataflowEndpointConfigProperty(
    dataflow_endpoint_name="dataflowEndpointName",
    dataflow_endpoint_region="dataflowEndpointRegion"
)

Attributes

dataflow_endpoint_name

The name of the dataflow endpoint to use during contacts.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html#cfn-groundstation-config-dataflowendpointconfig-dataflowendpointname

dataflow_endpoint_region

The region of the dataflow endpoint to use during contacts.

When omitted, Ground Station will use the region of the contact.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-dataflowendpointconfig.html#cfn-groundstation-config-dataflowendpointconfig-dataflowendpointregion

DecodeConfigProperty

class CfnConfig.DecodeConfigProperty(*, unvalidated_json=None)

Bases: object

Defines decoding settings.

Parameters:: unvalidated_json (Optional[str]) – The decoding settings are in JSON format and define a set of steps to perform to decode the data.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-decodeconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

decode_config_property = groundstation.CfnConfig.DecodeConfigProperty(
    unvalidated_json="unvalidatedJson"
)

Attributes

unvalidated_json

The decoding settings are in JSON format and define a set of steps to perform to decode the data.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-decodeconfig.html#cfn-groundstation-config-decodeconfig-unvalidatedjson

DemodulationConfigProperty

class CfnConfig.DemodulationConfigProperty(*, unvalidated_json=None)

Bases: object

Defines demodulation settings.

Parameters:: unvalidated_json (Optional[str]) – The demodulation settings are in JSON format and define parameters for demodulation, for example which modulation scheme (e.g. PSK, QPSK, etc.) and matched filter to use.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-demodulationconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

demodulation_config_property = groundstation.CfnConfig.DemodulationConfigProperty(
    unvalidated_json="unvalidatedJson"
)

Attributes

unvalidated_json

The demodulation settings are in JSON format and define parameters for demodulation, for example which modulation scheme (e.g. PSK, QPSK, etc.) and matched filter to use.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-demodulationconfig.html#cfn-groundstation-config-demodulationconfig-unvalidatedjson

EirpProperty

class CfnConfig.EirpProperty(*, units=None, value=None)

Bases: object

Defines an equivalent isotropically radiated power (EIRP).

Parameters:

units (Optional[str]) – The units of the EIRP.
value (Union[int, float, None]) – The value of the EIRP. Valid values are between 20.0 to 50.0 dBW.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

eirp_property = groundstation.CfnConfig.EirpProperty(
    units="units",
    value=123
)

Attributes

units

The units of the EIRP.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html#cfn-groundstation-config-eirp-units

value

The value of the EIRP.

Valid values are between 20.0 to 50.0 dBW.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-eirp.html#cfn-groundstation-config-eirp-value

FrequencyBandwidthProperty

class CfnConfig.FrequencyBandwidthProperty(*, units=None, value=None)

Bases: object

Defines a bandwidth.

Parameters:

units (Optional[str]) – The units of the bandwidth.
value (Union[int, float, None]) – The value of the bandwidth. AWS Ground Station currently has the following bandwidth limitations:. - For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz. - For AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz. - For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

frequency_bandwidth_property = groundstation.CfnConfig.FrequencyBandwidthProperty(
    units="units",
    value=123
)

Attributes

units

The units of the bandwidth.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html#cfn-groundstation-config-frequencybandwidth-units

value

.

For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequencybandwidth.html#cfn-groundstation-config-frequencybandwidth-value
Type:: The value of the bandwidth. AWS Ground Station currently has the following bandwidth limitations

FrequencyProperty

class CfnConfig.FrequencyProperty(*, units=None, value=None)

Bases: object

Defines a frequency.

Parameters:

units (Optional[str]) – The units of the frequency.
value (Union[int, float, None]) – The value of the frequency. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

frequency_property = groundstation.CfnConfig.FrequencyProperty(
    units="units",
    value=123
)

Attributes

units

The units of the frequency.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html#cfn-groundstation-config-frequency-units

value

The value of the frequency.

Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-frequency.html#cfn-groundstation-config-frequency-value

S3RecordingConfigProperty

class CfnConfig.S3RecordingConfigProperty(*, bucket_arn=None, prefix=None, role_arn=None)

Bases: object

Provides information about how AWS Ground Station should save downlink data to S3.

Parameters:

bucket_arn (Optional[str]) – S3 Bucket where the data is written. The name of the S3 Bucket provided must begin with aws-groundstation .
prefix (Optional[str]) – The prefix of the S3 data object. If you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details. For example, a prefix of {satellite_id}/{year}/{month}/{day}/ will replaced with fake_satellite_id/2021/01/10/ Optional keys for substitution : {satellite_id} | {config-name} | {config-id} | {year} | {month} | {day}
role_arn (Optional[str]) – Defines the ARN of the role assumed for putting archives to S3.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

s3_recording_config_property = groundstation.CfnConfig.S3RecordingConfigProperty(
    bucket_arn="bucketArn",
    prefix="prefix",
    role_arn="roleArn"
)

Attributes

bucket_arn

S3 Bucket where the data is written.

The name of the S3 Bucket provided must begin with aws-groundstation .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-bucketarn

prefix

The prefix of the S3 data object.

If you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details. For example, a prefix of {satellite_id}/{year}/{month}/{day}/ will replaced with fake_satellite_id/2021/01/10/

Optional keys for substitution : {satellite_id} | {config-name} | {config-id} | {year} | {month} | {day}

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-prefix

role_arn

Defines the ARN of the role assumed for putting archives to S3.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-s3recordingconfig.html#cfn-groundstation-config-s3recordingconfig-rolearn

SpectrumConfigProperty

class CfnConfig.SpectrumConfigProperty(*, bandwidth=None, center_frequency=None, polarization=None)

Bases: object

Defines a spectrum.

Parameters:

bandwidth (Union[IResolvable, FrequencyBandwidthProperty, Dict[str, Any], None]) – The bandwidth of the spectrum. AWS Ground Station currently has the following bandwidth limitations:. - For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz. - For AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz. - For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.
center_frequency (Union[IResolvable, FrequencyProperty, Dict[str, Any], None]) – The center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization (Optional[str]) – The polarization of the spectrum. Valid values are "RIGHT_HAND" and "LEFT_HAND" . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

spectrum_config_property = groundstation.CfnConfig.SpectrumConfigProperty(
    bandwidth=groundstation.CfnConfig.FrequencyBandwidthProperty(
        units="units",
        value=123
    ),
    center_frequency=groundstation.CfnConfig.FrequencyProperty(
        units="units",
        value=123
    ),
    polarization="polarization"
)

Attributes

bandwidth

.

For AntennaDownlinkDemodDecodeconfig , valid values are between 125 kHz to 650 MHz.
For AntennaDownlinkconfig , valid values are between 10 kHz to 54 MHz.
For AntennaUplinkConfig , valid values are between 10 kHz to 54 MHz.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-bandwidth
Type:: The bandwidth of the spectrum. AWS Ground Station currently has the following bandwidth limitations

center_frequency

The center frequency of the spectrum.

Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-centerfrequency

polarization

The polarization of the spectrum.

Valid values are "RIGHT_HAND" and "LEFT_HAND" . Capturing both "RIGHT_HAND" and "LEFT_HAND" polarization requires two separate configs.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-polarization

TrackingConfigProperty

class CfnConfig.TrackingConfigProperty(*, autotrack=None)

Bases: object

Provides information about how AWS Ground Station should track the satellite through the sky during a contact.

Parameters:: autotrack (Optional[str]) – Specifies whether or not to use autotrack. REMOVED specifies that program track should only be used during the contact. PREFERRED specifies that autotracking is preferred during the contact but fallback to program track if the signal is lost. REQUIRED specifies that autotracking is required during the contact and not to use program track if the signal is lost.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-trackingconfig.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

tracking_config_property = groundstation.CfnConfig.TrackingConfigProperty(
    autotrack="autotrack"
)

Attributes

autotrack

Specifies whether or not to use autotrack.

REMOVED specifies that program track should only be used during the contact. PREFERRED specifies that autotracking is preferred during the contact but fallback to program track if the signal is lost. REQUIRED specifies that autotracking is required during the contact and not to use program track if the signal is lost.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-trackingconfig.html#cfn-groundstation-config-trackingconfig-autotrack

UplinkEchoConfigProperty

class CfnConfig.UplinkEchoConfigProperty(*, antenna_uplink_config_arn=None, enabled=None)

Bases: object

Provides information about how AWS Ground Station should echo back uplink transmissions to a dataflow endpoint.

Parameters:

antenna_uplink_config_arn (Optional[str]) – Defines the ARN of the uplink config to echo back to a dataflow endpoint.
enabled (Union[bool, IResolvable, None]) – Whether or not uplink echo is enabled.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

uplink_echo_config_property = groundstation.CfnConfig.UplinkEchoConfigProperty(
    antenna_uplink_config_arn="antennaUplinkConfigArn",
    enabled=False
)

Attributes

antenna_uplink_config_arn

Defines the ARN of the uplink config to echo back to a dataflow endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html#cfn-groundstation-config-uplinkechoconfig-antennauplinkconfigarn

enabled

Whether or not uplink echo is enabled.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkechoconfig.html#cfn-groundstation-config-uplinkechoconfig-enabled

UplinkSpectrumConfigProperty

class CfnConfig.UplinkSpectrumConfigProperty(*, center_frequency=None, polarization=None)

Bases: object

Defines a uplink spectrum.

Parameters:

center_frequency (Union[IResolvable, FrequencyProperty, Dict[str, Any], None]) – The center frequency of the spectrum. Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.
polarization (Optional[str]) – The polarization of the spectrum. Valid values are "RIGHT_HAND" and "LEFT_HAND" .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_groundstation as groundstation

uplink_spectrum_config_property = groundstation.CfnConfig.UplinkSpectrumConfigProperty(
    center_frequency=groundstation.CfnConfig.FrequencyProperty(
        units="units",
        value=123
    ),
    polarization="polarization"
)

Attributes

center_frequency

The center frequency of the spectrum.

Valid values are between 2200 to 2300 MHz and 7750 to 8400 MHz for downlink and 2025 to 2120 MHz for uplink.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html#cfn-groundstation-config-uplinkspectrumconfig-centerfrequency

polarization

The polarization of the spectrum.

Valid values are "RIGHT_HAND" and "LEFT_HAND" .

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-uplinkspectrumconfig.html#cfn-groundstation-config-uplinkspectrumconfig-polarization