software.amazon.awssdk.services.ec2.model

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(value="software.amazon.awssdk:codegen")
public final class ImportSnapshotRequest
extends Ec2Request
implements ToCopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>

Contains the parameters for ImportSnapshot.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	ImportSnapshotRequest.Builder

Method Summary

Modifier and Type	Method and 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	encrypted() Specifies whether the destination snapshot of the imported image should be encrypted.
boolean	equals(Object obj)
<T> Optional<T>	getValueForField(String fieldName, Class<T> clazz)
int	hashCode()
String	kmsKeyId() An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) 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()
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 ClientData clientData()

The client-specific data.

Returns:

The client-specific data.

clientToken

public String clientToken()

Token to enable idempotency for VM import requests.

Returns:

Token to enable idempotency for VM import requests.

description

public String description()

The description string for the import snapshot task.

Returns:

The description string for the import snapshot task.

diskContainer

public SnapshotDiskContainer diskContainer()

Information about the disk container.

Returns:

Information about the disk container.

encrypted

public Boolean encrypted()

Specifies whether the destination snapshot of the imported image should be encrypted. The default CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK 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 CMK for EBS is used unless you specify a non-default AWS Key Management Service (AWS KMS) CMK using KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

kmsKeyId

public String kmsKeyId()

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the Region that the snapshot is being copied to.

Returns:

An identifier for the AWS Key Management Service (AWS KMS) customer master key (CMK) to use when creating the encrypted snapshot. This parameter is only required if you want to use a non-default CMK; if this parameter is not specified, the default CMK for EBS is used. If a KmsKeyId is specified, the Encrypted flag must also be set.

The CMK identifier may be provided in any of the following formats:

• Key ID

• Key alias. The alias ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

• ARN using key ID. The ID ARN contains the arn:aws:kms namespace, followed by the Region of the CMK, the AWS account ID of the CMK owner, the key namespace, and then the CMK 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 CMK, the AWS account ID of the CMK owner, the alias namespace, and then the CMK alias. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

AWS 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 CMK must exist in the Region that the snapshot is being copied to.

roleName

public 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'.

toBuilder

public ImportSnapshotRequest.Builder toBuilder()

Specified by:

toBuilder in interface ToCopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>

Specified by:

toBuilder in class Ec2Request

builder

public static ImportSnapshotRequest.Builder builder()

serializableBuilderClass

public static Class<? extends ImportSnapshotRequest.Builder> serializableBuilderClass()

hashCode

public int hashCode()

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

toString

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

Overrides:

toString in class Object

getValueForField

public <T> Optional<T> getValueForField(String fieldName,
                                        Class<T> clazz)

Overrides:

getValueForField in class SdkRequest

sdkFields

public List<SdkField<?>> sdkFields()

Specified by:

sdkFields in interface SdkPojo