software.amazon.awssdk.services.ec2.model

Interface ImportSnapshotRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>, Ec2Request.Builder, SdkBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>, SdkPojo, SdkRequest.Builder

Enclosing class:

ImportSnapshotRequest

public static interface ImportSnapshotRequest.Builder
extends Ec2Request.Builder, SdkPojo, CopyableBuilder<ImportSnapshotRequest.Builder,ImportSnapshotRequest>

Method Summary

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

Methods inherited from interface software.amazon.awssdk.services.ec2.model.Ec2Request.Builder

build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Method Detail

clientData

ImportSnapshotRequest.Builder clientData(ClientData clientData)

The client-specific data.

Parameters:

clientData - The client-specific data.

Returns:

Returns a reference to this object so that method calls can be chained together.

clientData

default ImportSnapshotRequest.Builder clientData(Consumer<ClientData.Builder> clientData)

The client-specific data.

This is a convenience that creates an instance of the ClientData.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).

Parameters:

clientData - a consumer that will call methods on ClientData.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

clientData(ClientData)

clientToken

ImportSnapshotRequest.Builder clientToken(String clientToken)

Token to enable idempotency for VM import requests.

Parameters:

clientToken - Token to enable idempotency for VM import requests.

Returns:

Returns a reference to this object so that method calls can be chained together.

description

ImportSnapshotRequest.Builder description(String description)

The description string for the import snapshot task.

Parameters:

description - The description string for the import snapshot task.

Returns:

Returns a reference to this object so that method calls can be chained together.

diskContainer

ImportSnapshotRequest.Builder diskContainer(SnapshotDiskContainer diskContainer)

Information about the disk container.

Parameters:

diskContainer - Information about the disk container.

Returns:

Returns a reference to this object so that method calls can be chained together.

diskContainer

default ImportSnapshotRequest.Builder diskContainer(Consumer<SnapshotDiskContainer.Builder> diskContainer)

Information about the disk container.

This is a convenience that creates an instance of the SnapshotDiskContainer.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).

Parameters:

diskContainer - a consumer that will call methods on SnapshotDiskContainer.Builder

Returns:

Returns a reference to this object so that method calls can be chained together.

See Also:

diskContainer(SnapshotDiskContainer)

encrypted

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.

Parameters:

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:

Returns a reference to this object so that method calls can be chained together.

kmsKeyId

ImportSnapshotRequest.Builder kmsKeyId(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, in the form 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.

Parameters:

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, in the form 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:

Returns a reference to this object so that method calls can be chained together.

roleName

ImportSnapshotRequest.Builder roleName(String roleName)

The name of the role to use when not using the default role, 'vmimport'.

Parameters:

roleName - The name of the role to use when not using the default role, 'vmimport'.

Returns:

Returns a reference to this object so that method calls can be chained together.

overrideConfiguration

ImportSnapshotRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

overrideConfiguration - The override configuration.

Returns:

This object for method chaining.

overrideConfiguration

ImportSnapshotRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Description copied from interface: AwsRequest.Builder

Add an optional request override configuration.

Specified by:

overrideConfiguration in interface AwsRequest.Builder

Parameters:

builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.

Returns:

This object for method chaining.