dataflow_endpoint_groups

Creates, updates, deletes or gets a dataflow_endpoint_group resource or lists dataflow_endpoint_groups in a region

Overview

Name	dataflow_endpoint_groups
Type	Resource
Description	AWS Ground Station DataflowEndpointGroup schema for CloudFormation
Id	aws.groundstation.dataflow_endpoint_groups

Fields

Name	Datatype	Description
id	string
arn	string
endpoint_details	array
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.
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.
tags	array
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	EndpointDetails, region
delete_resource	DELETE	data__Identifier, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all dataflow_endpoint_groups in a region.

SELECT
region,
id,
arn,
endpoint_details,
contact_pre_pass_duration_seconds,
contact_post_pass_duration_seconds,
tags
FROM aws.groundstation.dataflow_endpoint_groups
WHERE region = 'us-east-1';

Gets all properties from an individual dataflow_endpoint_group.

SELECT
region,
id,
arn,
endpoint_details,
contact_pre_pass_duration_seconds,
contact_post_pass_duration_seconds,
tags
FROM aws.groundstation.dataflow_endpoint_groups
WHERE region = 'us-east-1' AND data__Identifier = '<Id>';

INSERT example

Use the following StackQL query and manifest file to create a new dataflow_endpoint_group resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.groundstation.dataflow_endpoint_groups (
 EndpointDetails,
 region
)
SELECT 
'{{ EndpointDetails }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.groundstation.dataflow_endpoint_groups (
 EndpointDetails,
 ContactPrePassDurationSeconds,
 ContactPostPassDurationSeconds,
 Tags,
 region
)
SELECT 
 '{{ EndpointDetails }}',
 '{{ ContactPrePassDurationSeconds }}',
 '{{ ContactPostPassDurationSeconds }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: dataflow_endpoint_group
    props:
      - name: EndpointDetails
        value:
          - SecurityDetails:
              SubnetIds:
                - '{{ SubnetIds[0] }}'
              SecurityGroupIds:
                - '{{ SecurityGroupIds[0] }}'
              RoleArn: '{{ RoleArn }}'
            Endpoint:
              Name: '{{ Name }}'
              Address:
                Name: '{{ Name }}'
                Port: '{{ Port }}'
              Mtu: '{{ Mtu }}'
            AwsGroundStationAgentEndpoint:
              Name: '{{ Name }}'
              EgressAddress:
                SocketAddress: null
                Mtu: '{{ Mtu }}'
              IngressAddress:
                SocketAddress:
                  Name: '{{ Name }}'
                  PortRange:
                    Minimum: '{{ Minimum }}'
                    Maximum: '{{ Maximum }}'
                Mtu: '{{ Mtu }}'
              AgentStatus: '{{ AgentStatus }}'
              AuditResults: '{{ AuditResults }}'
      - name: ContactPrePassDurationSeconds
        value: '{{ ContactPrePassDurationSeconds }}'
      - name: ContactPostPassDurationSeconds
        value: '{{ ContactPostPassDurationSeconds }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'

DELETE example

/*+ delete */
DELETE FROM aws.groundstation.dataflow_endpoint_groups
WHERE data__Identifier = '<Id>'
AND region = 'us-east-1';

Permissions

To operate on the dataflow_endpoint_groups resource, the following permissions are required:

Create

groundstation:CreateDataflowEndpointGroup,
groundstation:GetDataflowEndpointGroup,
groundstation:TagResource,
iam:PassRole,
ec2:describeAddresses,
ec2:describeNetworkInterfaces,
iam:createServiceLinkedRole

Read

groundstation:GetDataflowEndpointGroup,
groundstation:ListTagsForResource

Delete

groundstation:DeleteDataflowEndpointGroup,
groundstation:GetDataflowEndpointGroup

List

groundstation:ListDataflowEndpointGroups