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

Class PutKeyPolicyRequest

    • Method Detail

      • keyId

        public final String keyId()

        Sets the key policy on 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:
        Sets the key policy on 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()

        The name of the key policy. If no policy name is specified, the default value is default. The only valid value is default.

        Returns:
        The name of the key policy. If no policy name is specified, the default value is default. The only valid value is default.

      • policy

        public final String policy()

        The key policy to attach to the KMS key.

        The key policy must meet the following criteria:

        • The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)

        • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

        If either of the required Resource or Action elements are missing from a key policy statement, the policy statement has no effect. When a key policy statement is missing one of these elements, the KMS console correctly reports an error, but the PutKeyPolicy API request succeeds, even though the policy statement is ineffective.

        For more information on required key policy elements, see Elements in a key policy in the Key Management Service Developer Guide.

        A key policy document can include only the following characters:

        • Printable ASCII characters from the space character ( ) through the end of the ASCII character range.

        • Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ).

        • The tab ( ), line feed ( ), and carriage return ( ) special characters

        If the key policy exceeds the length constraint, KMS returns a LimitExceededException.

        For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

        Returns:
        The key policy to attach to the KMS key.

        The key policy must meet the following criteria:

        • The key policy must allow the calling principal to make a subsequent PutKeyPolicy request on the KMS key. This reduces the risk that the KMS key becomes unmanageable. For more information, see Default key policy in the Key Management Service Developer Guide. (To omit this condition, set BypassPolicyLockoutSafetyCheck to true.)

        • Each statement in the key policy must contain one or more principals. The principals in the key policy must exist and be visible to KMS. When you create a new Amazon Web Services principal, you might need to enforce a delay before including the new principal in a key policy because the new principal might not be immediately visible to KMS. For more information, see Changes that I make are not always immediately visible in the Amazon Web Services Identity and Access Management User Guide.

        If either of the required Resource or Action elements are missing from a key policy statement, the policy statement has no effect. When a key policy statement is missing one of these elements, the KMS console correctly reports an error, but the PutKeyPolicy API request succeeds, even though the policy statement is ineffective.

        For more information on required key policy elements, see Elements in a key policy in the Key Management Service Developer Guide.

        A key policy document can include only the following characters:

        • Printable ASCII characters from the space character ( ) through the end of the ASCII character range.

        • Printable characters in the Basic Latin and Latin-1 Supplement character set (through ÿ ).

        • The tab ( ), line feed ( ), and carriage return ( ) special characters

        If the key policy exceeds the length constraint, KMS returns a LimitExceededException.

        For information about key policies, see Key policies in KMS in the Key Management Service Developer Guide.For help writing and formatting a JSON policy document, see the IAM JSON Policy Reference in the Identity and Access Management User Guide .

      • bypassPolicyLockoutSafetyCheck

        public final Boolean bypassPolicyLockoutSafetyCheck()

        Skips ("bypasses") the key policy lockout safety check. The default value is false.

        Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

        For more information, see Default key policy in the Key Management Service Developer Guide.

        Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

        Returns:
        Skips ("bypasses") the key policy lockout safety check. The default value is false.

        Setting this value to true increases the risk that the KMS key becomes unmanageable. Do not set this value to true indiscriminately.

        For more information, see Default key policy in the Key Management Service Developer Guide.

        Use this parameter only when you intend to prevent the principal that is making the request from making a subsequent PutKeyPolicy request on the KMS key.

      • 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