Interface CreateSnapshotRequest.Builder

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

  • Method Details

    • description

      CreateSnapshotRequest.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.

    • outpostArn

      CreateSnapshotRequest.Builder outpostArn(String outpostArn)

      Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

      • To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

      • To create the snapshot in the parent Region of the Outpost, omit this parameter.

      For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

      Parameters:
      outpostArn -

      Only supported for volumes on Outposts. If the source volume is not on an Outpost, omit this parameter.

      • To create the snapshot on the same Outpost as the source volume, specify the ARN of that Outpost. The snapshot must be created on the same Outpost as the volume.

      • To create the snapshot in the parent Region of the Outpost, omit this parameter.

      For more information, see Create local snapshots from volumes on an Outpost in the Amazon EBS User Guide.

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

    • volumeId

      CreateSnapshotRequest.Builder volumeId(String volumeId)

      The ID of the Amazon EBS volume.

      Parameters:
      volumeId - The ID of the Amazon EBS volume.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateSnapshotRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      The tags to apply to the snapshot during creation.

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

    • tagSpecifications

      CreateSnapshotRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      The tags to apply to the snapshot during creation.

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

    • tagSpecifications

      CreateSnapshotRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)

      The tags to apply to the snapshot during creation.

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

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

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

    • location

      CreateSnapshotRequest.Builder location(String location)

      Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

      • To create a local snapshot in the same Local Zone as the source volume, specify local.

      • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      Parameters:
      location -

      Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

      • To create a local snapshot in the same Local Zone as the source volume, specify local.

      • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

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

    • location

      CreateSnapshotRequest.Builder location(SnapshotLocationEnum location)

      Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

      • To create a local snapshot in the same Local Zone as the source volume, specify local.

      • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

      Parameters:
      location -

      Only supported for volumes in Local Zones. If the source volume is not in a Local Zone, omit this parameter.

      • To create a local snapshot in the same Local Zone as the source volume, specify local.

      • To create a regional snapshot in the parent Region of the Local Zone, specify regional or omit this parameter.

      Default value: regional

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

    • dryRun

      CreateSnapshotRequest.Builder dryRun(Boolean dryRun)

      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 DryRunOperation. Otherwise, it is UnauthorizedOperation.

      Parameters:
      dryRun - 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 DryRunOperation. Otherwise, it is UnauthorizedOperation.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreateSnapshotRequest.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

      CreateSnapshotRequest.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.