Cloud.Service.AWS.Kinesis.Stream

Cloud.Service.AWS.Kinesis.Stream
Cloud.Service.AWS.Kinesis.Stream
JSON Example
{
    "arn": "string",
    "encryption_type": "string",
    "kms_key_id": "string",
    "name": "string",
    "provider": "string",
    "provider_region": "string",
    "retention_period": 0,
    "shard_count": 0,
    "shard_level_metrics": [
        "string"
    ]
}
string
arn
Optional

The Amazon Resource Name (ARN) assigned by AWS to the stream. Same as the id property.

string
encryption_type
Optional

Encryption type of NONE or KMS. Default is NONE.

string
kms_key_id
Optional

Customer-managed Key Management Service (KMS) key GUID to use for encryption. You can also use a Kinesis-owned master key by entering the alias aws/kinesis.

string
name
Required

(Required) Name of the stream.

string
provider
Required

(Required) The name of the AWS cloud account to use for this resource

string
provider_region
Required

(Required) Target cloud region, such as us-east-1. Must be within the provider cloud account.

integer
retention_period
Optional

Lifespan of data records added to the stream. Range is 24 to 168 hours. Default is 24 hours.

integer
shard_count
Required

(Required) Number of shards that the stream will use.

array of string
shard_level_metrics
Optional

List of shard-level CloudWatch metrics that can be enabled for the stream. For performance reasons, do not enter ALL. Enter only the metrics that you need.

object
tags
Optional

Constraint tags for assigning the resource.