AWS::GroundStation::Config KinesisDataStreamData - AWS CloudFormation
SyntaxPropertiesExamples

This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.

AWS::GroundStation::Config KinesisDataStreamData

Defines the configuration for delivering telemetry to an Amazon Kinesis Data Stream.

Syntax

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

JSON

{
  "KinesisDataStreamArn" : String,
  "KinesisRoleArn" : String
}

YAML

  KinesisDataStreamArn: String
  KinesisRoleArn: String

Properties

KinesisDataStreamArn

The ARN of the Amazon Kinesis Data Stream where telemetry data will be delivered, such as arn:aws:kinesis:us-east-2:123456789012:stream/my-telemetry-stream.

Required: Yes

Type: String

Pattern: ^arn:[a-z0-9-.]{1,63}:kinesis:[-a-z0-9]{1,50}:[0-9]{12}:stream/[a-zA-Z0-9_.-]{1,128}$

Update requires: No interruption

KinesisRoleArn

The ARN of an IAM role that AWS Ground Station assumes to write telemetry data to the Kinesis Data Stream. This role must have permissions to perform kinesis:PutRecord, kinesis:PutRecords, and kinesis:DescribeStream actions on the specified stream.

Required: Yes

Type: String

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

Update requires: No interruption

Examples

Create KinesisDataStreamData

The following example creates KinesisDataStreamData with the required IAM role and Kinesis stream configuration.

JSON

{
  "KinesisDataStreamData": {
    "KinesisDataStreamArn": "arn:aws:kinesis:us-east-2:123456789012:stream/my-telemetry-stream",
    "KinesisRoleArn": "arn:aws:iam::123456789012:role/GroundStationKinesisRole"
  }
}

YAML

KinesisDataStreamData:
  KinesisDataStreamArn: arn:aws:kinesis:us-east-2:123456789012:stream/my-telemetry-stream
  KinesisRoleArn: arn:aws:iam::123456789012:role/GroundStationKinesisRole