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

Class GetKeyPolicyRequest

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.GetKeyPolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<GetKeyPolicyRequest.Builder,GetKeyPolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class GetKeyPolicyRequest extends KmsRequest implements ToCopyableBuilder<GetKeyPolicyRequest.Builder,GetKeyPolicyRequest>

  • Method Details

    • keyId

      public final String keyId()

      Gets the key policy for the specified KMS key.

      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:
      Gets the key policy for the specified KMS key.

      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.

    • policyName

      public final String policyName()

      Specifies the name of the key policy. If no policy name is specified, the default value is default. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

      Returns:
      Specifies the name of the key policy. If no policy name is specified, the default value is default. The only valid name is default. To get the names of key policies, use ListKeyPolicies.

    • toBuilder

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

    • builder

      public static GetKeyPolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends GetKeyPolicyRequest.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