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

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	configs	INSERT	Name, ConfigData, region
delete_resource	configs	DELETE	Identifier, region
update_resource	configs	UPDATE	Identifier, PatchDocument, region
list_resources	configs_list_only	SELECT	region
get_resource	configs	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual config.

SELECT
  region,
  name,
  tags,
  type,
  config_data,
  arn,
  id
FROM awscc.groundstation.configs
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}';

list (identifiers only)

Lists all configs in a region.

SELECT
  region,
  arn
FROM awscc.groundstation.configs_list_only
WHERE
  region = '{{ region }}';

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.groundstation.configs (
  Name,
  ConfigData,
  region
)
SELECT
  '{{ name }}',
  '{{ config_data }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.groundstation.configs (
  Name,
  Tags,
  ConfigData,
  region
)
SELECT
  '{{ name }}',
  '{{ tags }}',
  '{{ config_data }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: config_data
      value:
        antenna_downlink_config:
          spectrum_config:
            center_frequency:
              value: null
              units: '{{ units }}'
            bandwidth:
              value: null
              units: '{{ units }}'
            polarization: '{{ polarization }}'
        tracking_config:
          autotrack: '{{ autotrack }}'
        dataflow_endpoint_config:
          dataflow_endpoint_name: '{{ dataflow_endpoint_name }}'
          dataflow_endpoint_region: '{{ dataflow_endpoint_region }}'
        antenna_downlink_demod_decode_config:
          spectrum_config: null
          demodulation_config:
            unvalidated_js_on: '{{ unvalidated_js_on }}'
          decode_config:
            unvalidated_js_on: null
        antenna_uplink_config:
          spectrum_config:
            center_frequency: null
            polarization: null
          target_eirp:
            value: null
            units: '{{ units }}'
          transmit_disabled: '{{ transmit_disabled }}'
        uplink_echo_config:
          enabled: '{{ enabled }}'
          antenna_uplink_config_arn: '{{ antenna_uplink_config_arn }}'
        s3_recording_config:
          bucket_arn: '{{ bucket_arn }}'
          role_arn: '{{ role_arn }}'
          prefix: '{{ prefix }}'

UPDATE example

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

/*+ update */
UPDATE awscc.groundstation.configs
SET PatchDocument = string('{{ {
    "Name": name,
    "Tags": tags,
    "ConfigData": config_data
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.groundstation.configs
WHERE
  Identifier = '{{ arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

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