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
@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,
max_record_size_in_ki_b: Optional[int] = None,
name: Optional[str] = None,
record_distribution_strategy: Optional[StreamRecordDistributionStrategy] = 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,
warm_throughput_mi_bps: Optional[int] = None)
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.
resource "aws-native_kinesis_stream" "name" {
# resource properties
}
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.
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:
Outputs
All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:
- Arn
string
- The Amazon resource name (ARN) of the Kinesis stream
- Id
string
- The provider-assigned unique ID for this managed resource.
- WarmThroughputObject
StreamWarmThroughputObject
- Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.
- arn
string
- The Amazon resource name (ARN) of the Kinesis stream
- id
string
- The provider-assigned unique ID for this managed resource.
- warm_throughput_object
object
- Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.
- arn
String
- The Amazon resource name (ARN) of the Kinesis stream
- id
String
- The provider-assigned unique ID for this managed resource.
- warmThroughputObject
StreamWarmThroughputObject
- Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.
- arn
string
- The Amazon resource name (ARN) of the Kinesis stream
- id
string
- The provider-assigned unique ID for this managed resource.
- warmThroughputObject
StreamWarmThroughputObject
- Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.
- arn
String
- The Amazon resource name (ARN) of the Kinesis stream
- id
String
- The provider-assigned unique ID for this managed resource.
- warmThroughputObject
Property Map
- Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.
Look up Existing Stream Resource
Get an existing Stream resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Stream get(String name, Output<String> id, CustomResourceOptions options)
resources: existingStream: type: aws-native:kinesis:Stream get: id: ${id}
import {
to = aws-native_kinesis_stream.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- 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 resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
StreamState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
StreamEncryption, StreamEncryptionArgs
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.- EncryptionType
Pulumi.AwsNative.Kinesis.StreamEncryptionEncryptionType
- The encryption type to use. The only valid value is KMS.
- KeyId
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.
- EncryptionType
StreamEncryptionEncryptionType
- The encryption type to use. The only valid value is KMS.
- KeyId
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
"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.
- encryptionType
StreamEncryptionEncryptionType
- The encryption type to use. The only valid value is KMS.
- keyId
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.
- encryptionType
StreamEncryptionEncryptionType
- The encryption type to use. The only valid value is KMS.
- keyId
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
StreamEncryptionEncryptionType
- 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.
- encryptionType
"KMS"
- The encryption type to use. The only valid value is KMS.
- keyId
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
The encryption type to use. The only valid value is KMS.| Name | Value |
|---|
| StreamEncryptionEncryptionTypeKms | KMS |
StreamEnhancedMetric, StreamEnhancedMetricArgs
Value of an enhanced metric| Name | Value |
|---|
| IncomingBytes | IncomingBytes |
| IncomingRecords | IncomingRecords |
| OutgoingBytes | OutgoingBytes |
| OutgoingRecords | OutgoingRecords |
| WriteProvisionedThroughputExceeded | WriteProvisionedThroughputExceeded |
| ReadProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded |
| IteratorAgeMilliseconds | IteratorAgeMilliseconds |
| All | ALL |
| Name | Value |
|---|
| StreamEnhancedMetricIncomingBytes | IncomingBytes |
| StreamEnhancedMetricIncomingRecords | IncomingRecords |
| StreamEnhancedMetricOutgoingBytes | OutgoingBytes |
| StreamEnhancedMetricOutgoingRecords | OutgoingRecords |
| StreamEnhancedMetricWriteProvisionedThroughputExceeded | WriteProvisionedThroughputExceeded |
| StreamEnhancedMetricReadProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded |
| StreamEnhancedMetricIteratorAgeMilliseconds | IteratorAgeMilliseconds |
| StreamEnhancedMetricAll | ALL |
| Value |
|---|
IncomingBytes |
IncomingRecords |
OutgoingBytes |
OutgoingRecords |
WriteProvisionedThroughputExceeded |
ReadProvisionedThroughputExceeded |
IteratorAgeMilliseconds |
ALL |
| Name | Value |
|---|
| IncomingBytes | IncomingBytes |
| IncomingRecords | IncomingRecords |
| OutgoingBytes | OutgoingBytes |
| OutgoingRecords | OutgoingRecords |
| WriteProvisionedThroughputExceeded | WriteProvisionedThroughputExceeded |
| ReadProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded |
| IteratorAgeMilliseconds | IteratorAgeMilliseconds |
| All | ALL |
| Name | Value |
|---|
| IncomingBytes | IncomingBytes |
| IncomingRecords | IncomingRecords |
| OutgoingBytes | OutgoingBytes |
| OutgoingRecords | OutgoingRecords |
| WriteProvisionedThroughputExceeded | WriteProvisionedThroughputExceeded |
| ReadProvisionedThroughputExceeded | ReadProvisionedThroughputExceeded |
| IteratorAgeMilliseconds | IteratorAgeMilliseconds |
| All | ALL |
| Name | Value |
|---|
| 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 |
| Value |
|---|
IncomingBytes |
IncomingRecords |
OutgoingBytes |
OutgoingRecords |
WriteProvisionedThroughputExceeded |
ReadProvisionedThroughputExceeded |
IteratorAgeMilliseconds |
ALL |
StreamModeDetails, StreamModeDetailsArgs
When specified, enables or updates the mode of stream. Default is PROVISIONED.StreamModeDetailsStreamMode, StreamModeDetailsStreamModeArgs
The mode of the stream| Name | Value |
|---|
| OnDemand | ON_DEMAND |
| Provisioned | PROVISIONED |
| Name | Value |
|---|
| StreamModeDetailsStreamModeOnDemand | ON_DEMAND |
| StreamModeDetailsStreamModeProvisioned | PROVISIONED |
| Value |
|---|
ON_DEMAND |
PROVISIONED |
| Name | Value |
|---|
| OnDemand | ON_DEMAND |
| Provisioned | PROVISIONED |
| Name | Value |
|---|
| OnDemand | ON_DEMAND |
| Provisioned | PROVISIONED |
| Name | Value |
|---|
| ON_DEMAND | ON_DEMAND |
| PROVISIONED | PROVISIONED |
| Value |
|---|
ON_DEMAND |
PROVISIONED |
StreamRecordDistributionStrategy, StreamRecordDistributionStrategyArgs
The record distribution strategy for the stream. This property can ONLY be set when StreamMode is ON_DEMAND| Name | Value |
|---|
| Auto | AUTO |
| UserPartitionKey | USER_PARTITION_KEY |
| Name | Value |
|---|
| StreamRecordDistributionStrategyAuto | AUTO |
| StreamRecordDistributionStrategyUserPartitionKey | USER_PARTITION_KEY |
| Value |
|---|
AUTO |
USER_PARTITION_KEY |
| Name | Value |
|---|
| Auto | AUTO |
| UserPartitionKey | USER_PARTITION_KEY |
| Name | Value |
|---|
| Auto | AUTO |
| UserPartitionKey | USER_PARTITION_KEY |
| Name | Value |
|---|
| AUTO | AUTO |
| USER_PARTITION_KEY | USER_PARTITION_KEY |
| Value |
|---|
AUTO |
USER_PARTITION_KEY |
StreamWarmThroughputObject, StreamWarmThroughputObjectArgs
Warm throughput configuration details for the stream. Only present for ON_DEMAND streams.- CurrentMiBps
int
- Current warm throughput in MiB/s
- TargetMiBps
int
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- CurrentMiBps
int
- Current warm throughput in MiB/s
- TargetMiBps
int
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- current_mi_bps
number
- Current warm throughput in MiB/s
- target_mi_bps
number
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- currentMiBps
Integer
- Current warm throughput in MiB/s
- targetMiBps
Integer
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- currentMiBps
number
- Current warm throughput in MiB/s
- targetMiBps
number
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- current_mi_bps
int
- Current warm throughput in MiB/s
- target_mi_bps
int
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
- currentMiBps
Number
- Current warm throughput in MiB/s
- targetMiBps
Number
- Target warm throughput in MiB/s that a customer can write to a stream at any given time
Tag, TagArgs
A set of tags to apply to the resource.- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- Key
string
- The key name of the tag
- Value
string
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
- key
string
- The key name of the tag
- value
string
- The value of the tag
- key
str
- The key name of the tag
- value
str
- The value of the tag
- key
String
- The key name of the tag
- value
String
- The value of the tag
Package Details
- Repository
- AWS Native pulumi/pulumi-aws-native
- License
- Apache-2.0