CfnDataflowEndpointGroup

class aws_cdk.aws_groundstation.CfnDataflowEndpointGroup(scope, id, *, endpoint_details, contact_post_pass_duration_seconds=None, contact_pre_pass_duration_seconds=None, tags=None)

Bases: CfnResource

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 .

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

Example:

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

cfn_dataflow_endpoint_group = groundstation.CfnDataflowEndpointGroup(self, "MyCfnDataflowEndpointGroup",
    endpoint_details=[groundstation.CfnDataflowEndpointGroup.EndpointDetailsProperty(
        aws_ground_station_agent_endpoint=groundstation.CfnDataflowEndpointGroup.AwsGroundStationAgentEndpointProperty(
            agent_status="agentStatus",
            audit_results="auditResults",
            egress_address=groundstation.CfnDataflowEndpointGroup.ConnectionDetailsProperty(
                mtu=123,
                socket_address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
                    name="name",
                    port=123
                )
            ),
            ingress_address=groundstation.CfnDataflowEndpointGroup.RangedConnectionDetailsProperty(
                mtu=123,
                socket_address=groundstation.CfnDataflowEndpointGroup.RangedSocketAddressProperty(
                    name="name",
                    port_range=groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
                        maximum=123,
                        minimum=123
                    )
                )
            ),
            name="name"
        ),
        endpoint=groundstation.CfnDataflowEndpointGroup.DataflowEndpointProperty(
            address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
                name="name",
                port=123
            ),
            mtu=123,
            name="name"
        ),
        security_details=groundstation.CfnDataflowEndpointGroup.SecurityDetailsProperty(
            role_arn="roleArn",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    )],

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

Parameters:

scope (Construct) – Scope in which this resource is defined.
id (str) – Construct identifier for this resource (unique in its scope).
endpoint_details (Union[IResolvable, Sequence[Union[IResolvable, EndpointDetailsProperty, Dict[str, Any]]]]) – List of Endpoint Details, containing address and port for each endpoint.
contact_post_pass_duration_seconds (Union[int, float, None]) – 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.
contact_pre_pass_duration_seconds (Union[int, float, None]) – 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.
tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – Tags assigned to a resource.

Methods

add_deletion_override(path)

Syntactic sugar for addOverride(path, undefined).

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

add_dependency(target)

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

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

Parameters:

target (CfnResource) –

Return type:

None

add_depends_on(target)

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

Parameters:

target (CfnResource) –

Deprecated:

use addDependency

Stability:

deprecated

Return type:

None

add_metadata(key, value)

Add a value to the CloudFormation Resource Metadata.

Parameters:

key (str) –
value (Any) –

See:

Return type:

None

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

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

add_override(path, value)

Adds an override to the synthesized CloudFormation resource.

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

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

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

For example:

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

would add the overrides Example:

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

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

Parameters:

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

Return type:

None

add_property_deletion_override(property_path)

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

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

add_property_override(property_path, value)

Adds an override to a resource property.

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

Parameters:

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

Return type:

None

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

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

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

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

Parameters:

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

See:

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

Return type:

None

get_att(attribute_name, type_hint=None)

Returns a token for an runtime attribute of this resource.

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

Parameters:

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

Return type:

Reference

get_metadata(key)

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

key (str) –

See:

Return type:

Any

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

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

inspect(inspector)

Examines the CloudFormation resource and discloses attributes.

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

obtain_dependencies()

Retrieves an array of resources this resource depends on.

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

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

obtain_resource_dependencies()

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

Return type:: List[CfnResource]

override_logical_id(new_logical_id)

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

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

remove_dependency(target)

Indicates that this resource no longer depends on another resource.

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

Parameters:

target (CfnResource) –

Return type:

None

replace_dependency(target, new_target)

Replaces one dependency with another.

Parameters:

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

Return type:

None

to_string()

Returns a string representation of this construct.

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

Attributes

CFN_RESOURCE_TYPE_NAME = 'AWS::GroundStation::DataflowEndpointGroup'

attr_arn

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

CloudformationAttribute:: Arn

attr_id

UUID of a dataflow endpoint group.

CloudformationAttribute:: Id

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

cfn_resource_type: AWS resource type.

contact_post_pass_duration_seconds: Amount of time, in seconds, after a contact ends that the Ground Station Dataflow Endpoint Group will be in a POSTPASS state.

contact_pre_pass_duration_seconds: Amount of time, in seconds, before a contact starts that the Ground Station Dataflow Endpoint Group will be in a PREPASS state.

creation_stack

return:

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

endpoint_details: List of Endpoint Details, containing address and port for each endpoint.

logical_id

The logical ID for this CloudFormation stack element.

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

To override this value, use overrideLogicalId(newLogicalId).

Returns:

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

node: The tree node.

ref

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

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

stack

The stack in which this element is defined.

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

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

