dataflow_endpoint_groups

Creates, updates, deletes, gets or lists a dataflow_endpoint_groups resource.

Overview

Name	dataflow_endpoint_groups
Type	Resource
Id	aws.groundstation.dataflow_endpoint_groups

Fields

The following fields are returned by SELECT queries:

get_dataflow_endpoint_group

Name	Datatype	Description
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.
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.
dataflow_endpoint_group_arn	string	ARN of a dataflow endpoint group. (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:dataflow-endpoint-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
dataflow_endpoint_group_id	string	UUID of a dataflow endpoint group. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
endpoints_details	array	Details of a dataflow endpoint.
tags	object	Tags assigned to a dataflow endpoint group.

list_dataflow_endpoint_groups

Name	Datatype	Description
dataflow_endpoint_group_arn	string	ARN of a dataflow endpoint group. (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:dataflow-endpoint-group/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)
dataflow_endpoint_group_id	string	UUID of a dataflow endpoint group. (pattern: <code>[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}</code>)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_dataflow_endpoint_group	select	dataflow_endpoint_group_id, region		Returns the dataflow endpoint group.
list_dataflow_endpoint_groups	select	region	maxResults, nextToken	Returns a list of DataflowEndpoint groups.
create_dataflow_endpoint_group	insert	region, endpointDetails		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.
create_dataflow_endpoint_group_v2	insert	region, endpoints		Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints. 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.
delete_dataflow_endpoint_group	delete	dataflow_endpoint_group_id, region		Deletes a dataflow endpoint group.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
dataflow_endpoint_group_id	string	UUID of a dataflow endpoint group.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of dataflow endpoint groups returned.
nextToken	string	Next token returned in the request of a previous ListDataflowEndpointGroups call. Used to get the next page of results.

SELECT examples

get_dataflow_endpoint_group

Returns the dataflow endpoint group.

SELECT
contact_post_pass_duration_seconds,
contact_pre_pass_duration_seconds,
dataflow_endpoint_group_arn,
dataflow_endpoint_group_id,
endpoints_details,
tags
FROM aws.groundstation.dataflow_endpoint_groups
WHERE dataflow_endpoint_group_id = '{{ dataflow_endpoint_group_id }}' -- required
AND region = '{{ region }}' -- required
;

list_dataflow_endpoint_groups

Returns a list of DataflowEndpoint groups.

SELECT
dataflow_endpoint_group_arn,
dataflow_endpoint_group_id
FROM aws.groundstation.dataflow_endpoint_groups
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_dataflow_endpoint_group

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.

INSERT INTO aws.groundstation.dataflow_endpoint_groups (
endpointDetails,
tags,
contactPrePassDurationSeconds,
contactPostPassDurationSeconds,
region
)
SELECT 
'{{ endpointDetails }}' /* required */,
'{{ tags }}',
{{ contactPrePassDurationSeconds }},
{{ contactPostPassDurationSeconds }},
'{{ region }}'
RETURNING
dataflow_endpoint_group_id
;

create_dataflow_endpoint_group_v2

Creates a DataflowEndpoint group containing the specified list of Ground Station Agent based endpoints. 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.

INSERT INTO aws.groundstation.dataflow_endpoint_groups (
endpoints,
contactPrePassDurationSeconds,
contactPostPassDurationSeconds,
tags,
region
)
SELECT 
'{{ endpoints }}' /* required */,
{{ contactPrePassDurationSeconds }},
{{ contactPostPassDurationSeconds }},
'{{ tags }}',
'{{ region }}'
RETURNING
dataflow_endpoint_group_id
;

Manifest

# Description fields are for documentation purposes
- name: dataflow_endpoint_groups
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the dataflow_endpoint_groups resource.
  - name: endpointDetails
    value:
      - securityDetails:
          subnetIds:
            - "{{ subnetIds }}"
          securityGroupIds:
            - "{{ securityGroupIds }}"
          roleArn: "{{ roleArn }}"
        endpoint:
          name: "{{ name }}"
          address:
            name: "{{ name }}"
            port: {{ port }}
          status: "{{ status }}"
          mtu: {{ mtu }}
        awsGroundStationAgentEndpoint:
          name: "{{ name }}"
          egressAddress:
            socketAddress:
              name: "{{ name }}"
              port: {{ port }}
            mtu: {{ mtu }}
          ingressAddress:
            socketAddress:
              name: "{{ name }}"
              portRange:
                minimum_: {{ minimum_ }}
                maximum_: {{ maximum_ }}
            mtu: {{ mtu }}
          agentStatus: "{{ agentStatus }}"
          auditResults: "{{ auditResults }}"
        uplinkAwsGroundStationAgentEndpoint:
          name: "{{ name }}"
          dataflowDetails:
            agentConnectionDetails:
              ingressAddressAndPort:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
              agentIpAndPortAddress:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
          agentStatus: "{{ agentStatus }}"
          auditResults: "{{ auditResults }}"
        downlinkAwsGroundStationAgentEndpoint:
          name: "{{ name }}"
          dataflowDetails:
            agentConnectionDetails:
              agentIpAndPortAddress:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
              egressAddressAndPort:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
          agentStatus: "{{ agentStatus }}"
          auditResults: "{{ auditResults }}"
        healthStatus: "{{ healthStatus }}"
        healthReasons: "{{ healthReasons }}"
  - name: tags
    value: "{{ tags }}"
  - name: contactPrePassDurationSeconds
    value: {{ contactPrePassDurationSeconds }}
  - name: contactPostPassDurationSeconds
    value: {{ contactPostPassDurationSeconds }}
  - name: endpoints
    value:
      - uplinkAwsGroundStationAgentEndpoint:
          name: "{{ name }}"
          dataflowDetails:
            agentConnectionDetails:
              ingressAddressAndPort:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
              agentIpAndPortAddress:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
        downlinkAwsGroundStationAgentEndpoint:
          name: "{{ name }}"
          dataflowDetails:
            agentConnectionDetails:
              agentIpAndPortAddress:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}
              egressAddressAndPort:
                socketAddress: "{{ socketAddress }}"
                mtu: {{ mtu }}

DELETE examples

delete_dataflow_endpoint_group

Deletes a dataflow endpoint group.

DELETE FROM aws.groundstation.dataflow_endpoint_groups
WHERE dataflow_endpoint_group_id = '{{ dataflow_endpoint_group_id }}' --required
AND region = '{{ region }}' --required
;