Interface CreateSnapshotsRequest.Builder

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

  • Method Details

    • description

      CreateSnapshotsRequest.Builder description(String description)

      A description propagated to every snapshot specified by the instance.

      Parameters:
      description - A description propagated to every snapshot specified by the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceSpecification

      CreateSnapshotsRequest.Builder instanceSpecification(InstanceSpecification instanceSpecification)

      The instance to specify which volumes should be included in the snapshots.

      Parameters:
      instanceSpecification - The instance to specify which volumes should be included in the snapshots.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • instanceSpecification

      default CreateSnapshotsRequest.Builder instanceSpecification(Consumer<InstanceSpecification.Builder> instanceSpecification)

      The instance to specify which volumes should be included in the snapshots.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to instanceSpecification(InstanceSpecification).

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

    • outpostArn

      CreateSnapshotsRequest.Builder outpostArn(String outpostArn)

      The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

      • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

      • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

      • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

      For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon EBS User Guide.

      Parameters:
      outpostArn - The Amazon Resource Name (ARN) of the Outpost on which to create the local snapshots.

      • To create snapshots from an instance in a Region, omit this parameter. The snapshots are created in the same Region as the instance.

      • To create snapshots from an instance on an Outpost and store the snapshots in the Region, omit this parameter. The snapshots are created in the Region for the Outpost.

      • To create snapshots from an instance on an Outpost and store the snapshots on an Outpost, specify the ARN of the destination Outpost. The snapshots must be created on the same Outpost as the instance.

      For more information, see Create multi-volume local snapshots from instances on an Outpost in the Amazon EBS User Guide.

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

    • tagSpecifications

      CreateSnapshotsRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)

      Tags to apply to every snapshot specified by the instance.

      Parameters:
      tagSpecifications - Tags to apply to every snapshot specified by the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

      CreateSnapshotsRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)

      Tags to apply to every snapshot specified by the instance.

      Parameters:
      tagSpecifications - Tags to apply to every snapshot specified by the instance.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • tagSpecifications

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

      Tags to apply to every snapshot specified by the instance.

      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:

    • dryRun

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

    • copyTagsFromSource

      CreateSnapshotsRequest.Builder copyTagsFromSource(String copyTagsFromSource)

      Copies the tags from the specified volume to corresponding snapshot.

      Parameters:
      copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • copyTagsFromSource

      CreateSnapshotsRequest.Builder copyTagsFromSource(CopyTagsFromSource copyTagsFromSource)

      Copies the tags from the specified volume to corresponding snapshot.

      Parameters:
      copyTagsFromSource - Copies the tags from the specified volume to corresponding snapshot.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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