CfnDataflowEndpointGroupPropsMixin

class aws_cdk.mixins_preview.aws_groundstation.mixins.CfnDataflowEndpointGroupPropsMixin(props, *, strategy=None)

Bases: Mixin

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

Mixin:

true

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.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_groundstation import mixins as groundstation_mixins

cfn_dataflow_endpoint_group_props_mixin = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin(groundstation_mixins.CfnDataflowEndpointGroupMixinProps(
    contact_post_pass_duration_seconds=123,
    contact_pre_pass_duration_seconds=123,
    endpoint_details=[groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.EndpointDetailsProperty(
        aws_ground_station_agent_endpoint=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.AwsGroundStationAgentEndpointProperty(
            agent_status="agentStatus",
            audit_results="auditResults",
            egress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.ConnectionDetailsProperty(
                mtu=123,
                socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SocketAddressProperty(
                    name="name",
                    port=123
                )
            ),
            ingress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedConnectionDetailsProperty(
                mtu=123,
                socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedSocketAddressProperty(
                    name="name",
                    port_range=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.IntegerRangeProperty(
                        maximum=123,
                        minimum=123
                    )
                )
            ),
            name="name"
        ),
        endpoint=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.DataflowEndpointProperty(
            address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SocketAddressProperty(
                name="name",
                port=123
            ),
            mtu=123,
            name="name"
        ),
        security_details=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SecurityDetailsProperty(
            role_arn="roleArn",
            security_group_ids=["securityGroupIds"],
            subnet_ids=["subnetIds"]
        )
    )],
    tags=[CfnTag(
        key="key",
        value="value"
    )]
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::GroundStation::DataflowEndpointGroup.

Parameters:

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:

construct (IConstruct)

Return type:

IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:

construct (IConstruct)

Return type:

bool

Attributes

CFN_PROPERTY_KEYS = ['contactPostPassDurationSeconds', 'contactPrePassDurationSeconds', 'endpointDetails', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:

x (Any) – Any object.

Return type:

bool

Returns:

true if x is an object created from a class which extends Mixin.

Stability:

experimental

AwsGroundStationAgentEndpointProperty

class CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

aws_ground_station_agent_endpoint_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.AwsGroundStationAgentEndpointProperty(
    agent_status="agentStatus",
    audit_results="auditResults",
    egress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.ConnectionDetailsProperty(
        mtu=123,
        socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SocketAddressProperty(
            name="name",
            port=123
        )
    ),
    ingress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedConnectionDetailsProperty(
        mtu=123,
        socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedSocketAddressProperty(
            name="name",
            port_range=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

connection_details_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.ConnectionDetailsProperty(
    mtu=123,
    socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

dataflow_endpoint_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.DataflowEndpointProperty(
    address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.EndpointDetailsProperty(*, aws_ground_station_agent_endpoint=None, endpoint=None, security_details=None)

Bases: object

The security details and endpoint information.

Parameters:
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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

endpoint_details_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.EndpointDetailsProperty(
    aws_ground_station_agent_endpoint=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.AwsGroundStationAgentEndpointProperty(
        agent_status="agentStatus",
        audit_results="auditResults",
        egress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.ConnectionDetailsProperty(
            mtu=123,
            socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SocketAddressProperty(
                name="name",
                port=123
            )
        ),
        ingress_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedConnectionDetailsProperty(
            mtu=123,
            socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedSocketAddressProperty(
                name="name",
                port_range=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.IntegerRangeProperty(
                    maximum=123,
                    minimum=123
                )
            )
        ),
        name="name"
    ),
    endpoint=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.DataflowEndpointProperty(
        address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.SocketAddressProperty(
            name="name",
            port=123
        ),
        mtu=123,
        name="name"
    ),
    security_details=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

integer_range_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

ranged_connection_details_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedConnectionDetailsProperty(
    mtu=123,
    socket_address=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedSocketAddressProperty(
        name="name",
        port_range=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

ranged_socket_address_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.RangedSocketAddressProperty(
    name="name",
    port_range=groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

security_details_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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 CfnDataflowEndpointGroupPropsMixin.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.mixins_preview.aws_groundstation import mixins as groundstation_mixins

socket_address_property = groundstation_mixins.CfnDataflowEndpointGroupPropsMixin.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