public static interface ImportSnapshotRequest.Builder extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>
Modifier and Type | Method and Description |
---|---|
ImportSnapshotRequest.Builder |
clientData(ClientData clientData)
The client-specific data.
|
default ImportSnapshotRequest.Builder |
clientData(Consumer<ClientData.Builder> clientData)
The client-specific data.
|
ImportSnapshotRequest.Builder |
clientToken(String clientToken)
Token to enable idempotency for VM import requests.
|
ImportSnapshotRequest.Builder |
description(String description)
The description string for the import snapshot task.
|
default ImportSnapshotRequest.Builder |
diskContainer(Consumer<SnapshotDiskContainer.Builder> diskContainer)
Information about the disk container.
|
ImportSnapshotRequest.Builder |
diskContainer(SnapshotDiskContainer diskContainer)
Information about the disk container.
|
ImportSnapshotRequest.Builder |
encrypted(Boolean encrypted)
Specifies whether the destination snapshot of the imported image should be encrypted.
|
ImportSnapshotRequest.Builder |
kmsKeyId(String kmsKeyId)
An identifier for the symmetric AWS Key Management Service (AWS KMS) customer master key (CMK) to use when
creating the encrypted snapshot.
|
ImportSnapshotRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
Add an optional request override configuration.
|
ImportSnapshotRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
Add an optional request override configuration.
|
ImportSnapshotRequest.Builder |
roleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
|
ImportSnapshotRequest.Builder |
tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the import snapshot task during creation.
|
ImportSnapshotRequest.Builder |
tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the import snapshot task during creation.
|
ImportSnapshotRequest.Builder |
tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the import snapshot task during creation.
|
build
overrideConfiguration
equalsBySdkFields, sdkFields
copy
applyMutation, build
ImportSnapshotRequest.Builder clientData(ClientData clientData)
The client-specific data.
clientData
- The client-specific data.default ImportSnapshotRequest.Builder clientData(Consumer<ClientData.Builder> clientData)
The client-specific data.
This is a convenience that creates an instance of theClientData.Builder
avoiding the need to create
one manually via ClientData.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and its result
is passed to clientData(ClientData)
.clientData
- a consumer that will call methods on ClientData.Builder
clientData(ClientData)
ImportSnapshotRequest.Builder clientToken(String clientToken)
Token to enable idempotency for VM import requests.
clientToken
- Token to enable idempotency for VM import requests.ImportSnapshotRequest.Builder description(String description)
The description string for the import snapshot task.
description
- The description string for the import snapshot task.ImportSnapshotRequest.Builder diskContainer(SnapshotDiskContainer diskContainer)
Information about the disk container.
diskContainer
- Information about the disk container.default ImportSnapshotRequest.Builder diskContainer(Consumer<SnapshotDiskContainer.Builder> diskContainer)
Information about the disk container.
This is a convenience that creates an instance of theSnapshotDiskContainer.Builder
avoiding the need
to create one manually via SnapshotDiskContainer.builder()
.
When the Consumer
completes, SdkBuilder.build()
is called immediately and
its result is passed to diskContainer(SnapshotDiskContainer)
.diskContainer
- a consumer that will call methods on SnapshotDiskContainer.Builder
diskContainer(SnapshotDiskContainer)
ImportSnapshotRequest.Builder encrypted(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.
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.ImportSnapshotRequest.Builder kmsKeyId(String kmsKeyId)
An identifier for the symmetric 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.
Amazon EBS does not support asymmetric CMKs.
kmsKeyId
- An identifier for the symmetric 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.
Amazon EBS does not support asymmetric CMKs.
ImportSnapshotRequest.Builder roleName(String roleName)
The name of the role to use when not using the default role, 'vmimport'.
roleName
- The name of the role to use when not using the default role, 'vmimport'.ImportSnapshotRequest.Builder tagSpecifications(Collection<TagSpecification> tagSpecifications)
The tags to apply to the import snapshot task during creation.
tagSpecifications
- The tags to apply to the import snapshot task during creation.ImportSnapshotRequest.Builder tagSpecifications(TagSpecification... tagSpecifications)
The tags to apply to the import snapshot task during creation.
tagSpecifications
- The tags to apply to the import snapshot task during creation.ImportSnapshotRequest.Builder tagSpecifications(Consumer<TagSpecification.Builder>... tagSpecifications)
The tags to apply to the import snapshot task during creation.
This is a convenience that creates an instance of theList.Builder
avoiding the
need to create one manually via List#builder()
.
When the Consumer
completes, List.Builder#build()
is called immediately and
its result is passed to #tagSpecifications(List)
.tagSpecifications
- a consumer that will call methods on List.Builder
#tagSpecifications(List)
ImportSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
overrideConfiguration
- The override configuration.ImportSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
AwsRequest.Builder
overrideConfiguration
in interface AwsRequest.Builder
builderConsumer
- A Consumer
to which an empty AwsRequestOverrideConfiguration.Builder
will be
given.