Package com.pulumi.aws.kinesis

Class StreamArgs.Builder

  • Enclosing class:
    StreamArgs
    public static final class StreamArgs.Builder
extends java.lang.Object

    • Constructor Detail

      • Builder

        public Builder()

      • Builder

        public Builder​(StreamArgs defaults)

    • Method Detail

      • arn

        public StreamArgs.Builder arn​(@Nullable
                              com.pulumi.core.Output<java.lang.String> arn)
        Parameters:
        arn - ARN specifying the stream (same as `id`).
        Returns:
        builder

      • arn

        public StreamArgs.Builder arn​(java.lang.String arn)
        Parameters:
        arn - ARN specifying the stream (same as `id`).
        Returns:
        builder

      • encryptionType

        public StreamArgs.Builder encryptionType​(@Nullable
                                         com.pulumi.core.Output<java.lang.String> encryptionType)
        Parameters:
        encryptionType - Encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
        Returns:
        builder

      • encryptionType

        public StreamArgs.Builder encryptionType​(java.lang.String encryptionType)
        Parameters:
        encryptionType - Encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
        Returns:
        builder

      • enforceConsumerDeletion

        public StreamArgs.Builder enforceConsumerDeletion​(@Nullable
                                                  com.pulumi.core.Output<java.lang.Boolean> enforceConsumerDeletion)
        Parameters:
        enforceConsumerDeletion - Whether to deregister all registered consumers from the stream so that the stream can be destroyed without error. The default value is `false`.
        Returns:
        builder

      • enforceConsumerDeletion

        public StreamArgs.Builder enforceConsumerDeletion​(java.lang.Boolean enforceConsumerDeletion)
        Parameters:
        enforceConsumerDeletion - Whether to deregister all registered consumers from the stream so that the stream can be destroyed without error. The default value is `false`.
        Returns:
        builder

      • kmsKeyId

        public StreamArgs.Builder kmsKeyId​(@Nullable
                                   com.pulumi.core.Output<java.lang.String> kmsKeyId)
        Parameters:
        kmsKeyId - Identifier for the customer-managed KMS key to use for encryption. This can be a Key ID (UUID), a Key ARN, an Alias Name (prefixed with `alias/`), or an Alias ARN. You can also use a master key owned by Kinesis Data Streams by specifying the alias `aws/kinesis`.
        Returns:
        builder

      • kmsKeyId

        public StreamArgs.Builder kmsKeyId​(java.lang.String kmsKeyId)
        Parameters:
        kmsKeyId - Identifier for the customer-managed KMS key to use for encryption. This can be a Key ID (UUID), a Key ARN, an Alias Name (prefixed with `alias/`), or an Alias ARN. You can also use a master key owned by Kinesis Data Streams by specifying the alias `aws/kinesis`.
        Returns:
        builder

      • maxRecordSizeInKib

        public StreamArgs.Builder maxRecordSizeInKib​(@Nullable
                                             com.pulumi.core.Output<java.lang.Integer> maxRecordSizeInKib)
        Parameters:
        maxRecordSizeInKib - Maximum size for a single data record in KiB. The minimum value is 1024. The maximum value is 10240.
        Returns:
        builder

      • maxRecordSizeInKib

        public StreamArgs.Builder maxRecordSizeInKib​(java.lang.Integer maxRecordSizeInKib)
        Parameters:
        maxRecordSizeInKib - Maximum size for a single data record in KiB. The minimum value is 1024. The maximum value is 10240.
        Returns:
        builder

      • name

        public StreamArgs.Builder name​(@Nullable
                               com.pulumi.core.Output<java.lang.String> name)
        Parameters:
        name - Name to identify the stream. This is unique to the AWS account and region the Stream is created in.
        Returns:
        builder

      • name

        public StreamArgs.Builder name​(java.lang.String name)
        Parameters:
        name - Name to identify the stream. This is unique to the AWS account and region the Stream is created in.
        Returns:
        builder

      • region

        public StreamArgs.Builder region​(@Nullable
                                 com.pulumi.core.Output<java.lang.String> region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • region

        public StreamArgs.Builder region​(java.lang.String region)
        Parameters:
        region - Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
        Returns:
        builder

      • retentionPeriod

        public StreamArgs.Builder retentionPeriod​(@Nullable
                                          com.pulumi.core.Output<java.lang.Integer> retentionPeriod)
        Parameters:
        retentionPeriod - 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.
        Returns:
        builder

      • retentionPeriod

        public StreamArgs.Builder retentionPeriod​(java.lang.Integer retentionPeriod)
        Parameters:
        retentionPeriod - 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.
        Returns:
        builder

      • shardCount

        public StreamArgs.Builder shardCount​(@Nullable
                                     com.pulumi.core.Output<java.lang.Integer> shardCount)
        Parameters:
        shardCount - Number of shards that the stream will use. If the `streamMode` 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
        Returns:
        builder

      • shardCount

        public StreamArgs.Builder shardCount​(java.lang.Integer shardCount)
        Parameters:
        shardCount - Number of shards that the stream will use. If the `streamMode` 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
        Returns:
        builder

      • shardLevelMetrics

        public StreamArgs.Builder shardLevelMetrics​(@Nullable
                                            com.pulumi.core.Output<java.util.List<java.lang.String>> shardLevelMetrics)
        Parameters:
        shardLevelMetrics - List of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
        Returns:
        builder

      • shardLevelMetrics

        public StreamArgs.Builder shardLevelMetrics​(java.util.List<java.lang.String> shardLevelMetrics)
        Parameters:
        shardLevelMetrics - List of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
        Returns:
        builder

      • shardLevelMetrics

        public StreamArgs.Builder shardLevelMetrics​(java.lang.String... shardLevelMetrics)
        Parameters:
        shardLevelMetrics - List of shard-level CloudWatch metrics which can be enabled for the stream. See [Monitoring with CloudWatch](https://docs.aws.amazon.com/streams/latest/dev/monitoring-with-cloudwatch.html) for more. Note that the value ALL should not be used; instead you should provide an explicit list of metrics you wish to enable.
        Returns:
        builder

      • streamModeDetails

        public StreamArgs.Builder streamModeDetails​(@Nullable
                                            com.pulumi.core.Output<StreamStreamModeDetailsArgs> streamModeDetails)
        Parameters:
        streamModeDetails - [Capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
        Returns:
        builder

      • streamModeDetails

        public StreamArgs.Builder streamModeDetails​(StreamStreamModeDetailsArgs streamModeDetails)
        Parameters:
        streamModeDetails - [Capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
        Returns:
        builder

      • tags

        public StreamArgs.Builder tags​(@Nullable
                               com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tags)
        Parameters:
        tags - Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • tags

        public StreamArgs.Builder tags​(java.util.Map<java.lang.String,​java.lang.String> tags)
        Parameters:
        tags - Map of tags to assign to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
        Returns:
        builder

      • warmThroughputMibPs

        public StreamArgs.Builder warmThroughputMibPs​(@Nullable
                                              com.pulumi.core.Output<java.lang.Integer> warmThroughputMibPs)
        Parameters:
        warmThroughputMibPs - Target warm throughput in MB/s that the stream should be scaled to handle.
        Returns:
        builder

      • warmThroughputMibPs

        public StreamArgs.Builder warmThroughputMibPs​(java.lang.Integer warmThroughputMibPs)
        Parameters:
        warmThroughputMibPs - Target warm throughput in MB/s that the stream should be scaled to handle.
        Returns:
        builder