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 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370
// 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;
impl StartExportTaskInputBuilder {
/// Sends a request with this input using the given client.
pub async fn send_with(
self,
client: &crate::Client,
) -> ::std::result::Result<
crate::operation::start_export_task::StartExportTaskOutput,
::aws_smithy_runtime_api::client::result::SdkError<
crate::operation::start_export_task::StartExportTaskError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let mut fluent_builder = client.start_export_task();
fluent_builder.inner = self;
fluent_builder.send().await
}
}
/// Fluent builder constructing a request to `StartExportTask`.
///
/// <p>Starts an export of DB snapshot or DB cluster data to Amazon S3. The provided IAM role must have access to the S3 bucket.</p>
/// <p>You can't export snapshot data from Db2 or RDS Custom DB instances.</p>
/// <p>You can't export cluster data from Multi-AZ DB clusters.</p>
/// <p>For more information on exporting DB snapshot data, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/UserGuide/USER_ExportSnapshot.html">Exporting DB snapshot data to Amazon S3</a> in the <i>Amazon RDS User Guide</i> or <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/aurora-export-snapshot.html">Exporting DB cluster snapshot data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</p>
/// <p>For more information on exporting DB cluster data, see <a href="https://docs.aws.amazon.com/AmazonRDS/latest/AuroraUserGuide/export-cluster-data.html">Exporting DB cluster data to Amazon S3</a> in the <i>Amazon Aurora User Guide</i>.</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,
config_override: ::std::option::Option<crate::config::Builder>,
}
impl
crate::client::customize::internal::CustomizableSend<
crate::operation::start_export_task::StartExportTaskOutput,
crate::operation::start_export_task::StartExportTaskError,
> for StartExportTaskFluentBuilder
{
fn send(
self,
config_override: crate::config::Builder,
) -> crate::client::customize::internal::BoxFuture<
crate::client::customize::internal::SendResult<
crate::operation::start_export_task::StartExportTaskOutput,
crate::operation::start_export_task::StartExportTaskError,
>,
> {
::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
}
}
impl StartExportTaskFluentBuilder {
/// Creates a new `StartExportTask`.
pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
Self {
handle,
inner: ::std::default::Default::default(),
config_override: ::std::option::Option::None,
}
}
/// Access the StartExportTask as a reference.
pub fn as_input(&self) -> &crate::operation::start_export_task::builders::StartExportTaskInputBuilder {
&self.inner
}
/// 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_runtime_api::client::result::SdkError<
crate::operation::start_export_task::StartExportTaskError,
::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
>,
> {
let input = self
.inner
.build()
.map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
let runtime_plugins = crate::operation::start_export_task::StartExportTask::operation_runtime_plugins(
self.handle.runtime_plugins.clone(),
&self.handle.conf,
self.config_override,
);
crate::operation::start_export_task::StartExportTask::orchestrate(&runtime_plugins, input).await
}
/// Consumes this builder, creating a customizable operation that can be modified before being sent.
pub fn customize(
self,
) -> crate::client::customize::CustomizableOperation<
crate::operation::start_export_task::StartExportTaskOutput,
crate::operation::start_export_task::StartExportTaskError,
Self,
> {
crate::client::customize::CustomizableOperation::new(self)
}
pub(crate) fn config_override(mut self, config_override: impl Into<crate::config::Builder>) -> Self {
self.set_config_override(Some(config_override.into()));
self
}
pub(crate) fn set_config_override(&mut self, config_override: Option<crate::config::Builder>) -> &mut Self {
self.config_override = config_override;
self
}
/// <p>A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.</p>
pub fn export_task_identifier(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.export_task_identifier(input.into());
self
}
/// <p>A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.</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>A unique identifier for the export task. This ID isn't an identifier for the Amazon S3 bucket where the data is to be exported.</p>
pub fn get_export_task_identifier(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_export_task_identifier()
}
/// <p>The Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.</p>
pub fn source_arn(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.source_arn(input.into());
self
}
/// <p>The Amazon Resource Name (ARN) of the snapshot or cluster 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 Amazon Resource Name (ARN) of the snapshot or cluster to export to Amazon S3.</p>
pub fn get_source_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_source_arn()
}
/// <p>The name of the Amazon S3 bucket to export the snapshot or cluster data to.</p>
pub fn s3_bucket_name(mut self, input: impl ::std::convert::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 or cluster data 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 Amazon S3 bucket to export the snapshot or cluster data to.</p>
pub fn get_s3_bucket_name(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_s3_bucket_name()
}
/// <p>The name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.</p>
/// <p>In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:</p>
/// <ul>
/// <li>
/// <p>s3:PutObject*</p></li>
/// <li>
/// <p>s3:GetObject*</p></li>
/// <li>
/// <p>s3:ListBucket</p></li>
/// <li>
/// <p>s3:DeleteObject*</p></li>
/// <li>
/// <p>s3:GetBucketLocation</p></li>
/// </ul>
/// <p>In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:</p>
/// <ul>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i> </code></p></li>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i>/*</code></p></li>
/// </ul>
pub fn iam_role_arn(mut self, input: impl ::std::convert::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 or cluster.</p>
/// <p>In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:</p>
/// <ul>
/// <li>
/// <p>s3:PutObject*</p></li>
/// <li>
/// <p>s3:GetObject*</p></li>
/// <li>
/// <p>s3:ListBucket</p></li>
/// <li>
/// <p>s3:DeleteObject*</p></li>
/// <li>
/// <p>s3:GetBucketLocation</p></li>
/// </ul>
/// <p>In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:</p>
/// <ul>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i> </code></p></li>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i>/*</code></p></li>
/// </ul>
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 name of the IAM role to use for writing to the Amazon S3 bucket when exporting a snapshot or cluster.</p>
/// <p>In the IAM policy attached to your IAM role, include the following required actions to allow the transfer of files from Amazon RDS or Amazon Aurora to an S3 bucket:</p>
/// <ul>
/// <li>
/// <p>s3:PutObject*</p></li>
/// <li>
/// <p>s3:GetObject*</p></li>
/// <li>
/// <p>s3:ListBucket</p></li>
/// <li>
/// <p>s3:DeleteObject*</p></li>
/// <li>
/// <p>s3:GetBucketLocation</p></li>
/// </ul>
/// <p>In the policy, include the resources to identify the S3 bucket and objects in the bucket. The following list of resources shows the Amazon Resource Name (ARN) format for accessing S3:</p>
/// <ul>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i> </code></p></li>
/// <li>
/// <p><code>arn:aws:s3:::<i>your-s3-bucket</i>/*</code></p></li>
/// </ul>
pub fn get_iam_role_arn(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_iam_role_arn()
}
/// <p>The ID of the Amazon Web Services KMS key to use to encrypt the data 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 ::std::convert::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 data 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 ID of the Amazon Web Services KMS key to use to encrypt the data 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 get_kms_key_id(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_kms_key_id()
}
/// <p>The Amazon S3 bucket prefix to use as the file name and path of the exported data.</p>
pub fn s3_prefix(mut self, input: impl ::std::convert::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 data.</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
}
/// <p>The Amazon S3 bucket prefix to use as the file name and path of the exported data.</p>
pub fn get_s3_prefix(&self) -> &::std::option::Option<::std::string::String> {
self.inner.get_s3_prefix()
}
/// 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 or cluster. If this parameter isn't provided, all of the data is exported.</p>
/// <p>Valid Values:</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 or cluster. 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 or cluster. 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 ::std::convert::Into<::std::string::String>) -> Self {
self.inner = self.inner.export_only(input.into());
self
}
/// <p>The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.</p>
/// <p>Valid Values:</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 or cluster. 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 or cluster. 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
}
/// <p>The data to be exported from the snapshot or cluster. If this parameter isn't provided, all of the data is exported.</p>
/// <p>Valid Values:</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 or cluster. 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 or cluster. 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 get_export_only(&self) -> &::std::option::Option<::std::vec::Vec<::std::string::String>> {
self.inner.get_export_only()
}
}