pulumi-aws-kotlin/com.pulumi.aws.kinesis.kotlin/StreamArgs

StreamArgs

data class StreamArgs(val arn: Output<String>? = null, val encryptionType: Output<String>? = null, val enforceConsumerDeletion: Output<Boolean>? = null, val kmsKeyId: Output<String>? = null, val name: Output<String>? = null, val retentionPeriod: Output<Int>? = null, val shardCount: Output<Int>? = null, val shardLevelMetrics: Output<List<String>>? = null, val streamModeDetails: Output<StreamStreamModeDetailsArgs>? = null, val tags: Output<Map<String, String>>? = null) : ConvertibleToJava<StreamArgs>

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

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

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

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

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

Constructors

StreamArgs

constructor(arn: Output<String>? = null, encryptionType: Output<String>? = null, enforceConsumerDeletion: Output<Boolean>? = null, kmsKeyId: Output<String>? = null, name: Output<String>? = null, retentionPeriod: Output<Int>? = null, shardCount: Output<Int>? = null, shardLevelMetrics: Output<List<String>>? = null, streamModeDetails: Output<StreamStreamModeDetailsArgs>? = null, tags: Output<Map<String, String>>? = null)

Properties

arn

val arn: Output<String>? = null

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

encryptionType

val encryptionType: Output<String>? = null

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

enforceConsumerDeletion

val enforceConsumerDeletion: Output<Boolean>? = null

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

val kmsKeyId: Output<String>? = null

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

val name: Output<String>? = null

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

retentionPeriod

val retentionPeriod: Output<Int>? = null

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

val shardCount: Output<Int>? = null

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

val shardLevelMetrics: Output<List<String>>? = null

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

val streamModeDetails: Output<StreamStreamModeDetailsArgs>? = null

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

Functions

toJava

open override fun toJava(): StreamArgs