1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
pub use crate::operation::start_export_task::_start_export_task_output::StartExportTaskOutputBuilder;
pub use crate::operation::start_export_task::_start_export_task_input::StartExportTaskInputBuilder;
/// Fluent builder constructing a request to `StartExportTask`.
///
/// <p>Starts an export of a snapshot to Amazon S3. The provided IAM role must have access to the S3 bucket.</p>
/// <p>This command doesn't apply to RDS Custom.</p>
#[derive(std::clone::Clone, std::fmt::Debug)]
pub struct StartExportTaskFluentBuilder {
handle: std::sync::Arc<crate::client::Handle>,
inner: crate::operation::start_export_task::builders::StartExportTaskInputBuilder,
}
impl StartExportTaskFluentBuilder {
/// Creates a new `StartExportTask`.
pub(crate) fn new(handle: std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: Default::default(),
}
}
/// Consume this builder, creating a customizable operation that can be modified before being
/// sent. The operation's inner [http::Request] can be modified as well.
pub async fn customize(
self,
) -> std::result::Result<
crate::client::customize::CustomizableOperation<
crate::operation::start_export_task::StartExportTask,
aws_http::retry::AwsResponseRetryClassifier,
>,
aws_smithy_http::result::SdkError<
crate::operation::start_export_task::StartExportTaskError,
>,
> {
let handle = self.handle.clone();
let operation = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
Ok(crate::client::customize::CustomizableOperation { handle, operation })
}
/// Sends the request and returns the response.
///
/// If an error occurs, an `SdkError` will be returned with additional details that
/// can be matched against.
///
/// By default, any retryable failures will be retried twice. Retry behavior
/// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
/// set when configuring the client.
pub async fn send(
self,
) -> std::result::Result<
crate::operation::start_export_task::StartExportTaskOutput,
aws_smithy_http::result::SdkError<
crate::operation::start_export_task::StartExportTaskError,
>,
> {
let op = self
.inner
.build()
.map_err(aws_smithy_http::result::SdkError::construction_failure)?
.make_operation(&self.handle.conf)
.await
.map_err(aws_smithy_http::result::SdkError::construction_failure)?;
self.handle.client.call(op).await
}
/// <p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.</p>
pub fn export_task_identifier(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.export_task_identifier(input.into());
self
}
/// <p>A unique identifier for the snapshot export task. This ID isn't an identifier for the Amazon S3 bucket where the snapshot is to be exported to.</p>
pub fn set_export_task_identifier(
mut self,
input: std::option::Option<std::string::String>,
) -> Self {
self.inner = self.inner.set_export_task_identifier(input);
self
}
/// <p>The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.</p>
pub fn source_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.source_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the snapshot to export to Amazon S3.</p>
pub fn set_source_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_source_arn(input);
self
}
/// <p>The name of the Amazon S3 bucket to export the snapshot to.</p>
pub fn s3_bucket_name(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.s3_bucket_name(input.into());
self
}
/// <p>The name of the Amazon S3 bucket to export the snapshot to.</p>
pub fn set_s3_bucket_name(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_s3_bucket_name(input);
self
}
/// <p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.</p>
pub fn iam_role_arn(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.iam_role_arn(input.into());
self
}
/// <p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot.</p>
pub fn set_iam_role_arn(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_iam_role_arn(input);
self
}
/// <p>The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:</p>
/// <ul>
/// <li> <p>kms:Encrypt</p> </li>
/// <li> <p>kms:Decrypt</p> </li>
/// <li> <p>kms:GenerateDataKey</p> </li>
/// <li> <p>kms:GenerateDataKeyWithoutPlaintext</p> </li>
/// <li> <p>kms:ReEncryptFrom</p> </li>
/// <li> <p>kms:ReEncryptTo</p> </li>
/// <li> <p>kms:CreateGrant</p> </li>
/// <li> <p>kms:DescribeKey</p> </li>
/// <li> <p>kms:RetireGrant</p> </li>
/// </ul>
pub fn kms_key_id(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.kms_key_id(input.into());
self
}
/// <p>The ID of the Amazon Web Services KMS key to use to encrypt the snapshot exported to Amazon S3. The Amazon Web Services KMS key identifier is the key ARN, key ID, alias ARN, or alias name for the KMS key. The caller of this operation must be authorized to run the following operations. These can be set in the Amazon Web Services KMS key policy:</p>
/// <ul>
/// <li> <p>kms:Encrypt</p> </li>
/// <li> <p>kms:Decrypt</p> </li>
/// <li> <p>kms:GenerateDataKey</p> </li>
/// <li> <p>kms:GenerateDataKeyWithoutPlaintext</p> </li>
/// <li> <p>kms:ReEncryptFrom</p> </li>
/// <li> <p>kms:ReEncryptTo</p> </li>
/// <li> <p>kms:CreateGrant</p> </li>
/// <li> <p>kms:DescribeKey</p> </li>
/// <li> <p>kms:RetireGrant</p> </li>
/// </ul>
pub fn set_kms_key_id(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_kms_key_id(input);
self
}
/// <p>The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.</p>
pub fn s3_prefix(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.s3_prefix(input.into());
self
}
/// <p>The Amazon S3 bucket prefix to use as the file name and path of the exported snapshot.</p>
pub fn set_s3_prefix(mut self, input: std::option::Option<std::string::String>) -> Self {
self.inner = self.inner.set_s3_prefix(input);
self
}
/// Appends an item to `ExportOnly`.
///
/// To override the contents of this collection use [`set_export_only`](Self::set_export_only).
///
/// <p>The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:</p>
/// <ul>
/// <li> <p> <code>database</code> - Export all the data from a specified database.</p> </li>
/// <li> <p> <code>database.table</code> <i>table-name</i> - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p> </li>
/// <li> <p> <code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li>
/// <li> <p> <code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li>
/// </ul>
pub fn export_only(mut self, input: impl Into<std::string::String>) -> Self {
self.inner = self.inner.export_only(input.into());
self
}
/// <p>The data to be exported from the snapshot. If this parameter is not provided, all the snapshot data is exported. Valid values are the following:</p>
/// <ul>
/// <li> <p> <code>database</code> - Export all the data from a specified database.</p> </li>
/// <li> <p> <code>database.table</code> <i>table-name</i> - Export a table of the snapshot. This format is valid only for RDS for MySQL, RDS for MariaDB, and Aurora MySQL.</p> </li>
/// <li> <p> <code>database.schema</code> <i>schema-name</i> - Export a database schema of the snapshot. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li>
/// <li> <p> <code>database.schema.table</code> <i>table-name</i> - Export a table of the database schema. This format is valid only for RDS for PostgreSQL and Aurora PostgreSQL.</p> </li>
/// </ul>
pub fn set_export_only(
mut self,
input: std::option::Option<std::vec::Vec<std::string::String>>,
) -> Self {
self.inner = self.inner.set_export_only(input);
self
}
}