Documentation ¶
Index ¶
- func CfnConfig_CFN_RESOURCE_TYPE_NAME() *string
- func CfnConfig_IsCfnElement(x interface{}) *bool
- func CfnConfig_IsCfnResource(x interface{}) *bool
- func CfnConfig_IsConstruct(x interface{}) *bool
- func CfnDataflowEndpointGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnDataflowEndpointGroup_IsCfnElement(x interface{}) *bool
- func CfnDataflowEndpointGroup_IsCfnResource(x interface{}) *bool
- func CfnDataflowEndpointGroup_IsConstruct(x interface{}) *bool
- func CfnMissionProfile_CFN_RESOURCE_TYPE_NAME() *string
- func CfnMissionProfile_IsCfnElement(x interface{}) *bool
- func CfnMissionProfile_IsCfnResource(x interface{}) *bool
- func CfnMissionProfile_IsConstruct(x interface{}) *bool
- func NewCfnConfig_Override(c CfnConfig, scope constructs.Construct, id *string, props *CfnConfigProps)
- func NewCfnDataflowEndpointGroup_Override(c CfnDataflowEndpointGroup, scope constructs.Construct, id *string, ...)
- func NewCfnMissionProfile_Override(c CfnMissionProfile, scope constructs.Construct, id *string, ...)
- type CfnConfig
- type CfnConfigProps
- type CfnConfig_AntennaDownlinkConfigProperty
- type CfnConfig_AntennaDownlinkDemodDecodeConfigProperty
- type CfnConfig_AntennaUplinkConfigProperty
- type CfnConfig_ConfigDataProperty
- type CfnConfig_DataflowEndpointConfigProperty
- type CfnConfig_DecodeConfigProperty
- type CfnConfig_DemodulationConfigProperty
- type CfnConfig_EirpProperty
- type CfnConfig_FrequencyBandwidthProperty
- type CfnConfig_FrequencyProperty
- type CfnConfig_S3RecordingConfigProperty
- type CfnConfig_SpectrumConfigProperty
- type CfnConfig_TrackingConfigProperty
- type CfnConfig_UplinkEchoConfigProperty
- type CfnConfig_UplinkSpectrumConfigProperty
- type CfnDataflowEndpointGroup
- type CfnDataflowEndpointGroupProps
- type CfnDataflowEndpointGroup_AwsGroundStationAgentEndpointProperty
- type CfnDataflowEndpointGroup_ConnectionDetailsProperty
- type CfnDataflowEndpointGroup_DataflowEndpointProperty
- type CfnDataflowEndpointGroup_EndpointDetailsProperty
- type CfnDataflowEndpointGroup_IntegerRangeProperty
- type CfnDataflowEndpointGroup_RangedConnectionDetailsProperty
- type CfnDataflowEndpointGroup_RangedSocketAddressProperty
- type CfnDataflowEndpointGroup_SecurityDetailsProperty
- type CfnDataflowEndpointGroup_SocketAddressProperty
- type CfnMissionProfile
- type CfnMissionProfileProps
- type CfnMissionProfile_DataflowEdgeProperty
- type CfnMissionProfile_StreamsKmsKeyProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnConfig_CFN_RESOURCE_TYPE_NAME ¶
func CfnConfig_CFN_RESOURCE_TYPE_NAME() *string
func CfnConfig_IsCfnElement ¶
func CfnConfig_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnConfig_IsCfnResource ¶
func CfnConfig_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnConfig_IsConstruct ¶
func CfnConfig_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnDataflowEndpointGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnDataflowEndpointGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnDataflowEndpointGroup_IsCfnElement ¶
func CfnDataflowEndpointGroup_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnDataflowEndpointGroup_IsCfnResource ¶
func CfnDataflowEndpointGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnDataflowEndpointGroup_IsConstruct ¶
func CfnDataflowEndpointGroup_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnMissionProfile_CFN_RESOURCE_TYPE_NAME ¶
func CfnMissionProfile_CFN_RESOURCE_TYPE_NAME() *string
func CfnMissionProfile_IsCfnElement ¶
func CfnMissionProfile_IsCfnElement(x interface{}) *bool
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.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnMissionProfile_IsCfnResource ¶
func CfnMissionProfile_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnMissionProfile_IsConstruct ¶
func CfnMissionProfile_IsConstruct(x interface{}) *bool
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.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnConfig_Override ¶
func NewCfnConfig_Override(c CfnConfig, scope constructs.Construct, id *string, props *CfnConfigProps)
func NewCfnDataflowEndpointGroup_Override ¶
func NewCfnDataflowEndpointGroup_Override(c CfnDataflowEndpointGroup, scope constructs.Construct, id *string, props *CfnDataflowEndpointGroupProps)
func NewCfnMissionProfile_Override ¶
func NewCfnMissionProfile_Override(c CfnMissionProfile, scope constructs.Construct, id *string, props *CfnMissionProfileProps)
Types ¶
type CfnConfig ¶
type CfnConfig interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the config, such as `arn:aws:groundstation:us-east-2:1234567890:config/tracking/9940bf3b-d2ba-427e-9906-842b5e5d2296` . AttrArn() *string // The ID of the config, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` . AttrId() *string // The type of the config, such as `tracking` . AttrType() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Object containing the parameters of a config. ConfigData() interface{} SetConfigData(val interface{}) // Returns: 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. CreationStack() *[]*string // 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. LogicalId() *string // The name of the config object. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags assigned to a resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 "github.com/aws/aws-cdk-go/awscdk" cfnConfig := awscdk.Aws_groundstation.NewCfnConfig(this, jsii.String("MyCfnConfig"), &CfnConfigProps{ ConfigData: &ConfigDataProperty{ AntennaDownlinkConfig: &AntennaDownlinkConfigProperty{ SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaDownlinkDemodDecodeConfig: &AntennaDownlinkDemodDecodeConfigProperty{ DecodeConfig: &DecodeConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, DemodulationConfig: &DemodulationConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaUplinkConfig: &AntennaUplinkConfigProperty{ SpectrumConfig: &UplinkSpectrumConfigProperty{ CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, TargetEirp: &EirpProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, TransmitDisabled: jsii.Boolean(false), }, DataflowEndpointConfig: &DataflowEndpointConfigProperty{ DataflowEndpointName: jsii.String("dataflowEndpointName"), DataflowEndpointRegion: jsii.String("dataflowEndpointRegion"), }, S3RecordingConfig: &S3RecordingConfigProperty{ BucketArn: jsii.String("bucketArn"), Prefix: jsii.String("prefix"), RoleArn: jsii.String("roleArn"), }, TrackingConfig: &TrackingConfigProperty{ Autotrack: jsii.String("autotrack"), }, UplinkEchoConfig: &UplinkEchoConfigProperty{ AntennaUplinkConfigArn: jsii.String("antennaUplinkConfigArn"), Enabled: jsii.Boolean(false), }, }, Name: jsii.String("name"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html
func NewCfnConfig ¶
func NewCfnConfig(scope constructs.Construct, id *string, props *CfnConfigProps) CfnConfig
type CfnConfigProps ¶
type CfnConfigProps struct { // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-configdata // ConfigData interface{} `field:"required" json:"configData" yaml:"configData"` // The name of the config object. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-name // Name *string `field:"required" json:"name" yaml:"name"` // Tags assigned to a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html#cfn-groundstation-config-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnConfig`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnConfigProps := &CfnConfigProps{ ConfigData: &ConfigDataProperty{ AntennaDownlinkConfig: &AntennaDownlinkConfigProperty{ SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaDownlinkDemodDecodeConfig: &AntennaDownlinkDemodDecodeConfigProperty{ DecodeConfig: &DecodeConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, DemodulationConfig: &DemodulationConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaUplinkConfig: &AntennaUplinkConfigProperty{ SpectrumConfig: &UplinkSpectrumConfigProperty{ CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, TargetEirp: &EirpProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, TransmitDisabled: jsii.Boolean(false), }, DataflowEndpointConfig: &DataflowEndpointConfigProperty{ DataflowEndpointName: jsii.String("dataflowEndpointName"), DataflowEndpointRegion: jsii.String("dataflowEndpointRegion"), }, S3RecordingConfig: &S3RecordingConfigProperty{ BucketArn: jsii.String("bucketArn"), Prefix: jsii.String("prefix"), RoleArn: jsii.String("roleArn"), }, TrackingConfig: &TrackingConfigProperty{ Autotrack: jsii.String("autotrack"), }, UplinkEchoConfig: &UplinkEchoConfigProperty{ AntennaUplinkConfigArn: jsii.String("antennaUplinkConfigArn"), Enabled: jsii.Boolean(false), }, }, Name: jsii.String("name"), // the properties below are optional Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-config.html
type CfnConfig_AntennaDownlinkConfigProperty ¶
type CfnConfig_AntennaDownlinkConfigProperty struct { // Defines the spectrum configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkconfig.html#cfn-groundstation-config-antennadownlinkconfig-spectrumconfig // SpectrumConfig interface{} `field:"optional" json:"spectrumConfig" yaml:"spectrumConfig"` }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" antennaDownlinkConfigProperty := &AntennaDownlinkConfigProperty{ SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }
type CfnConfig_AntennaDownlinkDemodDecodeConfigProperty ¶
type CfnConfig_AntennaDownlinkDemodDecodeConfigProperty struct { // 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 // DecodeConfig interface{} `field:"optional" json:"decodeConfig" yaml:"decodeConfig"` // 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 // DemodulationConfig interface{} `field:"optional" json:"demodulationConfig" yaml:"demodulationConfig"` // Defines the spectrum configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennadownlinkdemoddecodeconfig.html#cfn-groundstation-config-antennadownlinkdemoddecodeconfig-spectrumconfig // SpectrumConfig interface{} `field:"optional" json:"spectrumConfig" yaml:"spectrumConfig"` }
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.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" antennaDownlinkDemodDecodeConfigProperty := &AntennaDownlinkDemodDecodeConfigProperty{ DecodeConfig: &DecodeConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, DemodulationConfig: &DemodulationConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }
type CfnConfig_AntennaUplinkConfigProperty ¶
type CfnConfig_AntennaUplinkConfigProperty struct { // Defines the spectrum configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-antennauplinkconfig.html#cfn-groundstation-config-antennauplinkconfig-spectrumconfig // SpectrumConfig interface{} `field:"optional" json:"spectrumConfig" yaml:"spectrumConfig"` // 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 // TargetEirp interface{} `field:"optional" json:"targetEirp" yaml:"targetEirp"` // 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 // TransmitDisabled interface{} `field:"optional" json:"transmitDisabled" yaml:"transmitDisabled"` }
Provides information about how AWS Ground Station should configure an antenna for uplink during a contact.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" antennaUplinkConfigProperty := &AntennaUplinkConfigProperty{ SpectrumConfig: &UplinkSpectrumConfigProperty{ CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, TargetEirp: &EirpProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, TransmitDisabled: jsii.Boolean(false), }
type CfnConfig_ConfigDataProperty ¶
type CfnConfig_ConfigDataProperty struct { // 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 // AntennaDownlinkConfig interface{} `field:"optional" json:"antennaDownlinkConfig" yaml:"antennaDownlinkConfig"` // 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 // AntennaDownlinkDemodDecodeConfig interface{} `field:"optional" json:"antennaDownlinkDemodDecodeConfig" yaml:"antennaDownlinkDemodDecodeConfig"` // 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 // AntennaUplinkConfig interface{} `field:"optional" json:"antennaUplinkConfig" yaml:"antennaUplinkConfig"` // 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 // DataflowEndpointConfig interface{} `field:"optional" json:"dataflowEndpointConfig" yaml:"dataflowEndpointConfig"` // 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 // S3RecordingConfig interface{} `field:"optional" json:"s3RecordingConfig" yaml:"s3RecordingConfig"` // 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 // TrackingConfig interface{} `field:"optional" json:"trackingConfig" yaml:"trackingConfig"` // 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 // UplinkEchoConfig interface{} `field:"optional" json:"uplinkEchoConfig" yaml:"uplinkEchoConfig"` }
Config objects provide information to Ground Station about how to configure the antenna and how data flows during a contact.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" configDataProperty := &ConfigDataProperty{ AntennaDownlinkConfig: &AntennaDownlinkConfigProperty{ SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaDownlinkDemodDecodeConfig: &AntennaDownlinkDemodDecodeConfigProperty{ DecodeConfig: &DecodeConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, DemodulationConfig: &DemodulationConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }, SpectrumConfig: &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, }, AntennaUplinkConfig: &AntennaUplinkConfigProperty{ SpectrumConfig: &UplinkSpectrumConfigProperty{ CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }, TargetEirp: &EirpProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, TransmitDisabled: jsii.Boolean(false), }, DataflowEndpointConfig: &DataflowEndpointConfigProperty{ DataflowEndpointName: jsii.String("dataflowEndpointName"), DataflowEndpointRegion: jsii.String("dataflowEndpointRegion"), }, S3RecordingConfig: &S3RecordingConfigProperty{ BucketArn: jsii.String("bucketArn"), Prefix: jsii.String("prefix"), RoleArn: jsii.String("roleArn"), }, TrackingConfig: &TrackingConfigProperty{ Autotrack: jsii.String("autotrack"), }, UplinkEchoConfig: &UplinkEchoConfigProperty{ AntennaUplinkConfigArn: jsii.String("antennaUplinkConfigArn"), Enabled: jsii.Boolean(false), }, }
type CfnConfig_DataflowEndpointConfigProperty ¶
type CfnConfig_DataflowEndpointConfigProperty struct { // 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 // DataflowEndpointName *string `field:"optional" json:"dataflowEndpointName" yaml:"dataflowEndpointName"` // 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 // DataflowEndpointRegion *string `field:"optional" json:"dataflowEndpointRegion" yaml:"dataflowEndpointRegion"` }
Provides information to AWS Ground Station about which IP endpoints to use during a contact.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataflowEndpointConfigProperty := &DataflowEndpointConfigProperty{ DataflowEndpointName: jsii.String("dataflowEndpointName"), DataflowEndpointRegion: jsii.String("dataflowEndpointRegion"), }
type CfnConfig_DecodeConfigProperty ¶
type CfnConfig_DecodeConfigProperty struct { // 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 // UnvalidatedJson *string `field:"optional" json:"unvalidatedJson" yaml:"unvalidatedJson"` }
Defines decoding settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" decodeConfigProperty := &DecodeConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }
type CfnConfig_DemodulationConfigProperty ¶
type CfnConfig_DemodulationConfigProperty struct { // 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 // UnvalidatedJson *string `field:"optional" json:"unvalidatedJson" yaml:"unvalidatedJson"` }
Defines demodulation settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" demodulationConfigProperty := &DemodulationConfigProperty{ UnvalidatedJson: jsii.String("unvalidatedJson"), }
type CfnConfig_EirpProperty ¶
type CfnConfig_EirpProperty struct { // 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 // Units *string `field:"optional" json:"units" yaml:"units"` // 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 // Value *float64 `field:"optional" json:"value" yaml:"value"` }
Defines an equivalent isotropically radiated power (EIRP).
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" eirpProperty := &EirpProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }
type CfnConfig_FrequencyBandwidthProperty ¶
type CfnConfig_FrequencyBandwidthProperty struct { // 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 // Units *string `field:"optional" json:"units" yaml:"units"` // 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#cfn-groundstation-config-frequencybandwidth-value // Value *float64 `field:"optional" json:"value" yaml:"value"` }
Defines a bandwidth.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" frequencyBandwidthProperty := &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }
type CfnConfig_FrequencyProperty ¶
type CfnConfig_FrequencyProperty struct { // 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 // Units *string `field:"optional" json:"units" yaml:"units"` // 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 // Value *float64 `field:"optional" json:"value" yaml:"value"` }
Defines a frequency.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" frequencyProperty := &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }
type CfnConfig_S3RecordingConfigProperty ¶
type CfnConfig_S3RecordingConfigProperty struct { // 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 // BucketArn *string `field:"optional" json:"bucketArn" yaml:"bucketArn"` // 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 // Prefix *string `field:"optional" json:"prefix" yaml:"prefix"` // 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 // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` }
Provides information about how AWS Ground Station should save downlink data to S3.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" s3RecordingConfigProperty := &S3RecordingConfigProperty{ BucketArn: jsii.String("bucketArn"), Prefix: jsii.String("prefix"), RoleArn: jsii.String("roleArn"), }
type CfnConfig_SpectrumConfigProperty ¶
type CfnConfig_SpectrumConfigProperty struct { // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-config-spectrumconfig.html#cfn-groundstation-config-spectrumconfig-bandwidth // Bandwidth interface{} `field:"optional" json:"bandwidth" yaml:"bandwidth"` // 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 // CenterFrequency interface{} `field:"optional" json:"centerFrequency" yaml:"centerFrequency"` // 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 // Polarization *string `field:"optional" json:"polarization" yaml:"polarization"` }
Defines a spectrum.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" spectrumConfigProperty := &SpectrumConfigProperty{ Bandwidth: &FrequencyBandwidthProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }
type CfnConfig_TrackingConfigProperty ¶
type CfnConfig_TrackingConfigProperty struct { // 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 // Autotrack *string `field:"optional" json:"autotrack" yaml:"autotrack"` }
Provides information about how AWS Ground Station should track the satellite through the sky during a contact.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" trackingConfigProperty := &TrackingConfigProperty{ Autotrack: jsii.String("autotrack"), }
type CfnConfig_UplinkEchoConfigProperty ¶
type CfnConfig_UplinkEchoConfigProperty struct { // 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 // AntennaUplinkConfigArn *string `field:"optional" json:"antennaUplinkConfigArn" yaml:"antennaUplinkConfigArn"` // 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 // Enabled interface{} `field:"optional" json:"enabled" yaml:"enabled"` }
Provides information about how AWS Ground Station should echo back uplink transmissions to a dataflow endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" uplinkEchoConfigProperty := &UplinkEchoConfigProperty{ AntennaUplinkConfigArn: jsii.String("antennaUplinkConfigArn"), Enabled: jsii.Boolean(false), }
type CfnConfig_UplinkSpectrumConfigProperty ¶
type CfnConfig_UplinkSpectrumConfigProperty struct { // 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 // CenterFrequency interface{} `field:"optional" json:"centerFrequency" yaml:"centerFrequency"` // 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 // Polarization *string `field:"optional" json:"polarization" yaml:"polarization"` }
Defines a uplink spectrum.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" uplinkSpectrumConfigProperty := &UplinkSpectrumConfigProperty{ CenterFrequency: &FrequencyProperty{ Units: jsii.String("units"), Value: jsii.Number(123), }, Polarization: jsii.String("polarization"), }
type CfnDataflowEndpointGroup ¶
type CfnDataflowEndpointGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the dataflow endpoint group, such as `arn:aws:groundstation:us-east-2:1234567890:dataflow-endpoint-group/9940bf3b-d2ba-427e-9906-842b5e5d2296` . AttrArn() *string // UUID of a dataflow endpoint group. AttrId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a `POSTPASS` state. ContactPostPassDurationSeconds() *float64 SetContactPostPassDurationSeconds(val *float64) // Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a `PREPASS` state. ContactPrePassDurationSeconds() *float64 SetContactPrePassDurationSeconds(val *float64) // Returns: 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. CreationStack() *[]*string // List of Endpoint Details, containing address and port for each endpoint. EndpointDetails() interface{} SetEndpointDetails(val interface{}) // 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. LogicalId() *string // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags assigned to a resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Creates a Dataflow Endpoint Group request.
Dataflow endpoint groups contain a list of endpoints. When the name of a dataflow endpoint group is specified in a mission profile, the Ground Station service will connect to the endpoints and flow data during a contact.
For more information about dataflow endpoint groups, see [Dataflow Endpoint Groups](https://docs.aws.amazon.com/ground-station/latest/ug/dataflowendpointgroups.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataflowEndpointGroup := awscdk.Aws_groundstation.NewCfnDataflowEndpointGroup(this, jsii.String("MyCfnDataflowEndpointGroup"), &CfnDataflowEndpointGroupProps{ EndpointDetails: []interface{}{ &EndpointDetailsProperty{ AwsGroundStationAgentEndpoint: &AwsGroundStationAgentEndpointProperty{ AgentStatus: jsii.String("agentStatus"), AuditResults: jsii.String("auditResults"), EgressAddress: &ConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, }, IngressAddress: &RangedConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, }, Name: jsii.String("name"), }, Endpoint: &DataflowEndpointProperty{ Address: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, Mtu: jsii.Number(123), Name: jsii.String("name"), }, SecurityDetails: &SecurityDetailsProperty{ RoleArn: jsii.String("roleArn"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }, }, }, // the properties below are optional ContactPostPassDurationSeconds: jsii.Number(123), ContactPrePassDurationSeconds: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnDataflowEndpointGroup ¶
func NewCfnDataflowEndpointGroup(scope constructs.Construct, id *string, props *CfnDataflowEndpointGroupProps) CfnDataflowEndpointGroup
type CfnDataflowEndpointGroupProps ¶
type CfnDataflowEndpointGroupProps struct { // List of Endpoint Details, containing address and port for each endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-endpointdetails // EndpointDetails interface{} `field:"required" json:"endpointDetails" yaml:"endpointDetails"` // Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a `POSTPASS` state. // // A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the `POSTPASS` state. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-contactpostpassdurationseconds // ContactPostPassDurationSeconds *float64 `field:"optional" json:"contactPostPassDurationSeconds" yaml:"contactPostPassDurationSeconds"` // Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a `PREPASS` state. // // A Ground Station Dataflow Endpoint Group State Change event will be emitted when the Dataflow Endpoint Group enters and exits the `PREPASS` state. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-contactprepassdurationseconds // ContactPrePassDurationSeconds *float64 `field:"optional" json:"contactPrePassDurationSeconds" yaml:"contactPrePassDurationSeconds"` // Tags assigned to a resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-dataflowendpointgroup.html#cfn-groundstation-dataflowendpointgroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnDataflowEndpointGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnDataflowEndpointGroupProps := &CfnDataflowEndpointGroupProps{ EndpointDetails: []interface{}{ &EndpointDetailsProperty{ AwsGroundStationAgentEndpoint: &AwsGroundStationAgentEndpointProperty{ AgentStatus: jsii.String("agentStatus"), AuditResults: jsii.String("auditResults"), EgressAddress: &ConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, }, IngressAddress: &RangedConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, }, Name: jsii.String("name"), }, Endpoint: &DataflowEndpointProperty{ Address: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, Mtu: jsii.Number(123), Name: jsii.String("name"), }, SecurityDetails: &SecurityDetailsProperty{ RoleArn: jsii.String("roleArn"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }, }, }, // the properties below are optional ContactPostPassDurationSeconds: jsii.Number(123), ContactPrePassDurationSeconds: jsii.Number(123), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnDataflowEndpointGroup_AwsGroundStationAgentEndpointProperty ¶ added in v2.78.0
type CfnDataflowEndpointGroup_AwsGroundStationAgentEndpointProperty struct { // The status of AgentEndpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-agentstatus // AgentStatus *string `field:"optional" json:"agentStatus" yaml:"agentStatus"` // The results of the audit. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-auditresults // AuditResults *string `field:"optional" json:"auditResults" yaml:"auditResults"` // The egress address of AgentEndpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-egressaddress // EgressAddress interface{} `field:"optional" json:"egressAddress" yaml:"egressAddress"` // The ingress address of AgentEndpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-ingressaddress // IngressAddress interface{} `field:"optional" json:"ingressAddress" yaml:"ingressAddress"` // Name string associated with AgentEndpoint. // // Used as a human-readable identifier for AgentEndpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Information about AwsGroundStationAgentEndpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" awsGroundStationAgentEndpointProperty := &AwsGroundStationAgentEndpointProperty{ AgentStatus: jsii.String("agentStatus"), AuditResults: jsii.String("auditResults"), EgressAddress: &ConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, }, IngressAddress: &RangedConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, }, Name: jsii.String("name"), }
type CfnDataflowEndpointGroup_ConnectionDetailsProperty ¶ added in v2.78.0
type CfnDataflowEndpointGroup_ConnectionDetailsProperty struct { // Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html#cfn-groundstation-dataflowendpointgroup-connectiondetails-mtu // Mtu *float64 `field:"optional" json:"mtu" yaml:"mtu"` // A socket address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html#cfn-groundstation-dataflowendpointgroup-connectiondetails-socketaddress // SocketAddress interface{} `field:"optional" json:"socketAddress" yaml:"socketAddress"` }
Egress address of AgentEndpoint with an optional mtu.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" connectionDetailsProperty := &ConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, }
type CfnDataflowEndpointGroup_DataflowEndpointProperty ¶
type CfnDataflowEndpointGroup_DataflowEndpointProperty struct { // The address and port of an endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-address // Address interface{} `field:"optional" json:"address" yaml:"address"` // Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. // // Valid values are between 1400 and 1500. A default value of 1500 is used if not set. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-mtu // Mtu *float64 `field:"optional" json:"mtu" yaml:"mtu"` // The endpoint name. // // When listing available contacts for a satellite, Ground Station searches for a dataflow endpoint whose name matches the value specified by the dataflow endpoint config of the selected mission profile. If no matching dataflow endpoints are found then Ground Station will not display any available contacts for the satellite. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-dataflowendpoint.html#cfn-groundstation-dataflowendpointgroup-dataflowendpoint-name // Name *string `field:"optional" json:"name" yaml:"name"` }
Contains information such as socket address and name that defines an endpoint.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataflowEndpointProperty := &DataflowEndpointProperty{ Address: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, Mtu: jsii.Number(123), Name: jsii.String("name"), }
type CfnDataflowEndpointGroup_EndpointDetailsProperty ¶
type CfnDataflowEndpointGroup_EndpointDetailsProperty struct { // An agent endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-awsgroundstationagentendpoint // AwsGroundStationAgentEndpoint interface{} `field:"optional" json:"awsGroundStationAgentEndpoint" yaml:"awsGroundStationAgentEndpoint"` // Information about the endpoint such as name and the endpoint address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-endpoint // Endpoint interface{} `field:"optional" json:"endpoint" yaml:"endpoint"` // The role ARN, and IDs for security groups and subnets. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-securitydetails // SecurityDetails interface{} `field:"optional" json:"securityDetails" yaml:"securityDetails"` }
The security details and endpoint information.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" endpointDetailsProperty := &EndpointDetailsProperty{ AwsGroundStationAgentEndpoint: &AwsGroundStationAgentEndpointProperty{ AgentStatus: jsii.String("agentStatus"), AuditResults: jsii.String("auditResults"), EgressAddress: &ConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, }, IngressAddress: &RangedConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, }, Name: jsii.String("name"), }, Endpoint: &DataflowEndpointProperty{ Address: &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }, Mtu: jsii.Number(123), Name: jsii.String("name"), }, SecurityDetails: &SecurityDetailsProperty{ RoleArn: jsii.String("roleArn"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }, }
type CfnDataflowEndpointGroup_IntegerRangeProperty ¶ added in v2.78.0
type CfnDataflowEndpointGroup_IntegerRangeProperty struct { // A maximum value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-maximum // Maximum *float64 `field:"optional" json:"maximum" yaml:"maximum"` // A minimum value. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-minimum // Minimum *float64 `field:"optional" json:"minimum" yaml:"minimum"` }
An integer range that has a minimum and maximum value.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" integerRangeProperty := &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }
type CfnDataflowEndpointGroup_RangedConnectionDetailsProperty ¶ added in v2.78.0
type CfnDataflowEndpointGroup_RangedConnectionDetailsProperty struct { // Maximum transmission unit (MTU) size in bytes of a dataflow endpoint. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroup-rangedconnectiondetails-mtu // Mtu *float64 `field:"optional" json:"mtu" yaml:"mtu"` // A ranged socket address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroup-rangedconnectiondetails-socketaddress // SocketAddress interface{} `field:"optional" json:"socketAddress" yaml:"socketAddress"` }
Ingress address of AgentEndpoint with a port range and an optional mtu.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rangedConnectionDetailsProperty := &RangedConnectionDetailsProperty{ Mtu: jsii.Number(123), SocketAddress: &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }, }
type CfnDataflowEndpointGroup_RangedSocketAddressProperty ¶ added in v2.78.0
type CfnDataflowEndpointGroup_RangedSocketAddressProperty struct { // IPv4 socket address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroup-rangedsocketaddress-name // Name *string `field:"optional" json:"name" yaml:"name"` // Port range of a socket address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroup-rangedsocketaddress-portrange // PortRange interface{} `field:"optional" json:"portRange" yaml:"portRange"` }
A socket address with a port range.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rangedSocketAddressProperty := &RangedSocketAddressProperty{ Name: jsii.String("name"), PortRange: &IntegerRangeProperty{ Maximum: jsii.Number(123), Minimum: jsii.Number(123), }, }
type CfnDataflowEndpointGroup_SecurityDetailsProperty ¶
type CfnDataflowEndpointGroup_SecurityDetailsProperty struct { // The ARN of a role which Ground Station has permission to assume, such as `arn:aws:iam::1234567890:role/DataDeliveryServiceRole` . // // Ground Station will assume this role and create an ENI in your VPC on the specified subnet upon creation of a dataflow endpoint group. This ENI is used as the ingress/egress point for data streamed during a satellite contact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-rolearn // RoleArn *string `field:"optional" json:"roleArn" yaml:"roleArn"` // The security group Ids of the security role, such as `sg-1234567890abcdef0` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-securitygroupids // SecurityGroupIds *[]*string `field:"optional" json:"securityGroupIds" yaml:"securityGroupIds"` // The subnet Ids of the security details, such as `subnet-12345678` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-securitydetails.html#cfn-groundstation-dataflowendpointgroup-securitydetails-subnetids // SubnetIds *[]*string `field:"optional" json:"subnetIds" yaml:"subnetIds"` }
Information about IAM roles, subnets, and security groups needed for this DataflowEndpointGroup.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" securityDetailsProperty := &SecurityDetailsProperty{ RoleArn: jsii.String("roleArn"), SecurityGroupIds: []*string{ jsii.String("securityGroupIds"), }, SubnetIds: []*string{ jsii.String("subnetIds"), }, }
type CfnDataflowEndpointGroup_SocketAddressProperty ¶
type CfnDataflowEndpointGroup_SocketAddressProperty struct { // The name of the endpoint, such as `Endpoint 1` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-name // Name *string `field:"optional" json:"name" yaml:"name"` // The port of the endpoint, such as `55888` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html#cfn-groundstation-dataflowendpointgroup-socketaddress-port // Port *float64 `field:"optional" json:"port" yaml:"port"` }
The address of the endpoint, such as `192.168.1.1` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" socketAddressProperty := &SocketAddressProperty{ Name: jsii.String("name"), Port: jsii.Number(123), }
type CfnMissionProfile ¶
type CfnMissionProfile interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The ARN of the mission profile, such as `arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296` . AttrArn() *string // The ID of the mission profile, such as `9940bf3b-d2ba-427e-9906-842b5e5d2296` . AttrId() *string // The region of the mission profile. AttrRegion() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Amount of time in seconds after a contact ends that you’d like to receive a Ground Station Contact State Change indicating the pass has finished. ContactPostPassDurationSeconds() *float64 SetContactPostPassDurationSeconds(val *float64) // Amount of time in seconds prior to contact start that you'd like to receive a Ground Station Contact State Change Event indicating an upcoming pass. ContactPrePassDurationSeconds() *float64 SetContactPrePassDurationSeconds(val *float64) // Returns: 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. CreationStack() *[]*string // A list containing lists of config ARNs. DataflowEdges() interface{} SetDataflowEdges(val interface{}) // 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. LogicalId() *string // Minimum length of a contact in seconds that Ground Station will return when listing contacts. MinimumViableContactDurationSeconds() *float64 SetMinimumViableContactDurationSeconds(val *float64) // The name of the mission profile. Name() *string SetName(val *string) // The tree node. Node() constructs.Node // 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 })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // KMS key to use for encrypting streams. StreamsKmsKey() interface{} SetStreamsKmsKey(val interface{}) // Role to use for encrypting streams with KMS key. StreamsKmsRole() *string SetStreamsKmsRole(val *string) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // Tags assigned to the mission profile. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact. TrackingConfigArn() *string SetTrackingConfigArn(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // 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. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: 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. // AddMetadata(key *string, value interface{}) // 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, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "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. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // 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:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // 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. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: 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. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // 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. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Mission profiles specify parameters and provide references to config objects to define how Ground Station lists and executes contacts.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMissionProfile := awscdk.Aws_groundstation.NewCfnMissionProfile(this, jsii.String("MyCfnMissionProfile"), &CfnMissionProfileProps{ DataflowEdges: []interface{}{ &DataflowEdgeProperty{ Destination: jsii.String("destination"), Source: jsii.String("source"), }, }, MinimumViableContactDurationSeconds: jsii.Number(123), Name: jsii.String("name"), TrackingConfigArn: jsii.String("trackingConfigArn"), // the properties below are optional ContactPostPassDurationSeconds: jsii.Number(123), ContactPrePassDurationSeconds: jsii.Number(123), StreamsKmsKey: &StreamsKmsKeyProperty{ KmsAliasArn: jsii.String("kmsAliasArn"), KmsKeyArn: jsii.String("kmsKeyArn"), }, StreamsKmsRole: jsii.String("streamsKmsRole"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnMissionProfile ¶
func NewCfnMissionProfile(scope constructs.Construct, id *string, props *CfnMissionProfileProps) CfnMissionProfile
type CfnMissionProfileProps ¶
type CfnMissionProfileProps struct { // A list containing lists of config ARNs. // // Each list of config ARNs is an edge, with a "from" config and a "to" config. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-dataflowedges // DataflowEdges interface{} `field:"required" json:"dataflowEdges" yaml:"dataflowEdges"` // Minimum length of a contact in seconds that Ground Station will return when listing contacts. // // Ground Station will not return contacts shorter than this duration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-minimumviablecontactdurationseconds // MinimumViableContactDurationSeconds *float64 `field:"required" json:"minimumViableContactDurationSeconds" yaml:"minimumViableContactDurationSeconds"` // The name of the mission profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-name // Name *string `field:"required" json:"name" yaml:"name"` // The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-trackingconfigarn // TrackingConfigArn *string `field:"required" json:"trackingConfigArn" yaml:"trackingConfigArn"` // Amount of time in seconds after a contact ends that you’d like to receive a Ground Station Contact State Change indicating the pass has finished. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactpostpassdurationseconds // ContactPostPassDurationSeconds *float64 `field:"optional" json:"contactPostPassDurationSeconds" yaml:"contactPostPassDurationSeconds"` // Amount of time in seconds prior to contact start that you'd like to receive a Ground Station Contact State Change Event indicating an upcoming pass. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-contactprepassdurationseconds // ContactPrePassDurationSeconds *float64 `field:"optional" json:"contactPrePassDurationSeconds" yaml:"contactPrePassDurationSeconds"` // KMS key to use for encrypting streams. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmskey // StreamsKmsKey interface{} `field:"optional" json:"streamsKmsKey" yaml:"streamsKmsKey"` // Role to use for encrypting streams with KMS key. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-streamskmsrole // StreamsKmsRole *string `field:"optional" json:"streamsKmsRole" yaml:"streamsKmsRole"` // Tags assigned to the mission profile. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-groundstation-missionprofile.html#cfn-groundstation-missionprofile-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnMissionProfile`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnMissionProfileProps := &CfnMissionProfileProps{ DataflowEdges: []interface{}{ &DataflowEdgeProperty{ Destination: jsii.String("destination"), Source: jsii.String("source"), }, }, MinimumViableContactDurationSeconds: jsii.Number(123), Name: jsii.String("name"), TrackingConfigArn: jsii.String("trackingConfigArn"), // the properties below are optional ContactPostPassDurationSeconds: jsii.Number(123), ContactPrePassDurationSeconds: jsii.Number(123), StreamsKmsKey: &StreamsKmsKeyProperty{ KmsAliasArn: jsii.String("kmsAliasArn"), KmsKeyArn: jsii.String("kmsKeyArn"), }, StreamsKmsRole: jsii.String("streamsKmsRole"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnMissionProfile_DataflowEdgeProperty ¶
type CfnMissionProfile_DataflowEdgeProperty struct { // The ARN of the destination for this dataflow edge. // // For example, specify the ARN of a dataflow endpoint config for a downlink edge or an antenna uplink config for an uplink edge. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-destination // Destination *string `field:"optional" json:"destination" yaml:"destination"` // The ARN of the source for this dataflow edge. // // For example, specify the ARN of an antenna downlink config for a downlink edge or a dataflow endpoint config for an uplink edge. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-dataflowedge.html#cfn-groundstation-missionprofile-dataflowedge-source // Source *string `field:"optional" json:"source" yaml:"source"` }
A dataflow edge defines from where and to where data will flow during a contact.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dataflowEdgeProperty := &DataflowEdgeProperty{ Destination: jsii.String("destination"), Source: jsii.String("source"), }
type CfnMissionProfile_StreamsKmsKeyProperty ¶ added in v2.78.0
type CfnMissionProfile_StreamsKmsKeyProperty struct { // KMS Alias Arn. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html#cfn-groundstation-missionprofile-streamskmskey-kmsaliasarn // KmsAliasArn *string `field:"optional" json:"kmsAliasArn" yaml:"kmsAliasArn"` // KMS Key Arn. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-missionprofile-streamskmskey.html#cfn-groundstation-missionprofile-streamskmskey-kmskeyarn // KmsKeyArn *string `field:"optional" json:"kmsKeyArn" yaml:"kmsKeyArn"` }
KMS key info.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" streamsKmsKeyProperty := &StreamsKmsKeyProperty{ KmsAliasArn: jsii.String("kmsAliasArn"), KmsKeyArn: jsii.String("kmsKeyArn"), }
Source Files ¶
- CfnConfig.go
- CfnConfigProps.go
- CfnConfig_AntennaDownlinkConfigProperty.go
- CfnConfig_AntennaDownlinkDemodDecodeConfigProperty.go
- CfnConfig_AntennaUplinkConfigProperty.go
- CfnConfig_ConfigDataProperty.go
- CfnConfig_DataflowEndpointConfigProperty.go
- CfnConfig_DecodeConfigProperty.go
- CfnConfig_DemodulationConfigProperty.go
- CfnConfig_EirpProperty.go
- CfnConfig_FrequencyBandwidthProperty.go
- CfnConfig_FrequencyProperty.go
- CfnConfig_S3RecordingConfigProperty.go
- CfnConfig_SpectrumConfigProperty.go
- CfnConfig_TrackingConfigProperty.go
- CfnConfig_UplinkEchoConfigProperty.go
- CfnConfig_UplinkSpectrumConfigProperty.go
- CfnConfig__checks.go
- CfnDataflowEndpointGroup.go
- CfnDataflowEndpointGroupProps.go
- CfnDataflowEndpointGroup_AwsGroundStationAgentEndpointProperty.go
- CfnDataflowEndpointGroup_ConnectionDetailsProperty.go
- CfnDataflowEndpointGroup_DataflowEndpointProperty.go
- CfnDataflowEndpointGroup_EndpointDetailsProperty.go
- CfnDataflowEndpointGroup_IntegerRangeProperty.go
- CfnDataflowEndpointGroup_RangedConnectionDetailsProperty.go
- CfnDataflowEndpointGroup_RangedSocketAddressProperty.go
- CfnDataflowEndpointGroup_SecurityDetailsProperty.go
- CfnDataflowEndpointGroup_SocketAddressProperty.go
- CfnDataflowEndpointGroup__checks.go
- CfnMissionProfile.go
- CfnMissionProfileProps.go
- CfnMissionProfile_DataflowEdgeProperty.go
- CfnMissionProfile_StreamsKmsKeyProperty.go
- CfnMissionProfile__checks.go
- main.go