latest--aws-kinesis-stream
shared| Type | object |
|---|---|
| Schema URL | https://catalog.lintel.tools/schemas/schemastore/serverless-framework-configuration/_shared/latest--aws-kinesis-stream.json |
| Parent schema | serverless-framework-configuration |
Resource Type definition for AWS::Kinesis::Stream. Source:- https://github.com/aws-cloudformation/aws-cloudformation-resource-providers-kinesis.git
Properties
When specified, enables or updates the mode of stream. Default is PROVISIONED.
1 nested properties
The mode of the stream
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
2 nested properties
The encryption type to use. The only valid value is KMS.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
The number of hours for the data records that are stored in shards to remain accessible.
An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
The name of the Kinesis stream.
The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
Definitions
When specified, enables or updates the mode of stream. Default is PROVISIONED.
The mode of the stream
When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream. Removing this property from your stack template and updating your stack disables encryption.
The encryption type to use. The only valid value is KMS.
The GUID for the customer-managed AWS KMS key to use for encryption. This value can be a globally unique identifier, a fully specified Amazon Resource Name (ARN) to either an alias or a key, or an alias name prefixed by "alias/".You can also use a master key owned by Kinesis Data Streams by specifying the alias aws/kinesis.
An arbitrary set of tags (key-value pairs) to associate with the Kinesis stream.
The value for the tag. You can specify a value that is 0 to 255 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.