Class ImportSnapshotRequest
- 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.ImportSnapshotRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>
@Generated("software.amazon.awssdk:codegen") public final class ImportSnapshotRequest extends Ec2Request implements ToCopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ImportSnapshotRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ImportSnapshotRequest.Builder
builder()
ClientData
clientData()
The client-specific data.String
clientToken()
Token to enable idempotency for VM import requests.String
description()
The description string for the import snapshot task.SnapshotDiskContainer
diskContainer()
Information about the disk container.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.Boolean
encrypted()
Specifies whether the destination snapshot of the imported image should be encrypted.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
kmsKeyId()
An identifier for the symmetric KMS key to use when creating the encrypted snapshot.String
roleName()
The name of the role to use when not using the default role, 'vmimport'.List<SdkField<?>>
sdkFields()
static Class<? extends ImportSnapshotRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to apply to the import snapshot task during creation.ImportSnapshotRequest.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
-
clientData
public final ClientData clientData()
The client-specific data.
- Returns:
- The client-specific data.
-
clientToken
public final String clientToken()
Token to enable idempotency for VM import requests.
- Returns:
- Token to enable idempotency for VM import requests.
-
description
public final String description()
The description string for the import snapshot task.
- Returns:
- The description string for the import snapshot task.
-
diskContainer
public final SnapshotDiskContainer diskContainer()
Information about the disk container.
- Returns:
- Information about the disk container.
-
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
.
-
encrypted
public final Boolean encrypted()
Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key for EBS is used unless you specify a non-default KMS key using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.- Returns:
- Specifies whether the destination snapshot of the imported image should be encrypted. The default KMS key
for EBS is used unless you specify a non-default KMS key using
KmsKeyId
. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
-
kmsKeyId
public final String kmsKeyId()
An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default KMS key; if this parameter is not specified, the default KMS key for EBS is used. If a
KmsKeyId
is specified, theEncrypted
flag must also be set.The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. -
ARN using key alias. The alias ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses
KmsKeyId
asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
- Returns:
- An identifier for the symmetric KMS key to use when creating the encrypted snapshot. This parameter is
only required if you want to use a non-default KMS key; if this parameter is not specified, the default
KMS key for EBS is used. If a
KmsKeyId
is specified, theEncrypted
flag must also be set.The KMS key identifier may be provided in any of the following formats:
-
Key ID
-
Key alias
-
ARN using key ID. The ID ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thekey
namespace, and then the key ID. For example, arn:aws:kms:us-east-1:012345678910:key/abcd1234-a123-456a-a12b-a123b4cd56ef. -
ARN using key alias. The alias ARN contains the
arn:aws:kms
namespace, followed by the Region of the key, the Amazon Web Services account ID of the key owner, thealias
namespace, and then the key alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.
Amazon Web Services parses
KmsKeyId
asynchronously, meaning that the action you call may appear to complete even though you provided an invalid identifier. This action will eventually report failure.The specified KMS key must exist in the Region that the snapshot is being copied to.
Amazon EBS does not support asymmetric KMS keys.
-
-
-
roleName
public final String roleName()
The name of the role to use when not using the default role, 'vmimport'.
- Returns:
- The name of the role to use when not using the default role, 'vmimport'.
-
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 import snapshot task during creation.
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 import snapshot task during creation.
-
toBuilder
public ImportSnapshotRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ImportSnapshotRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ImportSnapshotRequest.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
-
-