AWS::GroundStation::MissionProfile - AWS CloudFormation
SyntaxPropertiesReturn valuesExamples

AWS::GroundStation::MissionProfile

Mission profiles specify parameters and provide references to config objects to define how Ground Station lists and executes contacts.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "Type" : "AWS::GroundStation::MissionProfile",
  "Properties" : {
      "ContactPostPassDurationSeconds" : Integer,
      "ContactPrePassDurationSeconds" : Integer,
      "DataflowEdges" : [ DataflowEdge, ... ],
      "MinimumViableContactDurationSeconds" : Integer,
      "Name" : String,
      "StreamsKmsKey" : StreamsKmsKey,
      "StreamsKmsRole" : String,
      "Tags" : [ Tag, ... ],
      "TrackingConfigArn" : String
    }
}

YAML

Type: AWS::GroundStation::MissionProfile
Properties:
  ContactPostPassDurationSeconds: Integer
  ContactPrePassDurationSeconds: Integer
  DataflowEdges: 
    - DataflowEdge
  MinimumViableContactDurationSeconds: Integer
  Name: String
  StreamsKmsKey: 
    StreamsKmsKey
  StreamsKmsRole: String
  Tags: 
    - Tag
  TrackingConfigArn: String

Properties

ContactPostPassDurationSeconds

Amount of time in seconds after a contact ends that you’d like to receive a Ground Station Contact State Change indicating the pass has finished.

Required: No

Type: Integer

Minimum: 0

Maximum: 21600

Update requires: No interruption

ContactPrePassDurationSeconds

Amount of time in seconds prior to contact start that you'd like to receive a Ground Station Contact State Change Event indicating an upcoming pass.

Required: No

Type: Integer

Minimum: 0

Maximum: 21600

Update requires: No interruption

DataflowEdges

A list containing lists of config ARNs. Each list of config ARNs is an edge, with a "from" config and a "to" config.

Required: Yes

Type: Array of DataflowEdge

Minimum: 1

Update requires: No interruption

MinimumViableContactDurationSeconds

Minimum length of a contact in seconds that Ground Station will return when listing contacts. Ground Station will not return contacts shorter than this duration.

Required: Yes

Type: Integer

Minimum: 1

Maximum: 21600

Update requires: No interruption

Name

The name of the mission profile.

Required: Yes

Type: String

Pattern: ^[ a-zA-Z0-9_:-]{1,256}$

Update requires: No interruption

StreamsKmsKey

KMS key to use for encrypting streams.

Required: No

Type: StreamsKmsKey

Update requires: No interruption

StreamsKmsRole

Role to use for encrypting streams with KMS key.

Required: No

Type: String

Update requires: No interruption

Tags

Tags assigned to the mission profile.

Required: No

Type: Array of Tag

Update requires: No interruption

TrackingConfigArn

The ARN of a tracking config objects that defines how to track the satellite through the sky during a contact.

Required: Yes

Type: String

Pattern: ^(arn:(aws[a-zA-Z-]*)?:[a-z0-9-.]+:.*)|()$

Update requires: No interruption

Return values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the ARN of the mission profile. For example:

{ "Ref": "MissionProfile" }

Ref returns the ARN of the mission profile.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

Arn

The ARN of the mission profile, such as arn:aws:groundstation:us-east-2:1234567890:mission-profile/9940bf3b-d2ba-427e-9906-842b5e5d2296.

Id

The ID of the mission profile, such as 9940bf3b-d2ba-427e-9906-842b5e5d2296.

Region

The region of the mission profile.

Examples

Mission Profile With Downlink And Uplink

The following example shows how to create a mission profile that utilizes both downlink and uplink during a contact.

The resulting mission profile will have a name of My Mission Profile. CloudWatch Events will be sent 120 seconds before the contact starts and 180 seconds after the contact completes. No contacts less than 300 seconds in duration will be returned when listing available contacts with this mission profile selected.

The satellite will be tracked as it moves through the sky using the method specified by the referenced tracking config.

The first dataflow edge in the list shows how to specify dataflow for a downlink contact. Data is delivered from the antenna to a dataflow endpoint. More specifically, data is flowed:

  • From the antenna using the parameters defined in this antenna downlink config:

    • arn:aws:groundstation:us-east-2:1234567890:config/antenna-downlink/11111111-1111-1111-1111-111111111111

  • To the dataflow endpoint defined in this dataflow endpoint config:

    • arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/22222222-2222-2222-2222-222222222222

The second dataflow edge in the list shows how to specify dataflow for an uplink contact. Data is delivered from a dataflow endpoint to the antenna for transmission to a satellite. More specifically, data is flowed:

  • From the dataflow endpoint defined in this dataflow endpoint config:

    • arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/33333333-3333-3333-3333-333333333333

  • To the antenna using the parameters defined in this antenna uplink config:

    • arn:aws:groundstation:us-east-2:1234567890:config/antenna-uplink/44444444-4444-4444-4444-444444444444

JSON


{
  "Resources": {
    "MyMissionProfile": {
      "Type": "AWS::GroundStation::MissionProfile",
      "Properties": {
        "Name": "My Mission Profile",
        "ContactPrePassDurationSeconds": 120,
        "ContactPostPassDurationSeconds": 180,
        "MinimumViableContactDurationSeconds": 300,
        "TrackingConfigArn": "arn:aws:groundstation:us-east-2:1234567890:config/tracking/00000000-0000-0000-0000-000000000000",
        "DataflowEdges": [
          {
            "Source": "arn:aws:groundstation:us-east-2:1234567890:config/antenna-downlink/11111111-1111-1111-1111-111111111111",
            "Destination": "arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/22222222-2222-2222-2222-222222222222"
          },
          {
            "Source": "arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/33333333-3333-3333-3333-333333333333",
            "Destination": "arn:aws:groundstation:us-east-2:1234567890:config/antenna-uplink/44444444-4444-4444-4444-444444444444"
          }
        ]
      }
    }
  }
}

YAML


Resources:
  MyMissionProfile:
    Type: AWS::GroundStation::MissionProfile
    Properties:
      Name: "Mission Profile"
      ContactPrePassDurationSeconds: 120
      ContactPostPassDurationSeconds: 180
      MinimumViableContactDurationSeconds: 300
      TrackingConfigArn: arn:aws:groundstation:us-east-2:1234567890:config/tracking/00000000-0000-0000-0000-000000000000
      DataflowEdges:
        - Source: arn:aws:groundstation:us-east-2:1234567890:config/antenna-downlink/11111111-1111-1111-1111-111111111111
          Destination: arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/22222222-2222-2222-2222-222222222222
        - Source: arn:aws:groundstation:us-east-2:1234567890:config/dataflow-endpoint/33333333-3333-3333-3333-333333333333
          Destination: arn:aws:groundstation:us-east-2:1234567890:config/antenna-uplink/44444444-4444-4444-4444-444444444444