Interface StartSnapshotRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>, EbsRequest.Builder, SdkBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
StartSnapshotRequest
@Mutable @NotThreadSafe public static interface StartSnapshotRequest.Builder extends EbsRequest.Builder, SdkPojo, CopyableBuilder<StartSnapshotRequest.Builder,StartSnapshotRequest>

  • Method Details

    • volumeSize

      StartSnapshotRequest.Builder volumeSize(Long volumeSize)

      The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).

      Parameters:
      volumeSize - The size of the volume, in GiB. The maximum size is 65536 GiB (64 TiB).
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • parentSnapshotId

      StartSnapshotRequest.Builder parentSnapshotId(String parentSnapshotId)

      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.

      You can't specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      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 Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Parameters:
      parentSnapshotId - 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.

      You can't specify ParentSnapshotId and Encrypted in the same request. If you specify both parameters, the request fails with ValidationException.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      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 Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSnapshotRequest.Builder tags(Collection<Tag> tags)

      The tags to apply to the snapshot.

      Parameters:
      tags - The tags to apply to the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSnapshotRequest.Builder tags(Tag... tags)

      The tags to apply to the snapshot.

      Parameters:
      tags - The tags to apply to the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tags

      StartSnapshotRequest.Builder tags(Consumer<Tag.Builder>... tags)

      The tags to apply to the snapshot.

      This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to tags(List<Tag>).

      Parameters:
      tags - a consumer that will call methods on Tag.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • description

      StartSnapshotRequest.Builder description(String description)

      A description for the snapshot.

      Parameters:
      description - A description for the snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      StartSnapshotRequest.Builder clientToken(String clientToken)

      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.

      If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

      For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

      Parameters:
      clientToken - 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.

      If you do not specify a client token, one is automatically generated by the Amazon Web Services SDK.

      For more information, see Idempotency for StartSnapshot API in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • encrypted

      StartSnapshotRequest.Builder encrypted(Boolean encrypted)

      Indicates whether to encrypt the snapshot.

      You can't specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Parameters:
      encrypted - Indicates whether to encrypt the snapshot.

      You can't specify Encrypted and ParentSnapshotId in the same request. If you specify both parameters, the request fails with ValidationException.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • kmsKeyArn

      StartSnapshotRequest.Builder kmsKeyArn(String kmsKeyArn)

      The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Parameters:
      kmsKeyArn - The Amazon Resource Name (ARN) of the Key Management Service (KMS) key to be used to encrypt the snapshot.

      The encryption status of the snapshot depends on the values that you specify for Encrypted, KmsKeyArn, and ParentSnapshotId, and whether your Amazon Web Services account is enabled for encryption by default. For more information, see Using encryption in the Amazon Elastic Compute Cloud User Guide.

      To create an encrypted snapshot, you must have permission to use the KMS key. For more information, see Permissions to use Key Management Service keys in the Amazon Elastic Compute Cloud User Guide.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • timeout

      StartSnapshotRequest.Builder timeout(Integer timeout)

      The amount of time (in minutes) after which the snapshot is automatically cancelled if:

      • No blocks are written to the snapshot.

      • The snapshot is not completed after writing the last block of data.

      If no value is specified, the timeout defaults to 60 minutes.

      Parameters:
      timeout - The amount of time (in minutes) after which the snapshot is automatically cancelled if:

      • No blocks are written to the snapshot.

      • The snapshot is not completed after writing the last block of data.

      If no value is specified, the timeout defaults to 60 minutes.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      StartSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      StartSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.