aws_sdk_rds/client/
modify_db_snapshot_attribute.rs

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`ModifyDBSnapshotAttribute`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`db_snapshot_identifier(impl Into<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::db_snapshot_identifier) / [`set_db_snapshot_identifier(Option<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::set_db_snapshot_identifier):<br>required: **true**<br><p>The identifier for the DB snapshot to modify the attributes for.</p><br>
    ///   - [`attribute_name(impl Into<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::attribute_name) / [`set_attribute_name(Option<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::set_attribute_name):<br>required: **true**<br><p>The name of the DB snapshot attribute to modify.</p> <p>To manage authorization for other Amazon Web Services accounts to copy or restore a manual DB snapshot, set this value to <code>restore</code>.</p><note>  <p>To view the list of attributes available to modify, use the <code>DescribeDBSnapshotAttributes</code> API operation.</p> </note><br>
    ///   - [`values_to_add(impl Into<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::values_to_add) / [`set_values_to_add(Option<Vec::<String>>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::set_values_to_add):<br>required: **false**<br><p>A list of DB snapshot attributes to add to the attribute specified by <code>AttributeName</code>.</p> <p>To authorize other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account IDs, or <code>all</code> to make the manual DB snapshot restorable by any Amazon Web Services account. Do not add the <code>all</code> value for any manual DB snapshots that contain private information that you don't want available to all Amazon Web Services accounts.</p><br>
    ///   - [`values_to_remove(impl Into<String>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::values_to_remove) / [`set_values_to_remove(Option<Vec::<String>>)`](crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::set_values_to_remove):<br>required: **false**<br><p>A list of DB snapshot attributes to remove from the attribute specified by <code>AttributeName</code>.</p> <p>To remove authorization for other Amazon Web Services accounts to copy or restore a manual snapshot, set this list to include one or more Amazon Web Services account identifiers, or <code>all</code> to remove authorization for any Amazon Web Services account to copy or restore the DB snapshot. If you specify <code>all</code>, an Amazon Web Services account whose account ID is explicitly added to the <code>restore</code> attribute can still copy or restore the manual DB snapshot.</p><br>
    /// - On success, responds with [`ModifyDbSnapshotAttributeOutput`](crate::operation::modify_db_snapshot_attribute::ModifyDbSnapshotAttributeOutput) with field(s):
    ///   - [`db_snapshot_attributes_result(Option<DbSnapshotAttributesResult>)`](crate::operation::modify_db_snapshot_attribute::ModifyDbSnapshotAttributeOutput::db_snapshot_attributes_result): <p>Contains the results of a successful call to the <code>DescribeDBSnapshotAttributes</code> API action.</p> <p>Manual DB snapshot attributes are used to authorize other Amazon Web Services accounts to copy or restore a manual DB snapshot. For more information, see the <code>ModifyDBSnapshotAttribute</code> API action.</p>
    /// - On failure, responds with [`SdkError<ModifyDBSnapshotAttributeError>`](crate::operation::modify_db_snapshot_attribute::ModifyDBSnapshotAttributeError)
    pub fn modify_db_snapshot_attribute(&self) -> crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder {
        crate::operation::modify_db_snapshot_attribute::builders::ModifyDBSnapshotAttributeFluentBuilder::new(self.handle.clone())
    }
}