[ aws . groundstation ]

create-dataflow-endpoint-group-v2

Description

Creates a DataflowEndpointGroupV2 containing the specified list of DataflowEndpoint objects.

The name field in each endpoint is used in your mission profile DataflowEndpointConfig to specify which endpoints to use during a contact.

When a contact uses multiple DataflowEndpointConfig objects, each Config must match a DataflowEndpoint in the same group.

See also: AWS API Documentation

Synopsis

  create-dataflow-endpoint-group-v2
--endpoints <value>
[--contact-pre-pass-duration-seconds <value>]
[--contact-post-pass-duration-seconds <value>]
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--endpoints (list) [required]

Dataflow endpoint group’s endpoint definitions

Constraints:

• min: 1
• max: 12

(tagged union structure)

Endpoint definition used for creating a dataflow endpoint

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: uplinkAwsGroundStationAgentEndpoint, downlinkAwsGroundStationAgentEndpoint.

uplinkAwsGroundStationAgentEndpoint -> (structure)

Definition for an uplink agent endpoint

name -> (string) [required]

Uplink dataflow endpoint name

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

dataflowDetails -> (tagged union structure) [required]

Dataflow details for the uplink endpoint

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Uplink connection details for customer to Agent and Agent to Ground Station

ingressAddressAndPort -> (structure) [required]

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure) [required]

A socket address.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

mtu -> (integer)

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

agentIpAndPortAddress -> (structure) [required]

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

socketAddress -> (structure) [required]

A ranged socket address.

name -> (string) [required]

IPv4 socket address.

Constraints:

• min: 7
• max: 16
• pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

portRange -> (structure) [required]

Port range of a socket address.

minimum -> (integer) [required]

A minimum value.

maximum -> (integer) [required]

A maximum value.

mtu -> (integer)

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

Constraints:

• min: 1400
• max: 1500

downlinkAwsGroundStationAgentEndpoint -> (structure)

Definition for a downlink agent endpoint

name -> (string) [required]

Downlink dataflow endpoint name

Constraints:

• min: 1
• max: 256
• pattern: [ a-zA-Z0-9_:-]{1,256}

dataflowDetails -> (tagged union structure) [required]

Dataflow details for the downlink endpoint

Note

This is a Tagged Union structure. Only one of the following top level keys can be set: agentConnectionDetails.

agentConnectionDetails -> (structure)

Downlink connection details for customer to Agent and Agent to Ground Station

agentIpAndPortAddress -> (structure) [required]

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

socketAddress -> (structure) [required]

A ranged socket address.

name -> (string) [required]

IPv4 socket address.

Constraints:

• min: 7
• max: 16
• pattern: \d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}

portRange -> (structure) [required]

Port range of a socket address.

minimum -> (integer) [required]

A minimum value.

maximum -> (integer) [required]

A maximum value.

mtu -> (integer)

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

Constraints:

• min: 1400
• max: 1500

egressAddressAndPort -> (structure) [required]

Egress address of AgentEndpoint with an optional mtu.

socketAddress -> (structure) [required]

A socket address.

name -> (string) [required]

Name of a socket address.

port -> (integer) [required]

Port of a socket address.

mtu -> (integer)

Maximum transmission unit (MTU) size in bytes of a dataflow endpoint.

JSON Syntax:

[
  {
    "uplinkAwsGroundStationAgentEndpoint": {
      "name": "string",
      "dataflowDetails": {
        "agentConnectionDetails": {
          "ingressAddressAndPort": {
            "socketAddress": {
              "name": "string",
              "port": integer
            },
            "mtu": integer
          },
          "agentIpAndPortAddress": {
            "socketAddress": {
              "name": "string",
              "portRange": {
                "minimum": integer,
                "maximum": integer
              }
            },
            "mtu": integer
          }
        }
      }
    },
    "downlinkAwsGroundStationAgentEndpoint": {
      "name": "string",
      "dataflowDetails": {
        "agentConnectionDetails": {
          "agentIpAndPortAddress": {
            "socketAddress": {
              "name": "string",
              "portRange": {
                "minimum": integer,
                "maximum": integer
              }
            },
            "mtu": integer
          },
          "egressAddressAndPort": {
            "socketAddress": {
              "name": "string",
              "port": integer
            },
            "mtu": integer
          }
        }
      }
    }
  }
  ...
]

--contact-pre-pass-duration-seconds (integer)

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.

Constraints:

• min: 30
• max: 480

--contact-post-pass-duration-seconds (integer)

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.

Constraints:

• min: 30
• max: 480

--tags (map)

Tags of a V2 dataflow endpoint group.

key -> (string)

value -> (string)

Shorthand Syntax:

KeyName1=string,KeyName2=string

JSON Syntax:

{"string": "string"
  ...}

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table
• yaml
• yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

• base64
• raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

dataflowEndpointGroupId -> (string)

Dataflow endpoint group ID

Constraints:

• min: 36
• max: 36
• pattern: [a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}