tags_raw: Tags assigned to a resource.

Static Methods

classmethod is_cfn_element(x)

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

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

Parameters:

x (Any) –

Return type:

bool

Returns:

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

classmethod is_cfn_resource(x)

Check whether the given object is a CfnResource.

Parameters:

x (Any) –

Return type:

bool

classmethod is_construct(x)

Checks if x is a construct.

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

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

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

AwsGroundStationAgentEndpointProperty

class CfnDataflowEndpointGroup.AwsGroundStationAgentEndpointProperty(*, agent_status=None, audit_results=None, egress_address=None, ingress_address=None, name=None)

Bases: object

Information about AwsGroundStationAgentEndpoint.

Parameters:

agent_status (Optional[str]) – The status of AgentEndpoint.
audit_results (Optional[str]) – The results of the audit.
egress_address (Union[IResolvable, ConnectionDetailsProperty, Dict[str, Any], None]) – The egress address of AgentEndpoint.
ingress_address (Union[IResolvable, RangedConnectionDetailsProperty, Dict[str, Any], None]) – The ingress address of AgentEndpoint.
name (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

aws_ground_station_agent_endpoint_property = groundstation.CfnDataflowEndpointGroup.AwsGroundStationAgentEndpointProperty(
    agent_status="agentStatus",
    audit_results="auditResults",
    egress_address=groundstation.CfnDataflowEndpointGroup.ConnectionDetailsProperty(
        mtu=123,
        socket_address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
            name="name",
            port=123
        )
    ),
    ingress_address=groundstation.CfnDataflowEndpointGroup.RangedConnectionDetailsProperty(
        mtu=123,
        socket_address=groundstation.CfnDataflowEndpointGroup.RangedSocketAddressProperty(
            name="name",
            port_range=groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
                maximum=123,
                minimum=123
            )
        )
    ),
    name="name"
)

Attributes

agent_status

The status of AgentEndpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint.html#cfn-groundstation-dataflowendpointgroup-awsgroundstationagentendpoint-agentstatus

audit_results

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

egress_address

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

ingress_address

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

name

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

ConnectionDetailsProperty

class CfnDataflowEndpointGroup.ConnectionDetailsProperty(*, mtu=None, socket_address=None)

Bases: object

Egress address of AgentEndpoint with an optional mtu.

Parameters:

mtu (Union[int, float, None]) – Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socket_address (Union[IResolvable, SocketAddressProperty, Dict[str, Any], None]) – A socket address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html

ExampleMetadata:

fixture=_generated

Example:

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

connection_details_property = groundstation.CfnDataflowEndpointGroup.ConnectionDetailsProperty(
    mtu=123,
    socket_address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
        name="name",
        port=123
    )
)

Attributes

mtu

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

socket_address

A socket address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-connectiondetails.html#cfn-groundstation-dataflowendpointgroup-connectiondetails-socketaddress

DataflowEndpointProperty

class CfnDataflowEndpointGroup.DataflowEndpointProperty(*, address=None, mtu=None, name=None)

Bases: object

Contains information such as socket address and name that defines an endpoint.

Parameters:

address (Union[IResolvable, SocketAddressProperty, Dict[str, Any], None]) – The address and port of an endpoint.
mtu (Union[int, float, None]) – 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.
name (Optional[str]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

dataflow_endpoint_property = groundstation.CfnDataflowEndpointGroup.DataflowEndpointProperty(
    address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
        name="name",
        port=123
    ),
    mtu=123,
    name="name"
)

Attributes

address

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

mtu

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

name

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

EndpointDetailsProperty

class CfnDataflowEndpointGroup.EndpointDetailsProperty(*, aws_ground_station_agent_endpoint=None, endpoint=None, security_details=None)

Bases: object

The security details and endpoint information.

Parameters:

aws_ground_station_agent_endpoint (Union[IResolvable, AwsGroundStationAgentEndpointProperty, Dict[str, Any], None]) – An agent endpoint.
endpoint (Union[IResolvable, DataflowEndpointProperty, Dict[str, Any], None]) – Information about the endpoint such as name and the endpoint address.
security_details (Union[IResolvable, SecurityDetailsProperty, Dict[str, Any], None]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

endpoint_details_property = groundstation.CfnDataflowEndpointGroup.EndpointDetailsProperty(
    aws_ground_station_agent_endpoint=groundstation.CfnDataflowEndpointGroup.AwsGroundStationAgentEndpointProperty(
        agent_status="agentStatus",
        audit_results="auditResults",
        egress_address=groundstation.CfnDataflowEndpointGroup.ConnectionDetailsProperty(
            mtu=123,
            socket_address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
                name="name",
                port=123
            )
        ),
        ingress_address=groundstation.CfnDataflowEndpointGroup.RangedConnectionDetailsProperty(
            mtu=123,
            socket_address=groundstation.CfnDataflowEndpointGroup.RangedSocketAddressProperty(
                name="name",
                port_range=groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
                    maximum=123,
                    minimum=123
                )
            )
        ),
        name="name"
    ),
    endpoint=groundstation.CfnDataflowEndpointGroup.DataflowEndpointProperty(
        address=groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
            name="name",
            port=123
        ),
        mtu=123,
        name="name"
    ),
    security_details=groundstation.CfnDataflowEndpointGroup.SecurityDetailsProperty(
        role_arn="roleArn",
        security_group_ids=["securityGroupIds"],
        subnet_ids=["subnetIds"]
    )
)

