aws_sdk_ebs/client/

start_snapshot.rs

// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
impl super::Client {
    /// Constructs a fluent builder for the [`StartSnapshot`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder) operation.
    ///
    /// - The fluent builder is configurable:
    ///   - [`volume_size(i64)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::volume_size) / [`set_volume_size(Option<i64>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_volume_size):<br>required: **true**<br><p>The size of the volume, in GiB. The maximum size is <code>65536</code> GiB (64 TiB).</p><br>
    ///   - [`parent_snapshot_id(impl Into<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::parent_snapshot_id) / [`set_parent_snapshot_id(Option<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_parent_snapshot_id):<br>required: **false**<br><p>The ID of the parent snapshot. If there is no parent snapshot, or if you are creating the first snapshot for an on-premises volume, omit this parameter.</p> <p>You can't specify <b>ParentSnapshotId</b> and <b>Encrypted</b> in the same request. If you specify both parameters, the request fails with <code>ValidationException</code>.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default"> encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p><important>  <p>If you specify an encrypted parent snapshot, you must have permission to use the KMS key that was used to encrypt the parent snapshot. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important><br>
    ///   - [`tags(Tag)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::tags) / [`set_tags(Option<Vec::<Tag>>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_tags):<br>required: **false**<br><p>The tags to apply to the snapshot.</p><br>
    ///   - [`description(impl Into<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_description):<br>required: **false**<br><p>A description for the snapshot.</p><br>
    ///   - [`client_token(impl Into<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::client_token) / [`set_client_token(Option<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_client_token):<br>required: **false**<br><p>A unique, case-sensitive identifier that you provide to ensure the idempotency of the request. Idempotency ensures that an API request completes only once. With an idempotent request, if the original request completes successfully. The subsequent retries with the same client token return the result from the original successful request and they have no additional effect.</p> <p>If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.</p> <p>For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebs-direct-api-idempotency.html"> Idempotency for StartSnapshot API</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p><br>
    ///   - [`encrypted(bool)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::encrypted) / [`set_encrypted(Option<bool>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_encrypted):<br>required: **false**<br><p>Indicates whether to encrypt the snapshot.</p> <p>You can't specify <b>Encrypted</b> and <b> ParentSnapshotId</b> in the same request. If you specify both parameters, the request fails with <code>ValidationException</code>.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default"> encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p><important>  <p>To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important><br>
    ///   - [`kms_key_arn(impl Into<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::kms_key_arn) / [`set_kms_key_arn(Option<String>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_kms_key_arn):<br>required: **false**<br><p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.</p> <p>The encryption status of the snapshot depends on the values that you specify for <b>Encrypted</b>, <b>KmsKeyArn</b>, and <b>ParentSnapshotId</b>, and whether your Amazon Web Services account is enabled for <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/EBSEncryption.html#encryption-by-default"> encryption by default</a>. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapis-using-encryption.html"> Using encryption</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p><important>  <p>To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ebsapi-permissions.html#ebsapi-kms-permissions"> Permissions to use Key Management Service keys</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p> </important><br>
    ///   - [`timeout(i32)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::timeout) / [`set_timeout(Option<i32>)`](crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::set_timeout):<br>required: **false**<br><p>The amount of time (in minutes) after which the snapshot is automatically cancelled if:</p> <ul>  <li>   <p>No blocks are written to the snapshot.</p></li>  <li>   <p>The snapshot is not completed after writing the last block of data.</p></li> </ul> <p>If no value is specified, the timeout defaults to <code>60</code> minutes.</p><br>
    /// - On success, responds with [`StartSnapshotOutput`](crate::operation::start_snapshot::StartSnapshotOutput) with field(s):
    ///   - [`description(Option<String>)`](crate::operation::start_snapshot::StartSnapshotOutput::description): <p>The description of the snapshot.</p>
    ///   - [`snapshot_id(Option<String>)`](crate::operation::start_snapshot::StartSnapshotOutput::snapshot_id): <p>The ID of the snapshot.</p>
    ///   - [`owner_id(Option<String>)`](crate::operation::start_snapshot::StartSnapshotOutput::owner_id): <p>The Amazon Web Services account ID of the snapshot owner.</p>
    ///   - [`status(Option<Status>)`](crate::operation::start_snapshot::StartSnapshotOutput::status): <p>The status of the snapshot.</p>
    ///   - [`start_time(Option<DateTime>)`](crate::operation::start_snapshot::StartSnapshotOutput::start_time): <p>The timestamp when the snapshot was created.</p>
    ///   - [`volume_size(Option<i64>)`](crate::operation::start_snapshot::StartSnapshotOutput::volume_size): <p>The size of the volume, in GiB.</p>
    ///   - [`block_size(Option<i32>)`](crate::operation::start_snapshot::StartSnapshotOutput::block_size): <p>The size of the blocks in the snapshot, in bytes.</p>
    ///   - [`tags(Option<Vec::<Tag>>)`](crate::operation::start_snapshot::StartSnapshotOutput::tags): <p>The tags applied to the snapshot. You can specify up to 50 tags per snapshot. For more information, see <a href="https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/Using_Tags.html"> Tagging your Amazon EC2 resources</a> in the <i>Amazon Elastic Compute Cloud User Guide</i>.</p>
    ///   - [`parent_snapshot_id(Option<String>)`](crate::operation::start_snapshot::StartSnapshotOutput::parent_snapshot_id): <p>The ID of the parent snapshot.</p>
    ///   - [`kms_key_arn(Option<String>)`](crate::operation::start_snapshot::StartSnapshotOutput::kms_key_arn): <p>The Amazon Resource Name (ARN) of the Key Management Service (KMS) key used to encrypt the snapshot.</p>
    ///   - [`sse_type(Option<SseType>)`](crate::operation::start_snapshot::StartSnapshotOutput::sse_type): <p>Reserved for future use.</p>
    /// - On failure, responds with [`SdkError<StartSnapshotError>`](crate::operation::start_snapshot::StartSnapshotError)
    pub fn start_snapshot(&self) -> crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder {
        crate::operation::start_snapshot::builders::StartSnapshotFluentBuilder::new(self.handle.clone())
    }
}