com.pulumi.aws.kinesis.inputs.StreamState Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
The newest version!
// *** WARNING: this file was generated by pulumi-java-gen. ***
// *** Do not edit by hand unless you're certain you know what you are doing! ***
package com.pulumi.aws.kinesis.inputs;
import com.pulumi.aws.kinesis.inputs.StreamStreamModeDetailsArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;
public final class StreamState extends com.pulumi.resources.ResourceArgs {
public static final StreamState Empty = new StreamState();
/**
* The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*
*/
@Import(name="arn")
private @Nullable Output arn;
/**
* @return The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*
*/
public Optional> arn() {
return Optional.ofNullable(this.arn);
}
/**
* The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
*
*/
@Import(name="encryptionType")
private @Nullable Output encryptionType;
/**
* @return The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
*
*/
public Optional> encryptionType() {
return Optional.ofNullable(this.encryptionType);
}
/**
* 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`.
*
*/
@Import(name="enforceConsumerDeletion")
private @Nullable Output enforceConsumerDeletion;
/**
* @return 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`.
*
*/
public Optional> enforceConsumerDeletion() {
return Optional.ofNullable(this.enforceConsumerDeletion);
}
/**
* 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`.
*
*/
@Import(name="kmsKeyId")
private @Nullable Output kmsKeyId;
/**
* @return 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`.
*
*/
public Optional> kmsKeyId() {
return Optional.ofNullable(this.kmsKeyId);
}
/**
* A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
*
*/
@Import(name="name")
private @Nullable Output name;
/**
* @return A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
*
*/
public Optional> name() {
return Optional.ofNullable(this.name);
}
/**
* 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.
*
*/
@Import(name="retentionPeriod")
private @Nullable Output retentionPeriod;
/**
* @return 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.
*
*/
public Optional> retentionPeriod() {
return Optional.ofNullable(this.retentionPeriod);
}
/**
* 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
*
*/
@Import(name="shardCount")
private @Nullable Output shardCount;
/**
* @return 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
*
*/
public Optional> shardCount() {
return Optional.ofNullable(this.shardCount);
}
/**
* A 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.
*
*/
@Import(name="shardLevelMetrics")
private @Nullable Output> shardLevelMetrics;
/**
* @return A 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.
*
*/
public Optional>> shardLevelMetrics() {
return Optional.ofNullable(this.shardLevelMetrics);
}
/**
* Indicates the [capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
*
*/
@Import(name="streamModeDetails")
private @Nullable Output streamModeDetails;
/**
* @return Indicates the [capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
*
*/
public Optional> streamModeDetails() {
return Optional.ofNullable(this.streamModeDetails);
}
/**
* 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.
*
*/
@Import(name="tags")
private @Nullable Output> tags;
/**
* @return 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.
*
*/
public Optional>> tags() {
return Optional.ofNullable(this.tags);
}
/**
* A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
@Import(name="tagsAll")
private @Nullable Output> tagsAll;
/**
* @return A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Optional>> tagsAll() {
return Optional.ofNullable(this.tagsAll);
}
private StreamState() {}
private StreamState(StreamState $) {
this.arn = $.arn;
this.encryptionType = $.encryptionType;
this.enforceConsumerDeletion = $.enforceConsumerDeletion;
this.kmsKeyId = $.kmsKeyId;
this.name = $.name;
this.retentionPeriod = $.retentionPeriod;
this.shardCount = $.shardCount;
this.shardLevelMetrics = $.shardLevelMetrics;
this.streamModeDetails = $.streamModeDetails;
this.tags = $.tags;
this.tagsAll = $.tagsAll;
}
public static Builder builder() {
return new Builder();
}
public static Builder builder(StreamState defaults) {
return new Builder(defaults);
}
public static final class Builder {
private StreamState $;
public Builder() {
$ = new StreamState();
}
public Builder(StreamState defaults) {
$ = new StreamState(Objects.requireNonNull(defaults));
}
/**
* @param arn The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*
* @return builder
*
*/
public Builder arn(@Nullable Output arn) {
$.arn = arn;
return this;
}
/**
* @param arn The Amazon Resource Name (ARN) specifying the Stream (same as `id`)
*
* @return builder
*
*/
public Builder arn(String arn) {
return arn(Output.of(arn));
}
/**
* @param encryptionType The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
*
* @return builder
*
*/
public Builder encryptionType(@Nullable Output encryptionType) {
$.encryptionType = encryptionType;
return this;
}
/**
* @param encryptionType The encryption type to use. The only acceptable values are `NONE` or `KMS`. The default value is `NONE`.
*
* @return builder
*
*/
public Builder encryptionType(String encryptionType) {
return encryptionType(Output.of(encryptionType));
}
/**
* @param enforceConsumerDeletion 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`.
*
* @return builder
*
*/
public Builder enforceConsumerDeletion(@Nullable Output enforceConsumerDeletion) {
$.enforceConsumerDeletion = enforceConsumerDeletion;
return this;
}
/**
* @param enforceConsumerDeletion 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`.
*
* @return builder
*
*/
public Builder enforceConsumerDeletion(Boolean enforceConsumerDeletion) {
return enforceConsumerDeletion(Output.of(enforceConsumerDeletion));
}
/**
* @param kmsKeyId 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`.
*
* @return builder
*
*/
public Builder kmsKeyId(@Nullable Output kmsKeyId) {
$.kmsKeyId = kmsKeyId;
return this;
}
/**
* @param kmsKeyId 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`.
*
* @return builder
*
*/
public Builder kmsKeyId(String kmsKeyId) {
return kmsKeyId(Output.of(kmsKeyId));
}
/**
* @param name A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
*
* @return builder
*
*/
public Builder name(@Nullable Output name) {
$.name = name;
return this;
}
/**
* @param name A name to identify the stream. This is unique to the AWS account and region the Stream is created in.
*
* @return builder
*
*/
public Builder name(String name) {
return name(Output.of(name));
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder retentionPeriod(@Nullable Output retentionPeriod) {
$.retentionPeriod = retentionPeriod;
return this;
}
/**
* @param 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.
*
* @return builder
*
*/
public Builder retentionPeriod(Integer retentionPeriod) {
return retentionPeriod(Output.of(retentionPeriod));
}
/**
* @param shardCount 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
*
* @return builder
*
*/
public Builder shardCount(@Nullable Output shardCount) {
$.shardCount = shardCount;
return this;
}
/**
* @param shardCount 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](https://docs.aws.amazon.com/kinesis/latest/dev/amazon-kinesis-streams.html) for more.
*
* @return builder
*
*/
public Builder shardCount(Integer shardCount) {
return shardCount(Output.of(shardCount));
}
/**
* @param shardLevelMetrics A 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.
*
* @return builder
*
*/
public Builder shardLevelMetrics(@Nullable Output> shardLevelMetrics) {
$.shardLevelMetrics = shardLevelMetrics;
return this;
}
/**
* @param shardLevelMetrics A 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.
*
* @return builder
*
*/
public Builder shardLevelMetrics(List shardLevelMetrics) {
return shardLevelMetrics(Output.of(shardLevelMetrics));
}
/**
* @param shardLevelMetrics A 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.
*
* @return builder
*
*/
public Builder shardLevelMetrics(String... shardLevelMetrics) {
return shardLevelMetrics(List.of(shardLevelMetrics));
}
/**
* @param streamModeDetails Indicates the [capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
*
* @return builder
*
*/
public Builder streamModeDetails(@Nullable Output streamModeDetails) {
$.streamModeDetails = streamModeDetails;
return this;
}
/**
* @param streamModeDetails Indicates the [capacity mode](https://docs.aws.amazon.com/streams/latest/dev/how-do-i-size-a-stream.html) of the data stream. Detailed below.
*
* @return builder
*
*/
public Builder streamModeDetails(StreamStreamModeDetailsArgs streamModeDetails) {
return streamModeDetails(Output.of(streamModeDetails));
}
/**
* @param tags 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.
*
* @return builder
*
*/
public Builder tags(@Nullable Output> tags) {
$.tags = tags;
return this;
}
/**
* @param tags 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.
*
* @return builder
*
*/
public Builder tags(Map tags) {
return tags(Output.of(tags));
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(@Nullable Output> tagsAll) {
$.tagsAll = tagsAll;
return this;
}
/**
* @param tagsAll A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
*
* @return builder
*
* @deprecated
* Please use `tags` instead.
*
*/
@Deprecated /* Please use `tags` instead. */
public Builder tagsAll(Map tagsAll) {
return tagsAll(Output.of(tagsAll));
}
public StreamState build() {
return $;
}
}
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy