All Downloads are FREE. Search and download functionalities are using the official Maven repository.

com.pulumi.aws.rds.inputs.ExportTaskState Maven / Gradle / Ivy

Go to download

A Pulumi package for creating and managing Amazon Web Services (AWS) cloud resources.

There is a newer version: 6.60.0-alpha.1731982519
Show 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.rds.inputs;

import com.pulumi.aws.rds.inputs.ExportTaskTimeoutsArgs;
import com.pulumi.core.Output;
import com.pulumi.core.annotations.Import;
import java.lang.Integer;
import java.lang.String;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import javax.annotation.Nullable;


public final class ExportTaskState extends com.pulumi.resources.ResourceArgs {

    public static final ExportTaskState Empty = new ExportTaskState();

    /**
     * Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters).
     * 
     */
    @Import(name="exportOnlies")
    private @Nullable Output> exportOnlies;

    /**
     * @return Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters).
     * 
     */
    public Optional>> exportOnlies() {
        return Optional.ofNullable(this.exportOnlies);
    }

    /**
     * Unique identifier for the snapshot export task.
     * 
     */
    @Import(name="exportTaskIdentifier")
    private @Nullable Output exportTaskIdentifier;

    /**
     * @return Unique identifier for the snapshot export task.
     * 
     */
    public Optional> exportTaskIdentifier() {
        return Optional.ofNullable(this.exportTaskIdentifier);
    }

    /**
     * Reason the export failed, if it failed.
     * 
     */
    @Import(name="failureCause")
    private @Nullable Output failureCause;

    /**
     * @return Reason the export failed, if it failed.
     * 
     */
    public Optional> failureCause() {
        return Optional.ofNullable(this.failureCause);
    }

    /**
     * ARN of the IAM role to use for writing to the Amazon S3 bucket.
     * 
     */
    @Import(name="iamRoleArn")
    private @Nullable Output iamRoleArn;

    /**
     * @return ARN of the IAM role to use for writing to the Amazon S3 bucket.
     * 
     */
    public Optional> iamRoleArn() {
        return Optional.ofNullable(this.iamRoleArn);
    }

    /**
     * ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
     * 
     */
    @Import(name="kmsKeyId")
    private @Nullable Output kmsKeyId;

    /**
     * @return ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
     * 
     */
    public Optional> kmsKeyId() {
        return Optional.ofNullable(this.kmsKeyId);
    }

    /**
     * Progress of the snapshot export task as a percentage.
     * 
     */
    @Import(name="percentProgress")
    private @Nullable Output percentProgress;

    /**
     * @return Progress of the snapshot export task as a percentage.
     * 
     */
    public Optional> percentProgress() {
        return Optional.ofNullable(this.percentProgress);
    }

    /**
     * Name of the Amazon S3 bucket to export the snapshot to.
     * 
     */
    @Import(name="s3BucketName")
    private @Nullable Output s3BucketName;

    /**
     * @return Name of the Amazon S3 bucket to export the snapshot to.
     * 
     */
    public Optional> s3BucketName() {
        return Optional.ofNullable(this.s3BucketName);
    }

    /**
     * Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
     * 
     */
    @Import(name="s3Prefix")
    private @Nullable Output s3Prefix;

    /**
     * @return Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
     * 
     */
    public Optional> s3Prefix() {
        return Optional.ofNullable(this.s3Prefix);
    }

    /**
     * Time that the snapshot was created.
     * 
     */
    @Import(name="snapshotTime")
    private @Nullable Output snapshotTime;

    /**
     * @return Time that the snapshot was created.
     * 
     */
    public Optional> snapshotTime() {
        return Optional.ofNullable(this.snapshotTime);
    }

    /**
     * Amazon Resource Name (ARN) of the snapshot to export.
     * 
     * The following arguments are optional:
     * 
     */
    @Import(name="sourceArn")
    private @Nullable Output sourceArn;

    /**
     * @return Amazon Resource Name (ARN) of the snapshot to export.
     * 
     * The following arguments are optional:
     * 
     */
    public Optional> sourceArn() {
        return Optional.ofNullable(this.sourceArn);
    }

    /**
     * Type of source for the export.
     * 
     */
    @Import(name="sourceType")
    private @Nullable Output sourceType;

    /**
     * @return Type of source for the export.
     * 
     */
    public Optional> sourceType() {
        return Optional.ofNullable(this.sourceType);
    }

    /**
     * Status of the export task.
     * 
     */
    @Import(name="status")
    private @Nullable Output status;

    /**
     * @return Status of the export task.
     * 
     */
    public Optional> status() {
        return Optional.ofNullable(this.status);
    }

    /**
     * Time that the snapshot export task completed.
     * 
     */
    @Import(name="taskEndTime")
    private @Nullable Output taskEndTime;

    /**
     * @return Time that the snapshot export task completed.
     * 
     */
    public Optional> taskEndTime() {
        return Optional.ofNullable(this.taskEndTime);
    }

