Package software.amazon.awssdk.services.ec2.model

Interface ImportSnapshotRequest.Builder

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

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

      • dryRun

        ImportSnapshotRequest.Builder dryRun​(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 is UnauthorizedOperation.

        Parameters:
        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 is UnauthorizedOperation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encrypted

        ImportSnapshotRequest.Builder encrypted​(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.

        Parameters:
        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:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        ImportSnapshotRequest.Builder kmsKeyId​(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, the Encrypted 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, the key 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, the alias 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.

        Parameters:
        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, the Encrypted 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, the key 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, the alias 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:
        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.

      • tagSpecifications

        ImportSnapshotRequest.Builder tagSpecifications​(Collection<TagSpecification> tagSpecifications)

        The tags to apply to the import snapshot task during creation.

        Parameters:
        tagSpecifications - The tags to apply to the import snapshot task during creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • tagSpecifications

        ImportSnapshotRequest.Builder tagSpecifications​(TagSpecification... tagSpecifications)

        The tags to apply to the import snapshot task during creation.

        Parameters:
        tagSpecifications - The tags to apply to the import snapshot task during creation.
        Returns:
        Returns a reference to this object so that method calls can be chained together.