AWS::GroundStation::Config S3RecordingConfig - AWS CloudFormation
SyntaxPropertiesExamples

AWS::GroundStation::Config S3RecordingConfig

Provides information about how AWS Ground Station should save downlink data to S3.

Syntax

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

JSON

{
  "BucketArn" : String,
  "Prefix" : String,
  "RoleArn" : String
}

YAML

  BucketArn: String
  Prefix: String
  RoleArn: String

Properties

BucketArn

S3 Bucket where the data is written. The name of the S3 Bucket provided must begin with aws-groundstation.

Required: No

Type: String

Pattern: ^arn:aws[A-Za-z0-9-]{0,64}:s3:::[A-Za-z0-9-]{1,64}$

Update requires: No interruption

Prefix

The prefix of the S3 data object. If you choose to use any optional keys for substitution, these values will be replaced with the corresponding information from your contact details. For example, a prefix of {satellite_id}/{year}/{month}/{day}/ will replaced with fake_satellite_id/2021/01/10/

Optional keys for substitution: {satellite_id} | {config-name} | {config-id} | {year} | {month} | {day}

Required: No

Type: String

Pattern: ^([a-zA-Z0-9_\-=/]|\{satellite_id\}|\{config\-name}|\{s3\-config-id}|\{year\}|\{month\}|\{day\}){1,900}$

Update requires: No interruption

RoleArn

Defines the ARN of the role assumed for putting archives to S3.

Required: No

Type: String

Pattern: ^arn:[^:\n]+:iam::[^:\n]+:role\/.+$

Update requires: No interruption

Examples

Create an S3RecordingConfig

The following example creates a Ground Station S3RecordingConfig

JSON

{
    "S3RecordingConfig": {
      "BucketArn": "arn:aws:s3:us-west-2:123456789012:bucket-name",
      "Prefix": "{satellite_id}/{config-name}_{config-id}/{year}/{month}/{day}",
      "RoleArn": "arn:aws:iam::123456789012:role/BucketRole"
    }
}

YAML

S3RecordingConfig:
    BucketArn: arn:aws:s3:us-west-2:123456789012:bucket-name
    Prefix: {satellite_id}/{config-name}_{config-id}/{year}/{month}/{day}
    RoleArn: arn:aws:iam::123456789012:role/BucketRole