Package software.amazon.awssdk.services.kms.model

Class CreateAliasRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.kms.model.KmsRequest
software.amazon.awssdk.services.kms.model.CreateAliasRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateAliasRequest extends KmsRequest implements ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>

  • Method Details

    • aliasName

      public final String aliasName()

      Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

      Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

      The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

      Returns:
      Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias.

      Do not include confidential or sensitive information in this field. This field may be displayed in plaintext in CloudTrail logs and other output.

      The AliasName value must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for Amazon Web Services managed keys.

    • targetKeyId

      public final String targetKeyId()

      Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

      A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

      For help finding the key ID and ARN, see Find the key ID and key ARN in the Key Management Service Developer Guide .

      Specify the key ID or key ARN of the KMS key.

      For example:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

      Returns:
      Associates the alias with the specified customer managed key. The KMS key must be in the same Amazon Web Services Region.

      A valid key ID is required. If you supply a null or empty string value, this operation returns an error.

      For help finding the key ID and ARN, see Find the key ID and key ARN in the Key Management Service Developer Guide .

      Specify the key ID or key ARN of the KMS key.

      For example:

      • Key ID: 1234abcd-12ab-34cd-56ef-1234567890ab

      • Key ARN: arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab

      To get the key ID and key ARN for a KMS key, use ListKeys or DescribeKey.

    • toBuilder

      public CreateAliasRequest.Builder toBuilder()
      Specified by:
      toBuilder in interface ToCopyableBuilder<CreateAliasRequest.Builder,CreateAliasRequest>
      Specified by:
      toBuilder in class KmsRequest

    • builder

      public static CreateAliasRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends CreateAliasRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Specified by:
      equalsBySdkFields in interface SdkPojo

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Overrides:
      getValueForField in class SdkRequest

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo