com.pulumi.aws.rds.inputs.GetSnapshotArgs 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.66.3
// *** 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.rds.inputs;

import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Boolean;
import java.lang.String;
import java.util.Map;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class GetSnapshotArgs extends com.pulumi.resources.InvokeArgs {

    public static final GetSnapshotArgs Empty = new GetSnapshotArgs();

    /**
     * Returns the list of snapshots created by the specific db_instance
     * 
     */
    @Import(name="dbInstanceIdentifier")
    private @Nullable Output dbInstanceIdentifier;

    /**
     * @return Returns the list of snapshots created by the specific db_instance
     * 
     */
    public Optional> dbInstanceIdentifier() {
        return Optional.ofNullable(this.dbInstanceIdentifier);
    }

    /**
     * Returns information on a specific snapshot_id.
     * 
     */
    @Import(name="dbSnapshotIdentifier")
    private @Nullable Output dbSnapshotIdentifier;

    /**
     * @return Returns information on a specific snapshot_id.
     * 
     */
    public Optional> dbSnapshotIdentifier() {
        return Optional.ofNullable(this.dbSnapshotIdentifier);
    }

    /**
     * Set this value to true to include manual DB snapshots that are public and can be
     * copied or restored by any AWS account, otherwise set this value to false. The default is `false`.
     * 
     */
    @Import(name="includePublic")
    private @Nullable Output includePublic;

    /**
     * @return Set this value to true to include manual DB snapshots that are public and can be
     * copied or restored by any AWS account, otherwise set this value to false. The default is `false`.
     * 
     */
    public Optional> includePublic() {
        return Optional.ofNullable(this.includePublic);
    }

    /**
     * Set this value to true to include shared manual DB snapshots from other
     * AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
     * The default is `false`.
     * 
     */
    @Import(name="includeShared")
    private @Nullable Output includeShared;

    /**
     * @return Set this value to true to include shared manual DB snapshots from other
     * AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
     * The default is `false`.
     * 
     */
    public Optional> includeShared() {
        return Optional.ofNullable(this.includeShared);
    }

    /**
     * If more than one result is returned, use the most
     * recent Snapshot.
     * 
     */
    @Import(name="mostRecent")
    private @Nullable Output mostRecent;

    /**
     * @return If more than one result is returned, use the most
     * recent Snapshot.
     * 
     */
    public Optional> mostRecent() {
        return Optional.ofNullable(this.mostRecent);
    }

    /**
     * Type of snapshots to be returned. If you don't specify a SnapshotType
     * value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not
     * included in the returned results by default. Possible values are, `automated`, `manual`, `shared`, `public` and `awsbackup`.
     * 
     */
    @Import(name="snapshotType")
    private @Nullable Output snapshotType;

    /**
     * @return Type of snapshots to be returned. If you don't specify a SnapshotType
     * value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not
     * included in the returned results by default. Possible values are, `automated`, `manual`, `shared`, `public` and `awsbackup`.
     * 
     */
    public Optional> snapshotType() {
        return Optional.ofNullable(this.snapshotType);
    }

    /**
     * Mapping of tags, each pair of which must exactly match
     * a pair on the desired DB snapshot.
     * 
     */
    @Import(name="tags")
    private @Nullable Output> tags;

    /**
     * @return Mapping of tags, each pair of which must exactly match
     * a pair on the desired DB snapshot.
     * 
     */
    public Optional>> tags() {
        return Optional.ofNullable(this.tags);
    }

    private GetSnapshotArgs() {}

    private GetSnapshotArgs(GetSnapshotArgs $) {
        this.dbInstanceIdentifier = $.dbInstanceIdentifier;
        this.dbSnapshotIdentifier = $.dbSnapshotIdentifier;
        this.includePublic = $.includePublic;
        this.includeShared = $.includeShared;
        this.mostRecent = $.mostRecent;
        this.snapshotType = $.snapshotType;
        this.tags = $.tags;
    }

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

    public static final class Builder {
        private GetSnapshotArgs $;

        public Builder() {
            $ = new GetSnapshotArgs();
        }

        public Builder(GetSnapshotArgs defaults) {
            $ = new GetSnapshotArgs(Objects.requireNonNull(defaults));
        }

        /**
         * @param dbInstanceIdentifier Returns the list of snapshots created by the specific db_instance
         * 
         * @return builder
         * 
         */
        public Builder dbInstanceIdentifier(@Nullable Output dbInstanceIdentifier) {
            $.dbInstanceIdentifier = dbInstanceIdentifier;
            return this;
        }

        /**
         * @param dbInstanceIdentifier Returns the list of snapshots created by the specific db_instance
         * 
         * @return builder
         * 
         */
        public Builder dbInstanceIdentifier(String dbInstanceIdentifier) {
            return dbInstanceIdentifier(Output.of(dbInstanceIdentifier));
        }

        /**
         * @param dbSnapshotIdentifier Returns information on a specific snapshot_id.
         * 
         * @return builder
         * 
         */
        public Builder dbSnapshotIdentifier(@Nullable Output dbSnapshotIdentifier) {
            $.dbSnapshotIdentifier = dbSnapshotIdentifier;
            return this;
        }

        /**
         * @param dbSnapshotIdentifier Returns information on a specific snapshot_id.
         * 
         * @return builder
         * 
         */
        public Builder dbSnapshotIdentifier(String dbSnapshotIdentifier) {
            return dbSnapshotIdentifier(Output.of(dbSnapshotIdentifier));
        }

        /**
         * @param includePublic Set this value to true to include manual DB snapshots that are public and can be
         * copied or restored by any AWS account, otherwise set this value to false. The default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder includePublic(@Nullable Output includePublic) {
            $.includePublic = includePublic;
            return this;
        }

        /**
         * @param includePublic Set this value to true to include manual DB snapshots that are public and can be
         * copied or restored by any AWS account, otherwise set this value to false. The default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder includePublic(Boolean includePublic) {
            return includePublic(Output.of(includePublic));
        }

        /**
         * @param includeShared Set this value to true to include shared manual DB snapshots from other
         * AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
         * The default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder includeShared(@Nullable Output includeShared) {
            $.includeShared = includeShared;
            return this;
        }

        /**
         * @param includeShared Set this value to true to include shared manual DB snapshots from other
         * AWS accounts that this AWS account has been given permission to copy or restore, otherwise set this value to false.
         * The default is `false`.
         * 
         * @return builder
         * 
         */
        public Builder includeShared(Boolean includeShared) {
            return includeShared(Output.of(includeShared));
        }

        /**
         * @param mostRecent If more than one result is returned, use the most
         * recent Snapshot.
         * 
         * @return builder
         * 
         */
        public Builder mostRecent(@Nullable Output mostRecent) {
            $.mostRecent = mostRecent;
            return this;
        }

        /**
         * @param mostRecent If more than one result is returned, use the most
         * recent Snapshot.
         * 
         * @return builder
         * 
         */
        public Builder mostRecent(Boolean mostRecent) {
            return mostRecent(Output.of(mostRecent));
        }

        /**
         * @param snapshotType Type of snapshots to be returned. If you don't specify a SnapshotType
         * value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not
         * included in the returned results by default. Possible values are, `automated`, `manual`, `shared`, `public` and `awsbackup`.
         * 
         * @return builder
         * 
         */
        public Builder snapshotType(@Nullable Output snapshotType) {
            $.snapshotType = snapshotType;
            return this;
        }

        /**
         * @param snapshotType Type of snapshots to be returned. If you don't specify a SnapshotType
         * value, then both automated and manual snapshots are returned. Shared and public DB snapshots are not
         * included in the returned results by default. Possible values are, `automated`, `manual`, `shared`, `public` and `awsbackup`.
         * 
         * @return builder
         * 
         */
        public Builder snapshotType(String snapshotType) {
            return snapshotType(Output.of(snapshotType));
        }

        /**
         * @param tags Mapping of tags, each pair of which must exactly match
         * a pair on the desired DB snapshot.
         * 
         * @return builder
         * 
         */
        public Builder tags(@Nullable Output> tags) {
            $.tags = tags;
            return this;
        }

        /**
         * @param tags Mapping of tags, each pair of which must exactly match
         * a pair on the desired DB snapshot.
         * 
         * @return builder
         * 
         */
        public Builder tags(Map tags) {
            return tags(Output.of(tags));
        }

        public GetSnapshotArgs build() {
            return $;
        }
    }

}