[ aws . groundstation ]

create-dataflow-endpoint-group

Description

Creates a DataflowEndpoint group 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

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-dataflow-endpoint-group
--endpoint-details <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--cli-auto-prompt <value>]

Options

--endpoint-details (list)

Endpoint details of each endpoint in the dataflow endpoint group.

(structure)

Information about the endpoint details.

endpoint -> (structure)

A dataflow endpoint.

address -> (structure)

Socket address of a dataflow endpoint.

name -> (string)

Name of a socket address.

port -> (integer)

Port of a socket address.

mtu -> (integer)

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

name -> (string)

Name of a dataflow endpoint.

status -> (string)

Status of a dataflow endpoint.

securityDetails -> (structure)

Endpoint security details.

roleArn -> (string)

ARN to a role needed for connecting streams to your instances.

securityGroupIds -> (list)

The security groups to attach to the elastic network interfaces.

(string)

subnetIds -> (list)

A list of subnets where AWS Ground Station places elastic network interfaces to send streams to your instances.

(string)

Shorthand Syntax:

endpoint={address={name=string,port=integer},mtu=integer,name=string,status=string},securityDetails={roleArn=string,securityGroupIds=[string,string],subnetIds=[string,string]} ...

JSON Syntax:

[
  {
    "endpoint": {
      "address": {
        "name": "string",
        "port": integer
      },
      "mtu": integer,
      "name": "string",
      "status": "created"|"creating"|"deleted"|"deleting"|"failed"
    },
    "securityDetails": {
      "roleArn": "string",
      "securityGroupIds": ["string", ...],
      "subnetIds": ["string", ...]
    }
  }
  ...
]

--tags (map)

Tags of a 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.

--cli-auto-prompt (boolean) Automatically prompt for CLI input parameters.

See ‘aws help’ for descriptions of global parameters.

Output

dataflowEndpointGroupId -> (string)

UUID of a dataflow endpoint group.