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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of aws Show documentation
A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.
There is a newer version: 6.60.0-alpha.1731982519
// *** 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.String;
import java.util.List;
import java.util.Objects;
import javax.annotation.Nullable;

@CustomType
public final class TableLocalSecondaryIndex {
    /**
     * @return Name of the index
     * 
     */
    private String name;
    /**
     * @return Only required with `INCLUDE` as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.
     * 
     */
    private @Nullable List nonKeyAttributes;
    /**
     * @return One of `ALL`, `INCLUDE` or `KEYS_ONLY` where `ALL` projects every attribute into the index, `KEYS_ONLY` projects  into the index only the table and index hash_key and sort_key attributes ,  `INCLUDE` projects into the index all of the attributes that are defined in `non_key_attributes` in addition to the attributes that that`KEYS_ONLY` project.
     * 
     */
    private String projectionType;
    /**
     * @return Name of the range key.
     * 
     */
    private String rangeKey;

    private TableLocalSecondaryIndex() {}
    /**
     * @return Name of the index
     * 
     */
    public String name() {
        return this.name;
    }
    /**
     * @return Only required with `INCLUDE` as a projection type; a list of attributes to project into the index. These do not need to be defined as attributes on the table.
     * 
     */
    public List nonKeyAttributes() {
        return this.nonKeyAttributes == null ? List.of() : this.nonKeyAttributes;
    }
    /**
     * @return One of `ALL`, `INCLUDE` or `KEYS_ONLY` where `ALL` projects every attribute into the index, `KEYS_ONLY` projects  into the index only the table and index hash_key and sort_key attributes ,  `INCLUDE` projects into the index all of the attributes that are defined in `non_key_attributes` in addition to the attributes that that`KEYS_ONLY` project.
     * 
     */
    public String projectionType() {
        return this.projectionType;
    }
    /**
     * @return Name of the range key.
     * 
     */
    public String rangeKey() {
        return this.rangeKey;
    }

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

    public static Builder builder(TableLocalSecondaryIndex defaults) {
        return new Builder(defaults);
    }
    @CustomType.Builder
    public static final class Builder {
        private String name;
        private @Nullable List nonKeyAttributes;
        private String projectionType;
        private String rangeKey;
        public Builder() {}
        public Builder(TableLocalSecondaryIndex defaults) {
    	      Objects.requireNonNull(defaults);
    	      this.name = defaults.name;
    	      this.nonKeyAttributes = defaults.nonKeyAttributes;
    	      this.projectionType = defaults.projectionType;
    	      this.rangeKey = defaults.rangeKey;
        }

        @CustomType.Setter
        public Builder name(String name) {
            if (name == null) {
              throw new MissingRequiredPropertyException("TableLocalSecondaryIndex", "name");
            }
            this.name = name;
            return this;
        }
        @CustomType.Setter
        public Builder nonKeyAttributes(@Nullable List nonKeyAttributes) {

            this.nonKeyAttributes = nonKeyAttributes;
            return this;
        }
        public Builder nonKeyAttributes(String... nonKeyAttributes) {
            return nonKeyAttributes(List.of(nonKeyAttributes));
        }
        @CustomType.Setter
        public Builder projectionType(String projectionType) {
            if (projectionType == null) {
              throw new MissingRequiredPropertyException("TableLocalSecondaryIndex", "projectionType");
            }
            this.projectionType = projectionType;
            return this;
        }
        @CustomType.Setter
        public Builder rangeKey(String rangeKey) {
            if (rangeKey == null) {
              throw new MissingRequiredPropertyException("TableLocalSecondaryIndex", "rangeKey");
            }
            this.rangeKey = rangeKey;
            return this;
        }
        public TableLocalSecondaryIndex build() {
            final var _resultValue = new TableLocalSecondaryIndex();
            _resultValue.name = name;
            _resultValue.nonKeyAttributes = nonKeyAttributes;
            _resultValue.projectionType = projectionType;
            _resultValue.rangeKey = rangeKey;
            return _resultValue;
        }
    }
}