software.amazon.awssdk.services.ec2.model

Interface CreateSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>, Ec2Request.Builder, SdkBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateSnapshotRequest

public static interface CreateSnapshotRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<CreateSnapshotRequest.Builder,CreateSnapshotRequest>

Method Summary

Modifier and Type	Method and Description
CreateSnapshotRequest.Builder	description(String description) A description for the snapshot.
CreateSnapshotRequest.Builder	outpostArn(String outpostArn) The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.
CreateSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.
CreateSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.
CreateSnapshotRequest.Builder	tagSpecifications(Collection<TagSpecification> tagSpecifications) The tags to apply to the snapshot during creation.
CreateSnapshotRequest.Builder	tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications) The tags to apply to the snapshot during creation.
CreateSnapshotRequest.Builder	tagSpecifications(TagSpecification... tagSpecifications) The tags to apply to the snapshot during creation.
CreateSnapshotRequest.Builder	volumeId(String volumeId) The ID of the EBS volume.

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

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)

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

• To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

• To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

• To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud User Guide.

Parameters:

outpostArn - The Amazon Resource Name (ARN) of the AWS Outpost on which to create a local snapshot.

• To create a snapshot of a volume in a Region, omit this parameter. The snapshot is created in the same Region as the volume.

• To create a snapshot of a volume on an Outpost and store the snapshot in the Region, omit this parameter. The snapshot is created in the Region for the Outpost.

• To create a snapshot of a volume on an Outpost and store the snapshot on an Outpost, specify the ARN of the destination Outpost. The snapshot must be created on the same Outpost as the volume.

For more information, see Creating local snapshots from volumes on an Outpost in the Amazon Elastic Compute Cloud 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 EBS volume.

Parameters:

volumeId - The ID of the 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 that creates an instance of the List.Builder avoiding the need to create one manually via List#builder(). When the Consumer completes, List.Builder#build() is called immediately and its result is passed to #tagSpecifications(List).

Parameters:

tagSpecifications - a consumer that will call methods on List.Builder

Returns:

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

See Also:

#tagSpecifications(List)

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.