Class CopyImageRequest

    • Constructor Detail

      • CopyImageRequest

        public CopyImageRequest()
    • Method Detail

      • setSourceRegion

        public void setSourceRegion​(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.
      • getSourceRegion

        public String getSourceRegion()

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

        Returns:
        The name of the region that contains the AMI to copy.
      • withSourceRegion

        public CopyImageRequest withSourceRegion​(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.
      • setSourceImageId

        public void setSourceImageId​(String sourceImageId)

        The ID of the AMI to copy.

        Parameters:
        sourceImageId - The ID of the AMI to copy.
      • getSourceImageId

        public String getSourceImageId()

        The ID of the AMI to copy.

        Returns:
        The ID of the AMI to copy.
      • withSourceImageId

        public CopyImageRequest withSourceImageId​(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.
      • setName

        public void setName​(String name)

        The name of the new AMI in the destination region.

        Parameters:
        name - The name of the new AMI in the destination region.
      • getName

        public String getName()

        The name of the new AMI in the destination region.

        Returns:
        The name of the new AMI in the destination region.
      • withName

        public CopyImageRequest withName​(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.
      • setDescription

        public void setDescription​(String description)

        A description for the new AMI in the destination region.

        Parameters:
        description - A description for the new AMI in the destination region.
      • getDescription

        public String getDescription()

        A description for the new AMI in the destination region.

        Returns:
        A description for the new AMI in the destination region.
      • withDescription

        public CopyImageRequest withDescription​(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.
      • setClientToken

        public void setClientToken​(String clientToken)

        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

        Parameters:
        clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
      • getClientToken

        public String getClientToken()

        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

        Returns:
        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
      • withClientToken

        public CopyImageRequest withClientToken​(String clientToken)

        Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.

        Parameters:
        clientToken - Unique, case-sensitive identifier you provide to ensure idempotency of the request. For more information, see How to Ensure Idempotency in the Amazon Elastic Compute Cloud User Guide.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • setEncrypted

        public void setEncrypted​(Boolean encrypted)

        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

        Parameters:
        encrypted - Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
      • getEncrypted

        public Boolean getEncrypted()

        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

        Returns:
        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
      • withEncrypted

        public CopyImageRequest withEncrypted​(Boolean encrypted)

        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

        Parameters:
        encrypted - Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with 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.
      • isEncrypted

        public Boolean isEncrypted()

        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.

        Returns:
        Specifies whether the destination snapshots of the copied image should be encrypted. The default CMK for EBS is used unless a non-default AWS Key Management Service (AWS KMS) CMK is specified with KmsKeyId. For more information, see Amazon EBS Encryption in the Amazon Elastic Compute Cloud User Guide.
      • setKmsKeyId

        public void setKmsKeyId​(String kmsKeyId)

        The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

        Parameters:
        kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
      • getKmsKeyId

        public String getKmsKeyId()

        The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

        Returns:
        The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
      • withKmsKeyId

        public CopyImageRequest withKmsKeyId​(String kmsKeyId)

        The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.

        Parameters:
        kmsKeyId - The full ARN of the AWS Key Management Service (AWS KMS) CMK to use when encrypting the snapshots of an image during a copy operation. 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. The 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. The specified CMK must exist in the region that the snapshot is being copied to. If a KmsKeyId is specified, the Encrypted flag must also be set.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
      • toString

        public String toString()
        Returns a string representation of this object; useful for testing and debugging.
        Overrides:
        toString in class Object
        Returns:
        A string representation of this object.
        See Also:
        Object.toString()
      • hashCode

        public int hashCode()
        Overrides:
        hashCode in class Object