Interface CopySnapshotRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CopyableBuilder<CopySnapshotRequest.Builder,
,CopySnapshotRequest> LightsailRequest.Builder
,SdkBuilder<CopySnapshotRequest.Builder,
,CopySnapshotRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CopySnapshotRequest
-
Method Summary
Modifier and TypeMethodDescriptionoverrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.restoreDate
(String restoreDate) The date of the source automatic snapshot to copy.sourceRegion
(String sourceRegion) The Amazon Web Services Region where the source manual or automatic snapshot is located.sourceRegion
(RegionName sourceRegion) The Amazon Web Services Region where the source manual or automatic snapshot is located.sourceResourceName
(String sourceResourceName) The name of the source instance or disk from which the source automatic snapshot was created.sourceSnapshotName
(String sourceSnapshotName) The name of the source manual snapshot to copy.targetSnapshotName
(String targetSnapshotName) The name of the new manual snapshot to be created as a copy.useLatestRestorableAutoSnapshot
(Boolean useLatestRestorableAutoSnapshot) A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.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
-
sourceSnapshotName
The name of the source manual snapshot to copy.
Constraint:
-
Define this parameter only when copying a manual snapshot as another manual snapshot.
- Parameters:
sourceSnapshotName
- The name of the source manual snapshot to copy.Constraint:
-
Define this parameter only when copying a manual snapshot as another manual snapshot.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
sourceResourceName
The name of the source instance or disk from which the source automatic snapshot was created.
Constraint:
-
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
sourceResourceName
- The name of the source instance or disk from which the source automatic snapshot was created.Constraint:
-
Define this parameter only when copying an automatic snapshot as a manual 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
The date of the source automatic snapshot to copy. 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. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual snapshot. For more information, see the Amazon Lightsail Developer Guide.
- Parameters:
restoreDate
- The date of the source automatic snapshot to copy. Use theget 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. Therestore date
anduse latest restorable auto snapshot
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual 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
CopySnapshotRequest.Builder useLatestRestorableAutoSnapshot(Boolean useLatestRestorableAutoSnapshot) A Boolean value to indicate whether to use the latest available automatic snapshot of the specified source instance or disk.
Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual 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 of the specified source instance or disk.Constraints:
-
This parameter cannot be defined together with the
restore date
parameter. Theuse latest restorable auto snapshot
andrestore date
parameters are mutually exclusive. -
Define this parameter only when copying an automatic snapshot as a manual 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.
-
-
targetSnapshotName
The name of the new manual snapshot to be created as a copy.
- Parameters:
targetSnapshotName
- The name of the new manual snapshot to be created as a copy.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceRegion
The Amazon Web Services Region where the source manual or automatic snapshot is located.
- Parameters:
sourceRegion
- The Amazon Web Services Region where the source manual or automatic snapshot is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
sourceRegion
The Amazon Web Services Region where the source manual or automatic snapshot is located.
- Parameters:
sourceRegion
- The Amazon Web Services Region where the source manual or automatic snapshot is located.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
overrideConfiguration
CopySnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CopySnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-