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

Interface CopyImageRequest.Builder

    • Method Detail

      • clientToken

        CopyImageRequest.Builder clientToken​(String clientToken)

        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.

        Parameters:
        clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see Ensuring idempotency in the Amazon EC2 API Reference.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • description

        CopyImageRequest.Builder description​(String description)

        A description for the new AMI in the destination Region.

        Parameters:
        description - A description for the new AMI in the destination Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • encrypted

        CopyImageRequest.Builder encrypted​(Boolean encrypted)

        Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.

        Parameters:
        encrypted - Specifies whether the destination snapshots of the copied image should be encrypted. You can encrypt a copy of an unencrypted snapshot, but you cannot create an unencrypted copy of an encrypted snapshot. The default KMS key for Amazon EBS is used unless you specify a non-default Key Management Service (KMS) KMS key using KmsKeyId. For more information, see Amazon EBS encryption in the Amazon EBS User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • kmsKeyId

        CopyImageRequest.Builder kmsKeyId​(String kmsKeyId)

        The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

        You can specify a KMS key using any of the following:

        • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

        • Key alias. For example, alias/ExampleAlias.

        • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

        • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

        Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

        The specified KMS key must exist in the destination Region.

        Amazon EBS does not support asymmetric KMS keys.

        Parameters:
        kmsKeyId - The identifier of the symmetric Key Management Service (KMS) KMS key to use when creating encrypted volumes. If this parameter is not specified, your Amazon Web Services managed KMS key for Amazon EBS is used. If you specify a KMS key, you must also set the encrypted state to true.

        You can specify a KMS key using any of the following:

        • Key ID. For example, 1234abcd-12ab-34cd-56ef-1234567890ab.

        • Key alias. For example, alias/ExampleAlias.

        • Key ARN. For example, arn:aws:kms:us-east-1:012345678910:key/1234abcd-12ab-34cd-56ef-1234567890ab.

        • Alias ARN. For example, arn:aws:kms:us-east-1:012345678910:alias/ExampleAlias.

        Amazon Web Services authenticates the KMS key asynchronously. Therefore, if you specify an identifier that is not valid, the action can appear to complete, but eventually fails.

        The specified KMS key must exist in the destination Region.

        Amazon EBS does not support asymmetric KMS keys.

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

      • name

        CopyImageRequest.Builder name​(String name)

        The name of the new AMI in the destination Region.

        Parameters:
        name - The name of the new AMI in the destination Region.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceImageId

        CopyImageRequest.Builder sourceImageId​(String sourceImageId)

        The ID of the AMI to copy.

        Parameters:
        sourceImageId - The ID of the AMI to copy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • sourceRegion

        CopyImageRequest.Builder sourceRegion​(String sourceRegion)

        The name of the Region that contains the AMI to copy.

        Parameters:
        sourceRegion - The name of the Region that contains the AMI to copy.
        Returns:
        Returns a reference to this object so that method calls can be chained together.

      • destinationOutpostArn

        CopyImageRequest.Builder destinationOutpostArn​(String destinationOutpostArn)

        The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

        For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

        Parameters:
        destinationOutpostArn - The Amazon Resource Name (ARN) of the Outpost to which to copy the AMI. Only specify this parameter when copying an AMI from an Amazon Web Services Region to an Outpost. The AMI must be in the Region of the destination Outpost. You cannot copy an AMI from an Outpost to a Region, from one Outpost to another, or within the same Outpost.

        For more information, see Copy AMIs from an Amazon Web Services Region to an Outpost in the Amazon EBS User Guide.

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

      • dryRun

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

      • copyImageTags

        CopyImageRequest.Builder copyImageTags​(Boolean copyImageTags)

        Indicates whether to include your user-defined AMI tags when copying the AMI.

        The following tags will not be copied:

        • System tags (prefixed with aws:)

        • For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

        Default: Your user-defined AMI tags are not copied.

        Parameters:
        copyImageTags - Indicates whether to include your user-defined AMI tags when copying the AMI.

        The following tags will not be copied:

        • System tags (prefixed with aws:)

        • For public and shared AMIs, user-defined tags that are attached by other Amazon Web Services accounts

        Default: Your user-defined AMI tags are not copied.

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

      • tagSpecifications

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

        The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

        • To tag the new AMI, the value for ResourceType must be image.

        • To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

        If you specify other values for ResourceType, the request fails.

        To tag an AMI or snapshot after it has been created, see CreateTags.

        Parameters:
        tagSpecifications - The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

        • To tag the new AMI, the value for ResourceType must be image.

        • To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

        If you specify other values for ResourceType, the request fails.

        To tag an AMI or snapshot after it has been created, see CreateTags.

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

      • tagSpecifications

        CopyImageRequest.Builder tagSpecifications​(TagSpecification... tagSpecifications)

        The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

        • To tag the new AMI, the value for ResourceType must be image.

        • To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

        If you specify other values for ResourceType, the request fails.

        To tag an AMI or snapshot after it has been created, see CreateTags.

        Parameters:
        tagSpecifications - The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

        • To tag the new AMI, the value for ResourceType must be image.

        • To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

        If you specify other values for ResourceType, the request fails.

        To tag an AMI or snapshot after it has been created, see CreateTags.

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

      • tagSpecifications

        CopyImageRequest.Builder tagSpecifications​(Consumer<TagSpecification.Builder>... tagSpecifications)

        The tags to apply to the new AMI and new snapshots. You can tag the AMI, the snapshots, or both.

        • To tag the new AMI, the value for ResourceType must be image.

        • To tag the new snapshots, the value for ResourceType must be snapshot. The same tag is applied to all the new snapshots.

        If you specify other values for ResourceType, the request fails.

        To tag an AMI or snapshot after it has been created, see CreateTags.

        This is a convenience method that creates an instance of the TagSpecification.Builder avoiding the need to create one manually via TagSpecification.builder().

        When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tagSpecifications(List).

        Parameters:
        tagSpecifications - a consumer that will call methods on TagSpecification.Builder
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        #tagSpecifications(java.util.Collection)