Docs Packages
  1. Packages
  2. AWS Classic
  3. API Docs
  4. kinesis
  5. Stream

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

aws.kinesis.Stream

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
pulumi/pulumi-aws

    Provides a Kinesis Stream resource. Amazon Kinesis is a managed service that scales elastically for real-time processing of streaming big data.

    For more details, see the Amazon Kinesis Documentation.

    Example Usage

    using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() => 
{
    var testStream = new Aws.Kinesis.Stream("testStream", new()
    {
        RetentionPeriod = 48,
        ShardCount = 1,
        ShardLevelMetrics = new[]
        {
            "IncomingBytes",
            "OutgoingBytes",
        },
        StreamModeDetails = new Aws.Kinesis.Inputs.StreamStreamModeDetailsArgs
        {
            StreamMode = "PROVISIONED",
        },
        Tags = 
        {
            { "Environment", "test" },
        },
    });

});

    package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v5/go/aws/kinesis"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := kinesis.NewStream(ctx, "testStream", &kinesis.StreamArgs{
			RetentionPeriod: pulumi.Int(48),
			ShardCount:      pulumi.Int(1),
			ShardLevelMetrics: pulumi.StringArray{
				pulumi.String("IncomingBytes"),
				pulumi.String("OutgoingBytes"),
			},
			StreamModeDetails: &kinesis.StreamStreamModeDetailsArgs{
				StreamMode: pulumi.String("PROVISIONED"),
			},
			Tags: pulumi.StringMap{
				"Environment": pulumi.String("test"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.kinesis.Stream;
import com.pulumi.aws.kinesis.StreamArgs;
import com.pulumi.aws.kinesis.inputs.StreamStreamModeDetailsArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var testStream = new Stream("testStream", StreamArgs.builder()        
            .retentionPeriod(48)
            .shardCount(1)
            .shardLevelMetrics(            
                "IncomingBytes",
                "OutgoingBytes")
            .streamModeDetails(StreamStreamModeDetailsArgs.builder()
                .streamMode("PROVISIONED")
                .build())
            .tags(Map.of("Environment", "test"))
            .build());

    }
}

    import pulumi
import pulumi_aws as aws

test_stream = aws.kinesis.Stream("testStream",
    retention_period=48,
    shard_count=1,
    shard_level_metrics=[
        "IncomingBytes",
        "OutgoingBytes",
    ],
    stream_mode_details=aws.kinesis.StreamStreamModeDetailsArgs(
        stream_mode="PROVISIONED",
    ),
    tags={
        "Environment": "test",
    })

    import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const testStream = new aws.kinesis.Stream("testStream", {
    retentionPeriod: 48,
    shardCount: 1,
    shardLevelMetrics: [
        "IncomingBytes",
        "OutgoingBytes",
    ],
    streamModeDetails: {
        streamMode: "PROVISIONED",
    },
    tags: {
        Environment: "test",
    },
});

    resources:
  testStream:
    type: aws:kinesis:Stream
    properties:
      retentionPeriod: 48
      shardCount: 1
      shardLevelMetrics:
        - IncomingBytes
        - OutgoingBytes
      streamModeDetails:
        streamMode: PROVISIONED
      tags:
        Environment: test

    Create Stream Resource

    new Stream(name: string, args?: StreamArgs, opts?: CustomResourceOptions);
    @overload
def Stream(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           arn: Optional[str] = None,
           encryption_type: Optional[str] = None,
           enforce_consumer_deletion: Optional[bool] = None,
           kms_key_id: Optional[str] = None,
           name: Optional[str] = None,
           retention_period: Optional[int] = None,
           shard_count: Optional[int] = None,
           shard_level_metrics: Optional[Sequence[str]] = None,
           stream_mode_details: Optional[StreamStreamModeDetailsArgs] = None,
           tags: Optional[Mapping[str, str]] = None)