    /**
     * Time that the snapshot export task started.
     * 
     */
    @Import(name="taskStartTime")
    private @Nullable Output taskStartTime;

    /**
     * @return Time that the snapshot export task started.
     * 
     */
    public Optional> taskStartTime() {
        return Optional.ofNullable(this.taskStartTime);
    }

    @Import(name="timeouts")
    private @Nullable Output timeouts;

    public Optional> timeouts() {
        return Optional.ofNullable(this.timeouts);
    }

    /**
     * Warning about the snapshot export task, if any.
     * 
     */
    @Import(name="warningMessage")
    private @Nullable Output warningMessage;

    /**
     * @return Warning about the snapshot export task, if any.
     * 
     */
    public Optional> warningMessage() {
        return Optional.ofNullable(this.warningMessage);
    }

    private ExportTaskState() {}

    private ExportTaskState(ExportTaskState $) {
        this.exportOnlies = $.exportOnlies;
        this.exportTaskIdentifier = $.exportTaskIdentifier;
        this.failureCause = $.failureCause;
        this.iamRoleArn = $.iamRoleArn;
        this.kmsKeyId = $.kmsKeyId;
        this.percentProgress = $.percentProgress;
        this.s3BucketName = $.s3BucketName;
        this.s3Prefix = $.s3Prefix;
        this.snapshotTime = $.snapshotTime;
        this.sourceArn = $.sourceArn;
        this.sourceType = $.sourceType;
        this.status = $.status;
        this.taskEndTime = $.taskEndTime;
        this.taskStartTime = $.taskStartTime;
        this.timeouts = $.timeouts;
        this.warningMessage = $.warningMessage;
    }

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

    public static final class Builder {
        private ExportTaskState $;

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

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

        /**
         * @param exportOnlies Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters).
         * 
         * @return builder
         * 
         */
        public Builder exportOnlies(@Nullable Output> exportOnlies) {
            $.exportOnlies = exportOnlies;
            return this;
        }

        /**
         * @param exportOnlies Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters).
         * 
         * @return builder
         * 
         */
        public Builder exportOnlies(List exportOnlies) {
            return exportOnlies(Output.of(exportOnlies));
        }

        /**
         * @param exportOnlies Data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are documented in the [AWS StartExportTask API documentation](https://docs.aws.amazon.com/AmazonRDS/latest/APIReference/API_StartExportTask.html#API_StartExportTask_RequestParameters).
         * 
         * @return builder
         * 
         */
        public Builder exportOnlies(String... exportOnlies) {
            return exportOnlies(List.of(exportOnlies));
        }

        /**
         * @param exportTaskIdentifier Unique identifier for the snapshot export task.
         * 
         * @return builder
         * 
         */
        public Builder exportTaskIdentifier(@Nullable Output exportTaskIdentifier) {
            $.exportTaskIdentifier = exportTaskIdentifier;
            return this;
        }

        /**
         * @param exportTaskIdentifier Unique identifier for the snapshot export task.
         * 
         * @return builder
         * 
         */
        public Builder exportTaskIdentifier(String exportTaskIdentifier) {
            return exportTaskIdentifier(Output.of(exportTaskIdentifier));
        }

        /**
         * @param failureCause Reason the export failed, if it failed.
         * 
         * @return builder
         * 
         */
        public Builder failureCause(@Nullable Output failureCause) {
            $.failureCause = failureCause;
            return this;
        }

        /**
         * @param failureCause Reason the export failed, if it failed.
         * 
         * @return builder
         * 
         */
        public Builder failureCause(String failureCause) {
            return failureCause(Output.of(failureCause));
        }

        /**
         * @param iamRoleArn ARN of the IAM role to use for writing to the Amazon S3 bucket.
         * 
         * @return builder
         * 
         */
        public Builder iamRoleArn(@Nullable Output iamRoleArn) {
            $.iamRoleArn = iamRoleArn;
            return this;
        }

        /**
         * @param iamRoleArn ARN of the IAM role to use for writing to the Amazon S3 bucket.
         * 
         * @return builder
         * 
         */
        public Builder iamRoleArn(String iamRoleArn) {
            return iamRoleArn(Output.of(iamRoleArn));
        }

        /**
         * @param kmsKeyId ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
         * 
         * @return builder
         * 
         */
        public Builder kmsKeyId(@Nullable Output kmsKeyId) {
            $.kmsKeyId = kmsKeyId;
            return this;
        }

        /**
         * @param kmsKeyId ID of the Amazon Web Services KMS key to use to encrypt the snapshot.
         * 
         * @return builder
         * 
         */
        public Builder kmsKeyId(String kmsKeyId) {
            return kmsKeyId(Output.of(kmsKeyId));
        }

        /**
         * @param percentProgress Progress of the snapshot export task as a percentage.
         * 
         * @return builder
         * 
         */
        public Builder percentProgress(@Nullable Output percentProgress) {
            $.percentProgress = percentProgress;
            return this;
        }

