configs

Creates, updates, deletes or gets a config resource or lists configs in a region

Overview

Name	configs
Type	Resource
Description	AWS Ground Station config resource type for CloudFormation.
Id	aws.groundstation.configs

Fields

Name	Datatype	Description
name	string
tags	array
type	string
config_data	object
arn	string
id	string
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	Name, ConfigData, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all configs in a region.

SELECT
region,
name,
tags,
type,
config_data,
arn,
id
FROM aws.groundstation.configs
WHERE region = 'us-east-1';

Gets all properties from an individual config.

SELECT
region,
name,
tags,
type,
config_data,
arn,
id
FROM aws.groundstation.configs
WHERE region = 'us-east-1' AND data__Identifier = '<Arn>';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO aws.groundstation.configs (
 Name,
 ConfigData,
 region
)
SELECT 
'{{ Name }}',
 '{{ ConfigData }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.groundstation.configs (
 Name,
 Tags,
 ConfigData,
 region
)
SELECT 
 '{{ Name }}',
 '{{ Tags }}',
 '{{ ConfigData }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: config
    props:
      - name: Name
        value: '{{ Name }}'
      - name: Tags
        value:
          - Key: '{{ Key }}'
            Value: '{{ Value }}'
      - name: ConfigData
        value:
          AntennaDownlinkConfig:
            SpectrumConfig:
              CenterFrequency:
                Value: null
                Units: '{{ Units }}'
              Bandwidth:
                Value: null
                Units: '{{ Units }}'
              Polarization: '{{ Polarization }}'
          TrackingConfig:
            Autotrack: '{{ Autotrack }}'
          DataflowEndpointConfig:
            DataflowEndpointName: '{{ DataflowEndpointName }}'
            DataflowEndpointRegion: '{{ DataflowEndpointRegion }}'
          AntennaDownlinkDemodDecodeConfig:
            SpectrumConfig: null
            DemodulationConfig:
              UnvalidatedJSON: '{{ UnvalidatedJSON }}'
            DecodeConfig:
              UnvalidatedJSON: null
          AntennaUplinkConfig:
            SpectrumConfig:
              CenterFrequency: null
              Polarization: null
            TargetEirp:
              Value: null
              Units: '{{ Units }}'
            TransmitDisabled: '{{ TransmitDisabled }}'
          UplinkEchoConfig:
            Enabled: '{{ Enabled }}'
            AntennaUplinkConfigArn: '{{ AntennaUplinkConfigArn }}'
          S3RecordingConfig:
            BucketArn: '{{ BucketArn }}'
            RoleArn: '{{ RoleArn }}'
            Prefix: '{{ Prefix }}'

DELETE example

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

Permissions

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

Create

groundstation:CreateConfig,
groundstation:TagResource,
iam:PassRole

Read

groundstation:GetConfig,
groundstation:ListTagsForResource

Update

groundstation:UpdateConfig,
groundstation:ListTagsForResource,
groundstation:TagResource,
groundstation:UntagResource,
iam:PassRole

Delete

groundstation:DeleteConfig

List

groundstation:ListConfigs