mission_profiles

Creates, updates, deletes or gets a mission_profile resource or lists mission_profiles in a region

Overview

Name	mission_profiles
Type	Resource
Description	AWS Ground Station Mission Profile resource type for CloudFormation.
Id	awscc.groundstation.mission_profiles

Fields

get (all properties)

Name	Datatype	Description
name	string	A name used to identify a mission profile.
contact_pre_pass_duration_seconds	integer	Pre-pass time needed before the contact.
contact_post_pass_duration_seconds	integer	Post-pass time needed after the contact.
minimum_viable_contact_duration_seconds	integer	Visibilities with shorter duration than the specified minimum viable contact duration will be ignored when searching for available contacts.
▶streams_kms_key	object	The ARN of a KMS Key used for encrypting data during transmission from the source to destination locations.
streams_kms_role	string	The ARN of the KMS Key or Alias Key role used to define permissions on KMS Key usage.
▶dataflow_edges	array
tracking_config_arn	string
▶tags	array
id	string
arn	string
region	string
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
id	string
arn	string
region	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	mission_profiles	INSERT	Name, MinimumViableContactDurationSeconds, DataflowEdges, TrackingConfigArn, region
delete_resource	mission_profiles	DELETE	Identifier, region
update_resource	mission_profiles	UPDATE	Identifier, PatchDocument, region
list_resources	mission_profiles_list_only	SELECT	region
get_resource	mission_profiles	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual mission_profile.

SELECT
  region,
  name,
  contact_pre_pass_duration_seconds,
  contact_post_pass_duration_seconds,
  minimum_viable_contact_duration_seconds,
  streams_kms_key,
  streams_kms_role,
  dataflow_edges,
  tracking_config_arn,
  tags,
  id,
  arn,
  region
FROM awscc.groundstation.mission_profiles
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}|{{ arn }}';

list (identifiers only)

Lists all mission_profiles in a region.

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

INSERT example

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

Required Properties

/*+ create */
INSERT INTO awscc.groundstation.mission_profiles (
  Name,
  MinimumViableContactDurationSeconds,
  DataflowEdges,
  TrackingConfigArn,
  region
)
SELECT
  '{{ name }}',
  '{{ minimum_viable_contact_duration_seconds }}',
  '{{ dataflow_edges }}',
  '{{ tracking_config_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.groundstation.mission_profiles (
  Name,
  ContactPrePassDurationSeconds,
  ContactPostPassDurationSeconds,
  MinimumViableContactDurationSeconds,
  StreamsKmsKey,
  StreamsKmsRole,
  DataflowEdges,
  TrackingConfigArn,
  Tags,
  region
)
SELECT
  '{{ name }}',
  '{{ contact_pre_pass_duration_seconds }}',
  '{{ contact_post_pass_duration_seconds }}',
  '{{ minimum_viable_contact_duration_seconds }}',
  '{{ streams_kms_key }}',
  '{{ streams_kms_role }}',
  '{{ dataflow_edges }}',
  '{{ tracking_config_arn }}',
  '{{ tags }}',
  '{{ 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: mission_profile
  props:
    - name: name
      value: '{{ name }}'
    - 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: minimum_viable_contact_duration_seconds
      value: '{{ minimum_viable_contact_duration_seconds }}'
    - name: streams_kms_key
      value:
        kms_key_arn: '{{ kms_key_arn }}'
        kms_alias_arn: '{{ kms_alias_arn }}'
        kms_alias_name: '{{ kms_alias_name }}'
    - name: streams_kms_role
      value: '{{ streams_kms_role }}'
    - name: dataflow_edges
      value:
        - source: '{{ source }}'
          destination: '{{ destination }}'
    - name: tracking_config_arn
      value: '{{ tracking_config_arn }}'
    - name: tags
      value:
        - key: '{{ key }}'
          value: '{{ value }}'

UPDATE example

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

/*+ update */
UPDATE awscc.groundstation.mission_profiles
SET PatchDocument = string('{{ {
    "Name": name,
    "ContactPrePassDurationSeconds": contact_pre_pass_duration_seconds,
    "ContactPostPassDurationSeconds": contact_post_pass_duration_seconds,
    "MinimumViableContactDurationSeconds": minimum_viable_contact_duration_seconds,
    "StreamsKmsKey": streams_kms_key,
    "StreamsKmsRole": streams_kms_role,
    "DataflowEdges": dataflow_edges,
    "TrackingConfigArn": tracking_config_arn,
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ id }}|{{ arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.groundstation.mission_profiles
WHERE
  Identifier = '{{ id }}|{{ 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 mission_profiles resource, the following permissions are required:

Create

groundstation:CreateMissionProfile,
groundstation:GetMissionProfile,
groundstation:TagResource,
iam:PassRole,
kms:DescribeKey,
kms:CreateGrant

Read

groundstation:GetMissionProfile,
groundstation:ListTagsForResource,
kms:DescribeKey,
kms:CreateGrant

Update

groundstation:UpdateMissionProfile,
groundstation:GetMissionProfile,
groundstation:ListTagsForResource,
groundstation:TagResource,
groundstation:UntagResource,
iam:PassRole,
kms:DescribeKey,
kms:CreateGrant

Delete

groundstation:DeleteMissionProfile,
groundstation:GetMissionProfile

List

groundstation:ListMissionProfiles