We recommend new projects start with resources from the AWS provider.
aws-native.kinesis.Stream
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
Resource Type definition for AWS::Kinesis::Stream
Create Stream Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Stream(name: string, args?: StreamArgs, opts?: CustomResourceOptions);
@overload
def Stream(resource_name: str,
args: Optional[StreamArgs] = None,
opts: Optional[ResourceOptions] = None)
@overload
def Stream(resource_name: str,
opts: Optional[ResourceOptions] = None,
desired_shard_level_metrics: Optional[Sequence[StreamEnhancedMetric]] = None,
name: Optional[str] = None,
retention_period_hours: Optional[int] = None,
shard_count: Optional[int] = None,
stream_encryption: Optional[StreamEncryptionArgs] = None,
stream_mode_details: Optional[StreamModeDetailsArgs] = None,
tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
func NewStream(ctx *Context, name string, args *StreamArgs, opts ...ResourceOption) (*Stream, error)
public Stream(string name, StreamArgs? args = null, CustomResourceOptions? opts = null)
public Stream(String name, StreamArgs args)
public Stream(String name, StreamArgs args, CustomResourceOptions options)
type: aws-native:kinesis:Stream
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name str
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name string
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name String
- The unique name of the resource.
- args StreamArgs
- The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Stream Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Stream resource accepts the following input properties:
- Desired
Shard List<Pulumi.Level Metrics Aws Native. Kinesis. Stream Enhanced Metric> - The final list of shard-level metrics
- Name string
- The name of the Kinesis stream.
- Retention
Period intHours - The number of hours for the data records that are stored in shards to remain accessible.
- int
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- Stream
Encryption Pulumi.Aws Native. Kinesis. Inputs. Stream Encryption - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- Stream
Mode Pulumi.Details Aws Native. Kinesis. Inputs. Stream Mode Details - The mode in which the stream is running.
- List<Pulumi.
Aws Native. Inputs. Tag> - An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
- Desired
Shard []StreamLevel Metrics Enhanced Metric - The final list of shard-level metrics
- Name string
- The name of the Kinesis stream.
- Retention
Period intHours - The number of hours for the data records that are stored in shards to remain accessible.
- int
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- Stream
Encryption StreamEncryption Args - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- Stream
Mode StreamDetails Mode Details Args - The mode in which the stream is running.
- Tag
Args - An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
- desired
Shard List<StreamLevel Metrics Enhanced Metric> - The final list of shard-level metrics
- name String
- The name of the Kinesis stream.
- retention
Period IntegerHours - The number of hours for the data records that are stored in shards to remain accessible.
- Integer
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- stream
Encryption StreamEncryption - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- stream
Mode StreamDetails Mode Details - The mode in which the stream is running.
- List<Tag>
- An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
- desired
Shard StreamLevel Metrics Enhanced Metric[] - The final list of shard-level metrics
- name string
- The name of the Kinesis stream.
- retention
Period numberHours - The number of hours for the data records that are stored in shards to remain accessible.
- number
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- stream
Encryption StreamEncryption - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- stream
Mode StreamDetails Mode Details - The mode in which the stream is running.
- Tag[]
- An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
- desired_
shard_ Sequence[Streamlevel_ metrics Enhanced Metric] - The final list of shard-level metrics
- name str
- The name of the Kinesis stream.
- retention_
period_ inthours - The number of hours for the data records that are stored in shards to remain accessible.
- int
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- stream_
encryption StreamEncryption Args - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- stream_
mode_ Streamdetails Mode Details Args - The mode in which the stream is running.
- Sequence[Tag
Args] - An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
- desired
Shard List<"IncomingLevel Metrics Bytes" | "Incoming Records" | "Outgoing Bytes" | "Outgoing Records" | "Write Provisioned Throughput Exceeded" | "Read Provisioned Throughput Exceeded" | "Iterator Age Milliseconds" | "ALL"> - The final list of shard-level metrics
- name String
- The name of the Kinesis stream.
- retention
Period NumberHours - The number of hours for the data records that are stored in shards to remain accessible.
- Number
- The number of shards that the stream uses. Required when StreamMode = PROVISIONED is passed.
- stream
Encryption Property Map - When specified, enables or updates server-side encryption using an AWS KMS key for a specified stream.
- stream
Mode Property MapDetails - The mode in which the stream is running.
- List<Property Map>
- An arbitrary set of tags (key–value pairs) to associate with the Kinesis stream.
Outputs
All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:
Supporting Types
StreamEncryption, StreamEncryptionArgs
- Encryption
Type Pulumi.Aws Native. Kinesis. Stream Encryption Encryption Type - The encryption type to use. The only valid value is KMS.
- Key
Id string - 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.
- Encryption
Type StreamEncryption Encryption Type - The encryption type to use. The only valid value is KMS.
- Key
Id string - 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.
- encryption
Type StreamEncryption Encryption Type - The encryption type to use. The only valid value is KMS.
- key
Id String - 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.
- encryption
Type StreamEncryption Encryption Type - The encryption type to use. The only valid value is KMS.
- key
Id string - 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.
- encryption_
type StreamEncryption Encryption Type - The encryption type to use. The only valid value is KMS.
- key_
id str - 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.
- encryption
Type "KMS" - The encryption type to use. The only valid value is KMS.
- key
Id String - 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.
StreamEncryptionEncryptionType, StreamEncryptionEncryptionTypeArgs
- Kms
- KMS
- Stream
Encryption Encryption Type Kms - KMS
- Kms
- KMS
- Kms
- KMS
- KMS
- KMS
- "KMS"
- KMS
StreamEnhancedMetric, StreamEnhancedMetricArgs
- Incoming
Bytes - IncomingBytes
- Incoming
Records - IncomingRecords
- Outgoing
Bytes - OutgoingBytes
- Outgoing
Records - OutgoingRecords
- Write
Provisioned Throughput Exceeded - WriteProvisionedThroughputExceeded
- Read
Provisioned Throughput Exceeded - ReadProvisionedThroughputExceeded
- Iterator
Age Milliseconds - IteratorAgeMilliseconds
- All
- ALL
- Stream
Enhanced Metric Incoming Bytes - IncomingBytes
- Stream
Enhanced Metric Incoming Records - IncomingRecords
- Stream
Enhanced Metric Outgoing Bytes - OutgoingBytes
- Stream
Enhanced Metric Outgoing Records - OutgoingRecords
- Stream
Enhanced Metric Write Provisioned Throughput Exceeded - WriteProvisionedThroughputExceeded
- Stream
Enhanced Metric Read Provisioned Throughput Exceeded - ReadProvisionedThroughputExceeded
- Stream
Enhanced Metric Iterator Age Milliseconds - IteratorAgeMilliseconds
- Stream
Enhanced Metric All - ALL
- Incoming
Bytes - IncomingBytes
- Incoming
Records - IncomingRecords
- Outgoing
Bytes - OutgoingBytes
- Outgoing
Records - OutgoingRecords
- Write
Provisioned Throughput Exceeded - WriteProvisionedThroughputExceeded
- Read
Provisioned Throughput Exceeded - ReadProvisionedThroughputExceeded
- Iterator
Age Milliseconds - IteratorAgeMilliseconds
- All
- ALL
- Incoming
Bytes - IncomingBytes
- Incoming
Records - IncomingRecords
- Outgoing
Bytes - OutgoingBytes
- Outgoing
Records - OutgoingRecords
- Write
Provisioned Throughput Exceeded - WriteProvisionedThroughputExceeded
- Read
Provisioned Throughput Exceeded - ReadProvisionedThroughputExceeded
- Iterator
Age Milliseconds - IteratorAgeMilliseconds
- All
- ALL
- INCOMING_BYTES
- IncomingBytes
- INCOMING_RECORDS
- IncomingRecords
- OUTGOING_BYTES
- OutgoingBytes
- OUTGOING_RECORDS
- OutgoingRecords
- WRITE_PROVISIONED_THROUGHPUT_EXCEEDED
- WriteProvisionedThroughputExceeded
- READ_PROVISIONED_THROUGHPUT_EXCEEDED
- ReadProvisionedThroughputExceeded
- ITERATOR_AGE_MILLISECONDS
- IteratorAgeMilliseconds
- ALL
- ALL
- "Incoming
Bytes" - IncomingBytes
- "Incoming
Records" - IncomingRecords
- "Outgoing
Bytes" - OutgoingBytes
- "Outgoing
Records" - OutgoingRecords
- "Write
Provisioned Throughput Exceeded" - WriteProvisionedThroughputExceeded
- "Read
Provisioned Throughput Exceeded" - ReadProvisionedThroughputExceeded
- "Iterator
Age Milliseconds" - IteratorAgeMilliseconds
- "ALL"
- ALL
StreamModeDetails, StreamModeDetailsArgs
- Stream
Mode Pulumi.Aws Native. Kinesis. Stream Mode Details Stream Mode - The mode of the stream
- Stream
Mode StreamMode Details Stream Mode - The mode of the stream
- stream
Mode StreamMode Details Stream Mode - The mode of the stream
- stream
Mode StreamMode Details Stream Mode - The mode of the stream
- stream_
mode StreamMode Details Stream Mode - The mode of the stream
- stream
Mode "ON_DEMAND" | "PROVISIONED" - The mode of the stream
StreamModeDetailsStreamMode, StreamModeDetailsStreamModeArgs
- On
Demand - ON_DEMAND
- Provisioned
- PROVISIONED
- Stream
Mode Details Stream Mode On Demand - ON_DEMAND
- Stream
Mode Details Stream Mode Provisioned - PROVISIONED
- On
Demand - ON_DEMAND
- Provisioned
- PROVISIONED
- On
Demand - ON_DEMAND
- Provisioned
- PROVISIONED
- ON_DEMAND
- ON_DEMAND
- PROVISIONED
- PROVISIONED
- "ON_DEMAND"
- ON_DEMAND
- "PROVISIONED"
- PROVISIONED
Tag, TagArgs
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0
We recommend new projects start with resources from the AWS provider.