Class CreateReplaceRootVolumeTaskRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.CreateReplaceRootVolumeTaskRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateReplaceRootVolumeTaskRequest.Builder,CreateReplaceRootVolumeTaskRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateReplaceRootVolumeTaskRequest extends Ec2Request implements ToCopyableBuilder<CreateReplaceRootVolumeTaskRequest.Builder,CreateReplaceRootVolumeTaskRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateReplaceRootVolumeTaskRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static CreateReplaceRootVolumeTaskRequest.Builder
builder()
String
clientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request.Boolean
deleteReplacedRootVolume()
Indicates whether to automatically delete the original root volume after the root volume replacement task completes.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.String
imageId()
The ID of the AMI to use to restore the root volume.String
instanceId()
The ID of the instance for which to replace the root volume.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends CreateReplaceRootVolumeTaskRequest.Builder>
serializableBuilderClass()
String
snapshotId()
The ID of the snapshot from which to restore the replacement root volume.List<TagSpecification>
tagSpecifications()
The tags to apply to the root volume replacement task.CreateReplaceRootVolumeTaskRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
instanceId
public final String instanceId()
The ID of the instance for which to replace the root volume.
- Returns:
- The ID of the instance for which to replace the root volume.
-
snapshotId
public final String snapshotId()
The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be a snapshot that you previously created from the original root volume.
If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.
- Returns:
- The ID of the snapshot from which to restore the replacement root volume. The specified snapshot must be
a snapshot that you previously created from the original root volume.
If you want to restore the replacement root volume to the initial launch state, or if you want to restore the replacement root volume from an AMI, omit this parameter.
-
clientToken
public final String clientToken()
Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.
- Returns:
- Unique, case-sensitive identifier you provide to ensure the idempotency of the request. If you do not specify a client token, a randomly generated token is used for the request to ensure idempotency. For more information, see Ensuring idempotency.
-
dryRun
public final 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 isUnauthorizedOperation
.- Returns:
- 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 isUnauthorizedOperation
.
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to apply to the root volume replacement task.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasTagSpecifications()
method.- Returns:
- The tags to apply to the root volume replacement task.
-
imageId
public final String imageId()
The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code, billing information, architecture type, and virtualization type as that of the instance.
If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.
- Returns:
- The ID of the AMI to use to restore the root volume. The specified AMI must have the same product code,
billing information, architecture type, and virtualization type as that of the instance.
If you want to restore the replacement volume from a specific snapshot, or if you want to restore it to its launch state, omit this parameter.
-
deleteReplacedRootVolume
public final Boolean deleteReplacedRootVolume()
Indicates whether to automatically delete the original root volume after the root volume replacement task completes. To delete the original root volume, specify
true
. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.- Returns:
- Indicates whether to automatically delete the original root volume after the root volume replacement task
completes. To delete the original root volume, specify
true
. If you choose to keep the original root volume after the replacement task completes, you must manually delete it when you no longer need it.
-
toBuilder
public CreateReplaceRootVolumeTaskRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateReplaceRootVolumeTaskRequest.Builder,CreateReplaceRootVolumeTaskRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateReplaceRootVolumeTaskRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateReplaceRootVolumeTaskRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-