/* * Copyright 2010-2023 Amazon.com, Inc. or its affiliates. All Rights Reserved. * * Licensed under the Apache License, Version 2.0 (the "License"). * You may not use this file except in compliance with the License. * A copy of the License is located at * * http://aws.amazon.com/apache2.0 * * or in the "license" file accompanying this file. This file is distributed * on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either * express or implied. See the License for the specific language governing * permissions and limitations under the License. */ package com.amazonaws.services.kms.model; import java.io.Serializable; import com.amazonaws.AmazonWebServiceRequest; /** *

* Gets a key policy attached to the specified KMS key. *

*

* Cross-account use: No. You cannot perform this operation on a KMS key * in a different Amazon Web Services account. *

*

* Required permissions: kms:GetKeyPolicy (key policy) *

*

* Related operations: PutKeyPolicy *

*/ public class GetKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable { /** *

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*

* Constraints:
* Length: 1 - 2048
*/ private String keyId; /** *

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [\w]+
*/ private String policyName; /** *

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*

* Constraints:
* Length: 1 - 2048
* * @return

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*/ public String getKeyId() { return keyId; } /** *

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*/ public void setKeyId(String keyId) { this.keyId = keyId; } /** *

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

*

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

* Constraints:
* Length: 1 - 2048
* * @param keyId

* Gets the key policy for the specified KMS key. *

*

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

*

* For example: *

* *

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

* @return A reference to this updated object so that method calls can be * chained together. */ public GetKeyPolicyRequest withKeyId(String keyId) { this.keyId = keyId; return this; } /** *

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [\w]+
* * @return

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*/ public String getPolicyName() { return policyName; } /** *

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*

* Constraints:
* Length: 1 - 128
* Pattern: [\w]+
* * @param policyName

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*/ public void setPolicyName(String policyName) { this.policyName = policyName; } /** *

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

*

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

* Constraints:
* Length: 1 - 128
* Pattern: [\w]+
* * @param policyName

* Specifies the name of the key policy. The only valid name is * default. To get the names of key policies, use * ListKeyPolicies. *

* @return A reference to this updated object so that method calls can be * chained together. */ public GetKeyPolicyRequest withPolicyName(String policyName) { this.policyName = policyName; return this; } /** * Returns a string representation of this object; useful for testing and * debugging. * * @return A string representation of this object. * @see java.lang.Object#toString() */ @Override public String toString() { StringBuilder sb = new StringBuilder(); sb.append("{"); if (getKeyId() != null) sb.append("KeyId: " + getKeyId() + ","); if (getPolicyName() != null) sb.append("PolicyName: " + getPolicyName()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof GetKeyPolicyRequest == false) return false; GetKeyPolicyRequest other = (GetKeyPolicyRequest) obj; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getPolicyName() == null ^ this.getPolicyName() == null) return false; if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false) return false; return true; } }