        /**
         * @param percentProgress Progress of the snapshot export task as a percentage.
         * 
         * @return builder
         * 
         */
        public Builder percentProgress(Integer percentProgress) {
            return percentProgress(Output.of(percentProgress));
        }

        /**
         * @param s3BucketName Name of the Amazon S3 bucket to export the snapshot to.
         * 
         * @return builder
         * 
         */
        public Builder s3BucketName(@Nullable Output s3BucketName) {
            $.s3BucketName = s3BucketName;
            return this;
        }

        /**
         * @param s3BucketName Name of the Amazon S3 bucket to export the snapshot to.
         * 
         * @return builder
         * 
         */
        public Builder s3BucketName(String s3BucketName) {
            return s3BucketName(Output.of(s3BucketName));
        }

        /**
         * @param s3Prefix Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
         * 
         * @return builder
         * 
         */
        public Builder s3Prefix(@Nullable Output s3Prefix) {
            $.s3Prefix = s3Prefix;
            return this;
        }

        /**
         * @param s3Prefix Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.
         * 
         * @return builder
         * 
         */
        public Builder s3Prefix(String s3Prefix) {
            return s3Prefix(Output.of(s3Prefix));
        }

        /**
         * @param snapshotTime Time that the snapshot was created.
         * 
         * @return builder
         * 
         */
        public Builder snapshotTime(@Nullable Output snapshotTime) {
            $.snapshotTime = snapshotTime;
            return this;
        }

        /**
         * @param snapshotTime Time that the snapshot was created.
         * 
         * @return builder
         * 
         */
        public Builder snapshotTime(String snapshotTime) {
            return snapshotTime(Output.of(snapshotTime));
        }

        /**
         * @param sourceArn Amazon Resource Name (ARN) of the snapshot to export.
         * 
         * The following arguments are optional:
         * 
         * @return builder
         * 
         */
        public Builder sourceArn(@Nullable Output sourceArn) {
            $.sourceArn = sourceArn;
            return this;
        }

        /**
         * @param sourceArn Amazon Resource Name (ARN) of the snapshot to export.
         * 
         * The following arguments are optional:
         * 
         * @return builder
         * 
         */
        public Builder sourceArn(String sourceArn) {
            return sourceArn(Output.of(sourceArn));
        }

        /**
         * @param sourceType Type of source for the export.
         * 
         * @return builder
         * 
         */
        public Builder sourceType(@Nullable Output sourceType) {
            $.sourceType = sourceType;
            return this;
        }

        /**
         * @param sourceType Type of source for the export.
         * 
         * @return builder
         * 
         */
        public Builder sourceType(String sourceType) {
            return sourceType(Output.of(sourceType));
        }

        /**
         * @param status Status of the export task.
         * 
         * @return builder
         * 
         */
        public Builder status(@Nullable Output status) {
            $.status = status;
            return this;
        }

        /**
         * @param status Status of the export task.
         * 
         * @return builder
         * 
         */
        public Builder status(String status) {
            return status(Output.of(status));
        }

        /**
         * @param taskEndTime Time that the snapshot export task completed.
         * 
         * @return builder
         * 
         */
        public Builder taskEndTime(@Nullable Output taskEndTime) {
            $.taskEndTime = taskEndTime;
            return this;
        }

        /**
         * @param taskEndTime Time that the snapshot export task completed.
         * 
         * @return builder
         * 
         */
        public Builder taskEndTime(String taskEndTime) {
            return taskEndTime(Output.of(taskEndTime));
        }

        /**
         * @param taskStartTime Time that the snapshot export task started.
         * 
         * @return builder
         * 
         */
        public Builder taskStartTime(@Nullable Output taskStartTime) {
            $.taskStartTime = taskStartTime;
            return this;
        }

        /**
         * @param taskStartTime Time that the snapshot export task started.
         * 
         * @return builder
         * 
         */
        public Builder taskStartTime(String taskStartTime) {
            return taskStartTime(Output.of(taskStartTime));
        }

        public Builder timeouts(@Nullable Output timeouts) {
            $.timeouts = timeouts;
            return this;
        }

        public Builder timeouts(ExportTaskTimeoutsArgs timeouts) {
            return timeouts(Output.of(timeouts));
        }

        /**
         * @param warningMessage Warning about the snapshot export task, if any.
         * 
         * @return builder
         * 
         */
        public Builder warningMessage(@Nullable Output warningMessage) {
            $.warningMessage = warningMessage;
            return this;
        }

        /**
         * @param warningMessage Warning about the snapshot export task, if any.
         * 
         * @return builder
         * 
         */
        public Builder warningMessage(String warningMessage) {
            return warningMessage(Output.of(warningMessage));
        }

        public ExportTaskState build() {
            return $;
        }
    }

}




© 2015 - 2025 Weber Informatics LLC | Privacy Policy