Interface CreateDiskFromSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>, LightsailRequest.Builder, SdkBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

CreateDiskFromSnapshotRequest

@Mutable
@NotThreadSafe
public static interface CreateDiskFromSnapshotRequest.Builder
extends LightsailRequest.Builder, SdkPojo, CopyableBuilder<CreateDiskFromSnapshotRequest.Builder,CreateDiskFromSnapshotRequest>

Method Summary

Modifier and Type	Method	Description
CreateDiskFromSnapshotRequest.Builder	addOns(Collection<AddOnRequest> addOns)	An array of objects that represent the add-ons to enable for the new disk.
CreateDiskFromSnapshotRequest.Builder	addOns(Consumer<AddOnRequest.Builder>... addOns)	An array of objects that represent the add-ons to enable for the new disk.
CreateDiskFromSnapshotRequest.Builder	addOns(AddOnRequest... addOns)	An array of objects that represent the add-ons to enable for the new disk.
CreateDiskFromSnapshotRequest.Builder	availabilityZone(String availabilityZone)	The Availability Zone where you want to create the disk (us-east-2a).
CreateDiskFromSnapshotRequest.Builder	diskName(String diskName)	The unique Lightsail disk name (my-disk).
CreateDiskFromSnapshotRequest.Builder	diskSnapshotName(String diskSnapshotName)	The name of the disk snapshot (my-snapshot) from which to create the new storage disk.
CreateDiskFromSnapshotRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)	Add an optional request override configuration.
CreateDiskFromSnapshotRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)	Add an optional request override configuration.
CreateDiskFromSnapshotRequest.Builder	restoreDate(String restoreDate)	The date of the automatic snapshot to use for the new disk.
CreateDiskFromSnapshotRequest.Builder	sizeInGb(Integer sizeInGb)	The size of the disk in GB (32).
CreateDiskFromSnapshotRequest.Builder	sourceDiskName(String sourceDiskName)	The name of the source disk from which the source automatic snapshot was created.
CreateDiskFromSnapshotRequest.Builder	tags(Collection<Tag> tags)	The tag keys and optional values to add to the resource during create.
CreateDiskFromSnapshotRequest.Builder	tags(Consumer<Tag.Builder>... tags)	The tag keys and optional values to add to the resource during create.
CreateDiskFromSnapshotRequest.Builder	tags(Tag... tags)	The tag keys and optional values to add to the resource during create.
CreateDiskFromSnapshotRequest.Builder	useLatestRestorableAutoSnapshot(Boolean useLatestRestorableAutoSnapshot)	A Boolean value to indicate whether to use the latest available automatic snapshot.

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

overrideConfiguration

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

copy

Methods inherited from interface software.amazon.awssdk.services.lightsail.model.LightsailRequest.Builder

build

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

applyMutation, build

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

equalsBySdkFields, sdkFieldNameToField, sdkFields

Method Details

diskName

CreateDiskFromSnapshotRequest.Builder diskName(String diskName)

The unique Lightsail disk name (my-disk).

Parameters:

diskName - The unique Lightsail disk name (my-disk).

Returns:

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

diskSnapshotName

CreateDiskFromSnapshotRequest.Builder diskSnapshotName(String diskSnapshotName)

The name of the disk snapshot (my-snapshot) from which to create the new storage disk.

Constraint:

• This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

Parameters:

diskSnapshotName - The name of the disk snapshot (my-snapshot) from which to create the new storage disk.

Constraint:

• This parameter cannot be defined together with the source disk name parameter. The disk snapshot name and source disk name parameters are mutually exclusive.

Returns:

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

availabilityZone

CreateDiskFromSnapshotRequest.Builder availabilityZone(String availabilityZone)

The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

Parameters:

availabilityZone - The Availability Zone where you want to create the disk (us-east-2a). Choose the same Availability Zone as the Lightsail instance where you want to create the disk.

Use the GetRegions operation to list the Availability Zones where Lightsail is currently available.

Returns:

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

sizeInGb

CreateDiskFromSnapshotRequest.Builder sizeInGb(Integer sizeInGb)

The size of the disk in GB (32).

Parameters:

sizeInGb - The size of the disk in GB (32).

Returns:

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

tags

CreateDiskFromSnapshotRequest.Builder tags(Collection<Tag> tags)

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Parameters:

tags - The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Returns:

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

tags

CreateDiskFromSnapshotRequest.Builder tags(Tag... tags)

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Parameters:

tags - The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

Returns:

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

tags

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

The tag keys and optional values to add to the resource during create.

Use the TagResource action to tag a resource after it's created.

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:

• tags(java.util.Collection<Tag>)

addOns

CreateDiskFromSnapshotRequest.Builder addOns(Collection<AddOnRequest> addOns)

An array of objects that represent the add-ons to enable for the new disk.

Parameters:

addOns - An array of objects that represent the add-ons to enable for the new disk.

Returns:

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

addOns

CreateDiskFromSnapshotRequest.Builder addOns(AddOnRequest... addOns)

An array of objects that represent the add-ons to enable for the new disk.

Parameters:

addOns - An array of objects that represent the add-ons to enable for the new disk.

Returns:

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

addOns

CreateDiskFromSnapshotRequest.Builder addOns(Consumer<AddOnRequest.Builder>... addOns)

An array of objects that represent the add-ons to enable for the new disk.

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

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

Parameters:

addOns - a consumer that will call methods on AddOnRequest.Builder

Returns:

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

See Also:

• addOns(java.util.Collection<AddOnRequest>)

sourceDiskName

CreateDiskFromSnapshotRequest.Builder sourceDiskName(String sourceDiskName)

The name of the source disk from which the source automatic snapshot was created.

Constraints:

• This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

sourceDiskName - The name of the source disk from which the source automatic snapshot was created.

Constraints:

• This parameter cannot be defined together with the disk snapshot name parameter. The source disk name and disk snapshot name parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Returns:

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

restoreDate

CreateDiskFromSnapshotRequest.Builder restoreDate(String restoreDate)

The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

• Must be specified in YYYY-MM-DD format.

• This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

restoreDate - The date of the automatic snapshot to use for the new disk. Use the get auto snapshots operation to identify the dates of the available automatic snapshots.

Constraints:

• Must be specified in YYYY-MM-DD format.

• This parameter cannot be defined together with the use latest restorable auto snapshot parameter. The restore date and use latest restorable auto snapshot parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Returns:

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

useLatestRestorableAutoSnapshot

CreateDiskFromSnapshotRequest.Builder useLatestRestorableAutoSnapshot(Boolean useLatestRestorableAutoSnapshot)

A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

• This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Parameters:

useLatestRestorableAutoSnapshot - A Boolean value to indicate whether to use the latest available automatic snapshot.

Constraints:

• This parameter cannot be defined together with the restore date parameter. The use latest restorable auto snapshot and restore date parameters are mutually exclusive.

• Define this parameter only when creating a new disk from an automatic snapshot. For more information, see the Amazon Lightsail Developer Guide.

Returns:

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

overrideConfiguration

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

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