com.pulumi.aws.dynamodb.outputs.TableReplica Maven / Gradle / Ivy

Go to download
// *** 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.dynamodb.outputs;

import com.pulumi.core.annotations.CustomType;
import com.pulumi.exceptions.MissingRequiredPropertyException;
import java.lang.Boolean;
import java.lang.String;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;

@CustomType
public final class TableReplica {
    /**
     * @return ARN of the table
     * 
     */
    private @Nullable String arn;
    /**
     * @return ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys.
     * 
     */
    private @Nullable String kmsKeyArn;
    /**
     * @return Whether to enable Point In Time Recovery for the replica. Default is `false`.
     * 
     */
    private @Nullable Boolean pointInTimeRecovery;
    /**
     * @return Whether to propagate the global table's tags to a replica. Default is `false`. Changes to tags only move in one direction: from global (source) to replica. In other words, tag drift on a replica will not trigger an update. Tag or replica changes on the global table, whether from drift or configuration changes, are propagated to replicas. Changing from `true` to `false` on a subsequent `apply` means replica tags are left as they were, unmanaged, not deleted.
     * 
     */
    private @Nullable Boolean propagateTags;
    /**
     * @return Region name of the replica.
     * 
     */
    private String regionName;
    /**
     * @return ARN of the Table Stream. Only available when `stream_enabled = true`
     * 
     */
    private @Nullable String streamArn;
    /**
     * @return Timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `stream_enabled = true`.
     * 
     */
    private @Nullable String streamLabel;

    private TableReplica() {}
    /**
     * @return ARN of the table
     * 
     */
    public Optional arn() {
        return Optional.ofNullable(this.arn);
    }
    /**
     * @return ARN of the CMK that should be used for the AWS KMS encryption. This argument should only be used if the key is different from the default KMS-managed DynamoDB key, `alias/aws/dynamodb`. **Note:** This attribute will _not_ be populated with the ARN of _default_ keys.
     * 
     */
    public Optional kmsKeyArn() {
        return Optional.ofNullable(this.kmsKeyArn);
    }
    /**
     * @return Whether to enable Point In Time Recovery for the replica. Default is `false`.
     * 
     */
    public Optional pointInTimeRecovery() {
        return Optional.ofNullable(this.pointInTimeRecovery);
    }
    /**
     * @return Whether to propagate the global table's tags to a replica. Default is `false`. Changes to tags only move in one direction: from global (source) to replica. In other words, tag drift on a replica will not trigger an update. Tag or replica changes on the global table, whether from drift or configuration changes, are propagated to replicas. Changing from `true` to `false` on a subsequent `apply` means replica tags are left as they were, unmanaged, not deleted.
     * 
     */
    public Optional propagateTags() {
        return Optional.ofNullable(this.propagateTags);
    }
    /**
     * @return Region name of the replica.
     * 
     */
    public String regionName() {
        return this.regionName;
    }
    /**
     * @return ARN of the Table Stream. Only available when `stream_enabled = true`
     * 
     */
    public Optional streamArn() {
        return Optional.ofNullable(this.streamArn);
    }
    /**
     * @return Timestamp, in ISO 8601 format, for this stream. Note that this timestamp is not a unique identifier for the stream on its own. However, the combination of AWS customer ID, table name and this field is guaranteed to be unique. It can be used for creating CloudWatch Alarms. Only available when `stream_enabled = true`.
     * 
     */
    public Optional streamLabel() {
        return Optional.ofNullable(this.streamLabel);
    }

    public static Builder builder() {
        return new Builder();
    }

    public static Builder builder(TableReplica defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private @Nullable String arn;
        private @Nullable String kmsKeyArn;
        private @Nullable Boolean pointInTimeRecovery;
        private @Nullable Boolean propagateTags;
        private String regionName;
        private @Nullable String streamArn;
        private @Nullable String streamLabel;
        public Builder() {}
        public Builder(TableReplica defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.arn = defaults.arn;
    	      this.kmsKeyArn = defaults.kmsKeyArn;
    	      this.pointInTimeRecovery = defaults.pointInTimeRecovery;
    	      this.propagateTags = defaults.propagateTags;
    	      this.regionName = defaults.regionName;
    	      this.streamArn = defaults.streamArn;
    	      this.streamLabel = defaults.streamLabel;
        }

        @CustomType.Setter
        public Builder arn(@Nullable String arn) {

            this.arn = arn;
            return this;
        }
        @CustomType.Setter
        public Builder kmsKeyArn(@Nullable String kmsKeyArn) {

            this.kmsKeyArn = kmsKeyArn;
            return this;
        }
        @CustomType.Setter
        public Builder pointInTimeRecovery(@Nullable Boolean pointInTimeRecovery) {

            this.pointInTimeRecovery = pointInTimeRecovery;
            return this;
        }
        @CustomType.Setter
        public Builder propagateTags(@Nullable Boolean propagateTags) {

            this.propagateTags = propagateTags;
            return this;
        }
        @CustomType.Setter
        public Builder regionName(String regionName) {
            if (regionName == null) {
              throw new MissingRequiredPropertyException("TableReplica", "regionName");
            }
            this.regionName = regionName;
            return this;
        }
        @CustomType.Setter
        public Builder streamArn(@Nullable String streamArn) {

            this.streamArn = streamArn;
            return this;
        }
        @CustomType.Setter
        public Builder streamLabel(@Nullable String streamLabel) {

            this.streamLabel = streamLabel;
            return this;
        }
        public TableReplica build() {
            final var _resultValue = new TableReplica();
            _resultValue.arn = arn;
            _resultValue.kmsKeyArn = kmsKeyArn;
            _resultValue.pointInTimeRecovery = pointInTimeRecovery;
            _resultValue.propagateTags = propagateTags;
            _resultValue.regionName = regionName;
            _resultValue.streamArn = streamArn;
            _resultValue.streamLabel = streamLabel;
            return _resultValue;
        }
    }
}