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

Interface ModifyEbsDefaultKmsKeyIdRequest.Builder

    • Method Detail

      • kmsKeyId

        ModifyEbsDefaultKmsKeyIdRequest.Builder kmsKeyId​(String kmsKeyId)

        The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

        You can specify the 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 ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

        Amazon EBS does not support asymmetric KMS keys.

        Parameters:
        kmsKeyId - The identifier of the Key Management Service (KMS) KMS key to use for Amazon EBS encryption. If this parameter is not specified, your KMS key for Amazon EBS is used. If KmsKeyId is specified, the encrypted state must be true.

        You can specify the 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 ID, alias, or ARN that is not valid, the action can appear to complete, but eventually fails.

        Amazon EBS does not support asymmetric KMS keys.

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

      • dryRun

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