configs

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

Overview

Name	configs
Type	Resource
Id	aws.groundstation.configs

Fields

The following fields are returned by SELECT queries:

get_config

Name	Datatype	Description
name	string	Name of a Config.
config_arn	string	ARN of a Config (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?</code>)
config_data	object	Object containing the parameters of a Config. See the subtype definitions for what each type of Config contains.
config_id	string	UUID of a Config.
config_type	string	Type of a Config. (antenna-downlink, antenna-downlink-demod-decode, tracking, dataflow-endpoint, antenna-uplink, uplink-echo, s3-recording, telemetry-sink)
tags	object	Tags assigned to a Config.

list_configs

Name	Datatype	Description
name	string	Name of a Config.
config_arn	string	ARN of a Config. (pattern: <code>arn:aws:groundstation:[-a-z0-9]{1,50}:[0-9]{12}:config/[a-z0-9]+(-[a-z0-9]+){0,4}/[a-f0-9]{8}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{4}-[a-f0-9]{12}(/.{1,256})?</code>)
config_id	string	UUID of a Config.
config_type	string	Type of a Config. (antenna-downlink, antenna-downlink-demod-decode, tracking, dataflow-endpoint, antenna-uplink, uplink-echo, s3-recording, telemetry-sink)

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_config	select	config_id, config_type, region		Returns Config information. Only one Config response can be returned.
list_configs	select	region	maxResults, nextToken	Returns a list of Config objects.
create_config	insert	region, name, configData		Creates a Config with the specified configData parameters. Only one type of configData can be specified.
update_config	update	config_id, config_type, region, name, configData		Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.
delete_config	delete	config_id, config_type, region		Deletes a Config.

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
config_id	string	UUID of a Config.
config_type	string	Type of a Config.
region	string	AWS region (default: us-east-1)
maxResults	integer	Maximum number of Configs returned.
nextToken	string	Next token returned in the request of a previous ListConfigs call. Used to get the next page of results.

SELECT examples

get_config

Returns Config information. Only one Config response can be returned.

SELECT
name,
config_arn,
config_data,
config_id,
config_type,
tags
FROM aws.groundstation.configs
WHERE config_id = '{{ config_id }}' -- required
AND config_type = '{{ config_type }}' -- required
AND region = '{{ region }}' -- required
;

list_configs

Returns a list of Config objects.

SELECT
name,
config_arn,
config_id,
config_type
FROM aws.groundstation.configs
WHERE region = '{{ region }}' -- required
AND maxResults = '{{ maxResults }}'
AND nextToken = '{{ nextToken }}'
;

INSERT examples

create_config

Creates a Config with the specified configData parameters. Only one type of configData can be specified.

INSERT INTO aws.groundstation.configs (
name,
configData,
tags,
region
)
SELECT 
'{{ name }}' /* required */,
'{{ configData }}' /* required */,
'{{ tags }}',
'{{ region }}'
RETURNING
config_arn,
config_id,
config_type
;

Manifest

# Description fields are for documentation purposes
- name: configs
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the configs resource.
  - name: name
    value: "{{ name }}"
  - name: configData
    description: |
      Object containing the parameters of a Config. See the subtype definitions for what each type of Config contains.
    value:
      antennaDownlinkConfig:
        spectrumConfig:
          centerFrequency:
            value: {{ value }}
            units: "{{ units }}"
          bandwidth:
            value: {{ value }}
            units: "{{ units }}"
          polarization: "{{ polarization }}"
      trackingConfig:
        autotrack: "{{ autotrack }}"
      dataflowEndpointConfig:
        dataflowEndpointName: "{{ dataflowEndpointName }}"
        dataflowEndpointRegion: "{{ dataflowEndpointRegion }}"
      antennaDownlinkDemodDecodeConfig:
        spectrumConfig:
          centerFrequency:
            value: {{ value }}
            units: "{{ units }}"
          bandwidth:
            value: {{ value }}
            units: "{{ units }}"
          polarization: "{{ polarization }}"
        demodulationConfig:
          unvalidatedJSON: "{{ unvalidatedJSON }}"
        decodeConfig:
          unvalidatedJSON: "{{ unvalidatedJSON }}"
      antennaUplinkConfig:
        transmitDisabled: {{ transmitDisabled }}
        spectrumConfig:
          centerFrequency:
            value: {{ value }}
            units: "{{ units }}"
          polarization: "{{ polarization }}"
        targetEirp:
          value: {{ value }}
          units: "{{ units }}"
      uplinkEchoConfig:
        enabled: {{ enabled }}
        antennaUplinkConfigArn: "{{ antennaUplinkConfigArn }}"
      s3RecordingConfig:
        bucketArn: "{{ bucketArn }}"
        roleArn: "{{ roleArn }}"
        prefix: "{{ prefix }}"
      telemetrySinkConfig:
        telemetrySinkType: "{{ telemetrySinkType }}"
        telemetrySinkData:
          kinesisDataStreamData:
            kinesisRoleArn: "{{ kinesisRoleArn }}"
            kinesisDataStreamArn: "{{ kinesisDataStreamArn }}"
  - name: tags
    value: "{{ tags }}"

UPDATE examples

update_config

Updates the Config used when scheduling contacts. Updating a Config will not update the execution parameters for existing future contacts scheduled with this Config.

UPDATE aws.groundstation.configs
SET 
name = '{{ name }}',
configData = '{{ configData }}'
WHERE 
config_id = '{{ config_id }}' --required
AND config_type = '{{ config_type }}' --required
AND region = '{{ region }}' --required
AND name = '{{ name }}' --required
AND configData = '{{ configData }}' --required
RETURNING
config_arn,
config_id,
config_type;

DELETE examples

delete_config

Deletes a Config.

DELETE FROM aws.groundstation.configs
WHERE config_id = '{{ config_id }}' --required
AND config_type = '{{ config_type }}' --required
AND region = '{{ region }}' --required
;