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	awscc.groundstation.dataflow_endpoint_groups

Fields

get (all properties)

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.

list (identifiers only)

Name	Datatype	Description
id	string
region	string	AWS region.

For more information, see AWS::GroundStation::DataflowEndpointGroup.

Methods

Name	Resource	Accessible by	Required Params
create_resource	dataflow_endpoint_groups	INSERT	EndpointDetails, region
delete_resource	dataflow_endpoint_groups	DELETE	Identifier, region
update_resource	dataflow_endpoint_groups	UPDATE	Identifier, PatchDocument, region
list_resources	dataflow_endpoint_groups_list_only	SELECT	region
get_resource	dataflow_endpoint_groups	SELECT	Identifier, region

SELECT examples

get (all properties)

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 awscc.groundstation.dataflow_endpoint_groups
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ id }}';

list (identifiers only)

Lists all dataflow_endpoint_groups in a region.

SELECT
  region,
  id
FROM awscc.groundstation.dataflow_endpoint_groups_list_only
WHERE
  region = 'us-east-1';

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 awscc.groundstation.dataflow_endpoint_groups (
  EndpointDetails,
  region
)
SELECT
  '{{ endpoint_details }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.groundstation.dataflow_endpoint_groups (
  EndpointDetails,
  ContactPrePassDurationSeconds,
  ContactPostPassDurationSeconds,
  Tags,
  region
)
SELECT
  '{{ endpoint_details }}',
  '{{ contact_pre_pass_duration_seconds }}',
  '{{ contact_post_pass_duration_seconds }}',
  '{{ 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: endpoint_details
        value:
          - security_details:
              subnet_ids:
                - '{{ subnet_ids[0] }}'
              security_group_ids:
                - '{{ security_group_ids[0] }}'
              role_arn: '{{ role_arn }}'
            endpoint:
              name: '{{ name }}'
              address:
                name: '{{ name }}'
                port: '{{ port }}'
              mtu: '{{ mtu }}'
            aws_ground_station_agent_endpoint:
              name: '{{ name }}'
              egress_address:
                socket_address: null
                mtu: '{{ mtu }}'
              ingress_address:
                socket_address:
                  name: '{{ name }}'
                  port_range:
                    minimum: '{{ minimum }}'
                    maximum: '{{ maximum }}'
                mtu: '{{ mtu }}'
              agent_status: '{{ agent_status }}'
              audit_results: '{{ audit_results }}'
      - name: contact_pre_pass_duration_seconds
        value: '{{ contact_pre_pass_duration_seconds }}'
      - name: contact_post_pass_duration_seconds
        value: '{{ contact_post_pass_duration_seconds }}'
      - name: tags
        value:
          - key: '{{ key }}'
            value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.groundstation.dataflow_endpoint_groups
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}';

DELETE example

/*+ delete */
DELETE FROM awscc.groundstation.dataflow_endpoint_groups
WHERE
  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

Update

groundstation:ListTagsForResource,
groundstation:TagResource,
groundstation:UntagResource

Read

groundstation:GetDataflowEndpointGroup,
groundstation:ListTagsForResource

Delete

groundstation:DeleteDataflowEndpointGroup,
groundstation:GetDataflowEndpointGroup

List

groundstation:ListDataflowEndpointGroups