Package com.pulumi.aws.kinesis

Class StreamArgs

  • public final class StreamArgs
extends com.pulumi.resources.ResourceArgs

    • Nested Class Summary

      Nested Classes 
      Modifier and Type Class Description
      static class  StreamArgs.Builder  

      • Nested classes/interfaces inherited from class com.pulumi.resources.InputArgs

        com.pulumi.resources.InputArgs.InputArgsInternal

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static StreamArgs Empty  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()  
      static StreamArgs.Builder builder()  
      static StreamArgs.Builder builder​(StreamArgs defaults)  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> encryptionType()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enforceConsumerDeletion()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxRecordSizeInKib()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()  
      java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> retentionPeriod()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> shardCount()  
      java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> shardLevelMetrics()  
      java.util.Optional<com.pulumi.core.Output<StreamStreamModeDetailsArgs>> streamModeDetails()  
      java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> warmThroughputMibPs()  

      • Methods inherited from class com.pulumi.resources.ResourceArgs

        validateMember

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Method Detail

      • arn

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> arn()
        Returns:
        ARN specifying the stream (same as `id`).

      • encryptionType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> encryptionType()
        Returns:
        Encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.

      • enforceConsumerDeletion

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enforceConsumerDeletion()
        Returns:
        Whether to deregister all registered consumers from the stream so that the stream can be destroyed without error. The default value is `false`.

      • kmsKeyId

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> kmsKeyId()
        Returns:
        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`.

      • maxRecordSizeInKib

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> maxRecordSizeInKib()
        Returns:
        Maximum size for a single data record in KiB. The minimum value is 1024. The maximum value is 10240.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name to identify the stream. This is unique to the AWS account and region the Stream is created in.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        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.

      • retentionPeriod

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> retentionPeriod()
        Returns:
        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

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> shardCount()
        Returns:
        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.

      • shardLevelMetrics

        public java.util.Optional<com.pulumi.core.Output<java.util.List<java.lang.String>>> shardLevelMetrics()
        Returns:
        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.

      • streamModeDetails

        public java.util.Optional<com.pulumi.core.Output<StreamStreamModeDetailsArgs>> streamModeDetails()
        Returns:
        [Capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        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.

      • warmThroughputMibPs

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> warmThroughputMibPs()
        Returns:
        Target warm throughput in MB/s that the stream should be scaled to handle.