/* * Copyright 2018-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 javax.annotation.Generated; import com.amazonaws.AmazonWebServiceRequest; /** * * @see AWS API * Documentation */ @Generated("com.amazonaws:aws-java-sdk-code-generator") public class GetKeyPolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable { /** *
* 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. *
*/ 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.
*
* 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. *
* * @param 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. */ 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: *
*
* 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. *
* * @return 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. */ public String getKeyId() { return this.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. *
* * @param 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. * @return Returns a reference to this object so that method calls can be chained together. */ public GetKeyPolicyRequest withKeyId(String keyId) { setKeyId(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.
*
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.
*
default
. To get the names of
* key policies, use ListKeyPolicies.
*/
public String getPolicyName() {
return this.policyName;
}
/**
*
* Specifies the name of the key policy. The only valid name is default
. To get the names of key
* policies, use ListKeyPolicies.
*
default
. To get the names of key
* policies, use ListKeyPolicies.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public GetKeyPolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
* 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.
*
* @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: ").append(getKeyId()).append(",");
if (getPolicyName() != null)
sb.append("PolicyName: ").append(getPolicyName());
sb.append("}");
return sb.toString();
}
@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;
}
@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 GetKeyPolicyRequest clone() {
return (GetKeyPolicyRequest) super.clone();
}
}