/*
* Copyright 2010-2016 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;
/**
* <p>
* Retrieves a policy attached to the specified key.
* </p>
*/
public class GetKeyPolicyRequest extends AmazonWebServiceRequest implements Serializable {
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier or the fully specified ARN to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*/
private String keyId;
/**
* <p>
* String that contains the name of the policy. Currently, this must be
* "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 128<br/>
* <b>Pattern: </b>[\w]+<br/>
*/
private String policyName;
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier or the fully specified ARN to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @return <p>
* A unique identifier for the customer master key. This value can
* be a globally unique identifier or the fully specified ARN to a
* key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-
* 1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
*/
public String getKeyId() {
return keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier or the fully specified ARN to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier or the fully specified ARN
* to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
*/
public void setKeyId(String keyId) {
this.keyId = keyId;
}
/**
* <p>
* A unique identifier for the customer master key. This value can be a
* globally unique identifier or the fully specified ARN to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678-1234-1234
* -1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example - 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 256<br/>
*
* @param keyId <p>
* A unique identifier for the customer master key. This value
* can be a globally unique identifier or the fully specified ARN
* to a key.
* </p>
* <ul>
* <li>
* <p>
* Key ARN Example -
* arn:aws:kms:us-east-1:123456789012:key/12345678
* -1234-1234-1234-123456789012
* </p>
* </li>
* <li>
* <p>
* Globally Unique Key ID Example -
* 12345678-1234-1234-1234-123456789012
* </p>
* </li>
* </ul>
* @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;
}
/**
* <p>
* String that contains the name of the policy. Currently, this must be
* "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 128<br/>
* <b>Pattern: </b>[\w]+<br/>
*
* @return <p>
* String that contains the name of the policy. Currently, this must
* be "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
*/
public String getPolicyName() {
return policyName;
}
/**
* <p>
* String that contains the name of the policy. Currently, this must be
* "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 128<br/>
* <b>Pattern: </b>[\w]+<br/>
*
* @param policyName <p>
* String that contains the name of the policy. Currently, this
* must be "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
* <p>
* String that contains the name of the policy. Currently, this must be
* "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
* <p>
* Returns a reference to this object so that method calls can be chained
* together.
* <p>
* <b>Constraints:</b><br/>
* <b>Length: </b>1 - 128<br/>
* <b>Pattern: </b>[\w]+<br/>
*
* @param policyName <p>
* String that contains the name of the policy. Currently, this
* must be "default". Policy names can be discovered by calling
* <a>ListKeyPolicies</a>.
* </p>
* @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;
}
}