aws_sdk_ec2/client/

create_snapshots.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`CreateSnapshots`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`description(impl Into<String>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_description):<br>required: **false**<br><p>A description propagated to every snapshot specified by the instance.</p><br>
    ///   - [`instance_specification(InstanceSpecification)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::instance_specification) / [`set_instance_specification(Option<InstanceSpecification>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_instance_specification):<br>required: **true**<br><p>The instance to specify which volumes should be included in the snapshots.</p><br>
    ///   - [`outpost_arn(impl Into<String>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::outpost_arn) / [`set_outpost_arn(Option<String>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_outpost_arn):<br>required: **false**<br><note>  <p>Only supported for instances on Outposts. If the source instance is not on an Outpost, omit this parameter.</p> </note> <ul>  <li>   <p>To create the snapshots on the same Outpost as the source instance, specify the ARN of that Outpost. The snapshots must be created on the same Outpost as the instance.</p></li>  <li>   <p>To create the snapshots in the parent Region of the Outpost, omit this parameter.</p></li> </ul> <p>For more information, see <a href="https://docs.aws.amazon.com/ebs/latest/userguide/snapshots-outposts.html#create-snapshot"> Create local snapshots from volumes on an Outpost</a> in the <i>Amazon EBS User Guide</i>.</p><br>
    ///   - [`tag_specifications(TagSpecification)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::tag_specifications) / [`set_tag_specifications(Option<Vec::<TagSpecification>>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_tag_specifications):<br>required: **false**<br><p>Tags to apply to every snapshot specified by the instance.</p><br>
    ///   - [`dry_run(bool)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::dry_run) / [`set_dry_run(Option<bool>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_dry_run):<br>required: **false**<br><p>Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is <code>DryRunOperation</code>. Otherwise, it is <code>UnauthorizedOperation</code>.</p><br>
    ///   - [`copy_tags_from_source(CopyTagsFromSource)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::copy_tags_from_source) / [`set_copy_tags_from_source(Option<CopyTagsFromSource>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_copy_tags_from_source):<br>required: **false**<br><p>Copies the tags from the specified volume to corresponding snapshot.</p><br>
    ///   - [`location(SnapshotLocationEnum)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::location) / [`set_location(Option<SnapshotLocationEnum>)`](crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::set_location):<br>required: **false**<br><note>  <p>Only supported for instances in Local Zones. If the source instance is not in a Local Zone, omit this parameter.</p> </note> <ul>  <li>   <p>To create local snapshots in the same Local Zone as the source instance, specify <code>local</code>.</p></li>  <li>   <p>To create regional snapshots in the parent Region of the Local Zone, specify <code>regional</code> or omit this parameter.</p></li> </ul> <p>Default value: <code>regional</code></p><br>
    /// - On success, responds with [`CreateSnapshotsOutput`](crate::operation::create_snapshots::CreateSnapshotsOutput) with field(s):
    ///   - [`snapshots(Option<Vec::<SnapshotInfo>>)`](crate::operation::create_snapshots::CreateSnapshotsOutput::snapshots): <p>List of snapshots.</p>
    /// - On failure, responds with [`SdkError<CreateSnapshotsError>`](crate::operation::create_snapshots::CreateSnapshotsError)
    pub fn create_snapshots(&self) -> crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder {
        crate::operation::create_snapshots::builders::CreateSnapshotsFluentBuilder::new(self.handle.clone())
    }
}