Attributes

aws_ground_station_agent_endpoint

An agent endpoint.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-endpointdetails.html#cfn-groundstation-dataflowendpointgroup-endpointdetails-awsgroundstationagentendpoint

endpoint

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

security_details

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

IntegerRangeProperty

class CfnDataflowEndpointGroup.IntegerRangeProperty(*, maximum=None, minimum=None)

Bases: object

An integer range that has a minimum and maximum value.

Parameters:

maximum (Union[int, float, None]) – A maximum value.
minimum (Union[int, float, None]) – A minimum value.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html

ExampleMetadata:

fixture=_generated

Example:

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

integer_range_property = groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
    maximum=123,
    minimum=123
)

Attributes

maximum

A maximum value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-maximum

minimum

A minimum value.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-integerrange.html#cfn-groundstation-dataflowendpointgroup-integerrange-minimum

RangedConnectionDetailsProperty

class CfnDataflowEndpointGroup.RangedConnectionDetailsProperty(*, mtu=None, socket_address=None)

Bases: object

Ingress address of AgentEndpoint with a port range and an optional mtu.

Parameters:

mtu (Union[int, float, None]) – Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.
socket_address (Union[IResolvable, RangedSocketAddressProperty, Dict[str, Any], None]) – A ranged socket address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html

ExampleMetadata:

fixture=_generated

Example:

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

ranged_connection_details_property = groundstation.CfnDataflowEndpointGroup.RangedConnectionDetailsProperty(
    mtu=123,
    socket_address=groundstation.CfnDataflowEndpointGroup.RangedSocketAddressProperty(
        name="name",
        port_range=groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
            maximum=123,
            minimum=123
        )
    )
)

Attributes

mtu

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

socket_address

A ranged socket address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedconnectiondetails.html#cfn-groundstation-dataflowendpointgroup-rangedconnectiondetails-socketaddress

RangedSocketAddressProperty

class CfnDataflowEndpointGroup.RangedSocketAddressProperty(*, name=None, port_range=None)

Bases: object

A socket address with a port range.

Parameters:

name (Optional[str]) – IPv4 socket address.
port_range (Union[IResolvable, IntegerRangeProperty, Dict[str, Any], None]) – Port range of a socket address.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html

ExampleMetadata:

fixture=_generated

Example:

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

ranged_socket_address_property = groundstation.CfnDataflowEndpointGroup.RangedSocketAddressProperty(
    name="name",
    port_range=groundstation.CfnDataflowEndpointGroup.IntegerRangeProperty(
        maximum=123,
        minimum=123
    )
)

Attributes

name

IPv4 socket address.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-rangedsocketaddress.html#cfn-groundstation-dataflowendpointgroup-rangedsocketaddress-name

port_range

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

SecurityDetailsProperty

class CfnDataflowEndpointGroup.SecurityDetailsProperty(*, role_arn=None, security_group_ids=None, subnet_ids=None)

Bases: object

Information about IAM roles, subnets, and security groups needed for this DataflowEndpointGroup.

Parameters:

role_arn (Optional[str]) – 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.
security_group_ids (Optional[Sequence[str]]) – The security group Ids of the security role, such as sg-1234567890abcdef0 .
subnet_ids (Optional[Sequence[str]]) – 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

ExampleMetadata:

fixture=_generated

Example:

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

security_details_property = groundstation.CfnDataflowEndpointGroup.SecurityDetailsProperty(
    role_arn="roleArn",
    security_group_ids=["securityGroupIds"],
    subnet_ids=["subnetIds"]
)

Attributes

role_arn

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

security_group_ids

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

subnet_ids

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

SocketAddressProperty

class CfnDataflowEndpointGroup.SocketAddressProperty(*, name=None, port=None)

Bases: object

The address of the endpoint, such as 192.168.1.1 .

Parameters:

name (Optional[str]) – The name of the endpoint, such as Endpoint 1 .
port (Union[int, float, None]) – The port of the endpoint, such as 55888 .

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-groundstation-dataflowendpointgroup-socketaddress.html

ExampleMetadata:

fixture=_generated

Example:

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

socket_address_property = groundstation.CfnDataflowEndpointGroup.SocketAddressProperty(
    name="name",
    port=123
)

Attributes

name

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

port

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