@overload
def Stream(resource_name: str,
           args: Optional[StreamArgs] = None,
           opts: Optional[ResourceOptions] = 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:kinesis:Stream
properties: # The arguments to resource properties.
options: # 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.
    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

    The Stream resource accepts the following input properties:

    Arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    EncryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    EnforceConsumerDeletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    KmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    Name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    RetentionPeriod int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    ShardCount int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    ShardLevelMetrics List<string>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    StreamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    EncryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    EnforceConsumerDeletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    KmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    Name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    RetentionPeriod int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    ShardCount int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    ShardLevelMetrics []string

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    StreamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    arn String

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType String

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion Boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId String

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name String

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod Integer

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount Integer

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics List<String>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod number

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount number

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics string[]

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    arn str

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryption_type str

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforce_consumer_deletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kms_key_id str

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name str

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retention_period int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shard_count int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shard_level_metrics Sequence[str]

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    stream_mode_details StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    arn String

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType String

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion Boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId String

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name String

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod Number

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount Number

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics List<String>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails Property Map

    Indicates the capacity mode of the data stream. Detailed below.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Stream resource produces the following output properties:

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Id string

    The provider-assigned unique ID for this managed resource.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    id string

    The provider-assigned unique ID for this managed resource.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    id str

    The provider-assigned unique ID for this managed resource.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    id String

    The provider-assigned unique ID for this managed resource.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    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 get(name: string, id: Input<ID>, state?: StreamState, opts?: CustomResourceOptions): Stream
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        arn: Optional[str] = None,
        encryption_type: Optional[str] = None,
        enforce_consumer_deletion: Optional[bool] = None,
        kms_key_id: Optional[str] = None,
        name: Optional[str] = None,
        retention_period: Optional[int] = None,
        shard_count: Optional[int] = None,
        shard_level_metrics: Optional[Sequence[str]] = None,
        stream_mode_details: Optional[StreamStreamModeDetailsArgs] = None,
        tags: Optional[Mapping[str, str]] = None,
        tags_all: Optional[Mapping[str, str]] = None) -> Stream
    func GetStream(ctx *Context, name string, id IDInput, state *StreamState, opts ...ResourceOption) (*Stream, error)
    public static Stream Get(string name, Input<string> id, StreamState? state, CustomResourceOptions? opts = null)
    public static Stream get(String name, Output<String> id, StreamState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    EncryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    EnforceConsumerDeletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    KmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    Name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    RetentionPeriod int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    ShardCount int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    ShardLevelMetrics List<string>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    StreamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    Tags Dictionary<string, string>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll Dictionary<string, string>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    EncryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    EnforceConsumerDeletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    KmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    Name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    RetentionPeriod int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    ShardCount int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    ShardLevelMetrics []string

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    StreamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    Tags map[string]string

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    TagsAll map[string]string

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType String

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion Boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId String

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name String

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod Integer

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount Integer

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics List<String>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags Map<String,String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String,String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn string

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType string

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId string

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name string

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod number

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount number

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics string[]

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags {[key: string]: string}

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll {[key: string]: string}

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn str

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryption_type str

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforce_consumer_deletion bool

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kms_key_id str

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name str

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retention_period int

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shard_count int

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shard_level_metrics Sequence[str]

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    stream_mode_details StreamStreamModeDetailsArgs

    Indicates the capacity mode of the data stream. Detailed below.

    tags Mapping[str, str]

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tags_all Mapping[str, str]

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    arn String

    The Amazon Resource Name (ARN) specifying the Stream (same as id)

    encryptionType String

    The encryption type to use. The only acceptable values are NONE or KMS. The default value is NONE.

    enforceConsumerDeletion Boolean

    A boolean that indicates all registered consumers should be deregistered from the stream so that the stream can be destroyed without error. The default value is false.

    kmsKeyId String

    The GUID for the customer-managed KMS key to use for encryption. You can also use a Kinesis-owned master key by specifying the alias alias/aws/kinesis.

    name String

    A name to identify the stream. This is unique to the AWS account and region the Stream is created in.

    retentionPeriod Number

    Length of time data records are accessible after they are added to the stream. The maximum value of a stream's retention period is 8760 hours. Minimum value is 24. Default is 24.

    shardCount Number

    The number of shards that the stream will use. If the stream_mode is PROVISIONED, this field is required. Amazon has guidelines for specifying the Stream size that should be referenced when creating a Kinesis stream. See Amazon Kinesis Streams for more.

    shardLevelMetrics List<String>

    A list of shard-level CloudWatch metrics which can be enabled for the stream. See Monitoring with CloudWatch for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.

    streamModeDetails Property Map

    Indicates the capacity mode of the data stream. Detailed below.

    tags Map<String>

    A map of tags to assign to the resource. If configured with a provider default_tags configuration block present, tags with matching keys will overwrite those defined at the provider-level.

    tagsAll Map<String>

    A map of tags assigned to the resource, including those inherited from the provider default_tags configuration block.

    Supporting Types

    StreamStreamModeDetails

    StreamMode string

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    StreamMode string

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    streamMode String

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    streamMode string

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    stream_mode str

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    streamMode String

    Specifies the capacity mode of the stream. Must be either PROVISIONED or ON_DEMAND.

    Import

    Kinesis Streams can be imported using the name, e.g.,

     $ pulumi import aws:kinesis/stream:Stream test_stream kinesis-test

    [1]https://aws.amazon.com/documentation/kinesis/ [2]https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html [3]https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the aws Terraform Provider.

    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v5.41.0 published on Monday, May 15, 2023 by Pulumi
    pulumi/pulumi-aws