Class CreateRestoreImageTaskRequest
- 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.CreateRestoreImageTaskRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateRestoreImageTaskRequest.Builder,CreateRestoreImageTaskRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateRestoreImageTaskRequest extends Ec2Request implements ToCopyableBuilder<CreateRestoreImageTaskRequest.Builder,CreateRestoreImageTaskRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateRestoreImageTaskRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description String
bucket()
The name of the Amazon S3 bucket that contains the stored AMI object.static CreateRestoreImageTaskRequest.Builder
builder()
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
name()
The name for the restored AMI.String
objectKey()
The name of the stored AMI object in the bucket.List<SdkField<?>>
sdkFields()
static Class<? extends CreateRestoreImageTaskRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to apply to the AMI and snapshots on restoration.CreateRestoreImageTaskRequest.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
-
bucket
public final String bucket()
The name of the Amazon S3 bucket that contains the stored AMI object.
- Returns:
- The name of the Amazon S3 bucket that contains the stored AMI object.
-
objectKey
public final String objectKey()
The name of the stored AMI object in the bucket.
- Returns:
- The name of the stored AMI object in the bucket.
-
name
public final String name()
The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.
- Returns:
- The name for the restored AMI. The name must be unique for AMIs in the Region for this account. If you do not provide a name, the new AMI gets the same name as the original AMI.
-
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 AMI and snapshots on restoration. You can tag the AMI, the snapshots, or both.
-
To tag the AMI, the value for
ResourceType
must beimage
. -
To tag the snapshots, the value for
ResourceType
must besnapshot
. The same tag is applied to all of the snapshots that are created.
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 AMI and snapshots on restoration. You can tag the AMI, the snapshots, or
both.
-
To tag the AMI, the value for
ResourceType
must beimage
. -
To tag the snapshots, the value for
ResourceType
must besnapshot
. The same tag is applied to all of the snapshots that are created.
-
-
-
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
.
-
toBuilder
public CreateRestoreImageTaskRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateRestoreImageTaskRequest.Builder,CreateRestoreImageTaskRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateRestoreImageTaskRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateRestoreImageTaskRequest.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
-
-