com.amazonaws.services.accessanalyzer.model.KmsGrantConfiguration Maven / Gradle / Ivy
/*
* 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.accessanalyzer.model;
import java.io.Serializable;
import javax.annotation.Generated;
import com.amazonaws.protocol.StructuredPojo;
import com.amazonaws.protocol.ProtocolMarshaller;
/**
*
* A proposed grant configuration for a KMS key. For more information, see CreateGrant.
*
*
* @see AWS API Documentation
*/
@Generated("com.amazonaws:aws-java-sdk-code-generator")
public class KmsGrantConfiguration implements Serializable, Cloneable, StructuredPojo {
/**
*
* A list of operations that the grant permits.
*
*/
private java.util.List operations;
/**
*
* The principal that is given permission to perform the operations that the grant permits.
*
*/
private String granteePrincipal;
/**
*
* The principal that is given permission to retire the grant by using RetireGrant operation.
*
*/
private String retiringPrincipal;
/**
*
* Use this structure to propose allowing cryptographic
* operations in the grant only when the operation request includes the specified encryption
* context.
*
*/
private KmsGrantConstraints constraints;
/**
*
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants
* issued by accounts other than the owner of the key.
*
*/
private String issuingAccount;
/**
*
* A list of operations that the grant permits.
*
*
* @return A list of operations that the grant permits.
* @see KmsGrantOperation
*/
public java.util.List getOperations() {
return operations;
}
/**
*
* A list of operations that the grant permits.
*
*
* @param operations
* A list of operations that the grant permits.
* @see KmsGrantOperation
*/
public void setOperations(java.util.Collection operations) {
if (operations == null) {
this.operations = null;
return;
}
this.operations = new java.util.ArrayList(operations);
}
/**
*
* A list of operations that the grant permits.
*
*
* NOTE: This method appends the values to the existing list (if any). Use
* {@link #setOperations(java.util.Collection)} or {@link #withOperations(java.util.Collection)} if you want to
* override the existing values.
*
*
* @param operations
* A list of operations that the grant permits.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KmsGrantOperation
*/
public KmsGrantConfiguration withOperations(String... operations) {
if (this.operations == null) {
setOperations(new java.util.ArrayList(operations.length));
}
for (String ele : operations) {
this.operations.add(ele);
}
return this;
}
/**
*
* A list of operations that the grant permits.
*
*
* @param operations
* A list of operations that the grant permits.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KmsGrantOperation
*/
public KmsGrantConfiguration withOperations(java.util.Collection operations) {
setOperations(operations);
return this;
}
/**
*
* A list of operations that the grant permits.
*
*
* @param operations
* A list of operations that the grant permits.
* @return Returns a reference to this object so that method calls can be chained together.
* @see KmsGrantOperation
*/
public KmsGrantConfiguration withOperations(KmsGrantOperation... operations) {
java.util.ArrayList operationsCopy = new java.util.ArrayList(operations.length);
for (KmsGrantOperation value : operations) {
operationsCopy.add(value.toString());
}
if (getOperations() == null) {
setOperations(operationsCopy);
} else {
getOperations().addAll(operationsCopy);
}
return this;
}
/**
*
* The principal that is given permission to perform the operations that the grant permits.
*
*
* @param granteePrincipal
* The principal that is given permission to perform the operations that the grant permits.
*/
public void setGranteePrincipal(String granteePrincipal) {
this.granteePrincipal = granteePrincipal;
}
/**
*
* The principal that is given permission to perform the operations that the grant permits.
*
*
* @return The principal that is given permission to perform the operations that the grant permits.
*/
public String getGranteePrincipal() {
return this.granteePrincipal;
}
/**
*
* The principal that is given permission to perform the operations that the grant permits.
*
*
* @param granteePrincipal
* The principal that is given permission to perform the operations that the grant permits.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KmsGrantConfiguration withGranteePrincipal(String granteePrincipal) {
setGranteePrincipal(granteePrincipal);
return this;
}
/**
*
* The principal that is given permission to retire the grant by using RetireGrant operation.
*
*
* @param retiringPrincipal
* The principal that is given permission to retire the grant by using RetireGrant operation.
*/
public void setRetiringPrincipal(String retiringPrincipal) {
this.retiringPrincipal = retiringPrincipal;
}
/**
*
* The principal that is given permission to retire the grant by using RetireGrant operation.
*
*
* @return The principal that is given permission to retire the grant by using RetireGrant
* operation.
*/
public String getRetiringPrincipal() {
return this.retiringPrincipal;
}
/**
*
* The principal that is given permission to retire the grant by using RetireGrant operation.
*
*
* @param retiringPrincipal
* The principal that is given permission to retire the grant by using RetireGrant operation.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KmsGrantConfiguration withRetiringPrincipal(String retiringPrincipal) {
setRetiringPrincipal(retiringPrincipal);
return this;
}
/**
*
* Use this structure to propose allowing cryptographic
* operations in the grant only when the operation request includes the specified encryption
* context.
*
*
* @param constraints
* Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption
* context.
*/
public void setConstraints(KmsGrantConstraints constraints) {
this.constraints = constraints;
}
/**
*
* Use this structure to propose allowing cryptographic
* operations in the grant only when the operation request includes the specified encryption
* context.
*
*
* @return Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption
* context.
*/
public KmsGrantConstraints getConstraints() {
return this.constraints;
}
/**
*
* Use this structure to propose allowing cryptographic
* operations in the grant only when the operation request includes the specified encryption
* context.
*
*
* @param constraints
* Use this structure to propose allowing cryptographic operations in the grant only when the operation request includes the specified encryption
* context.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KmsGrantConfiguration withConstraints(KmsGrantConstraints constraints) {
setConstraints(constraints);
return this;
}
/**
*
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants
* issued by accounts other than the owner of the key.
*
*
* @param issuingAccount
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS
* grants issued by accounts other than the owner of the key.
*/
public void setIssuingAccount(String issuingAccount) {
this.issuingAccount = issuingAccount;
}
/**
*
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants
* issued by accounts other than the owner of the key.
*
*
* @return The Amazon Web Services account under which the grant was issued. The account is used to propose KMS
* grants issued by accounts other than the owner of the key.
*/
public String getIssuingAccount() {
return this.issuingAccount;
}
/**
*
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS grants
* issued by accounts other than the owner of the key.
*
*
* @param issuingAccount
* The Amazon Web Services account under which the grant was issued. The account is used to propose KMS
* grants issued by accounts other than the owner of the key.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public KmsGrantConfiguration withIssuingAccount(String issuingAccount) {
setIssuingAccount(issuingAccount);
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 (getOperations() != null)
sb.append("Operations: ").append(getOperations()).append(",");
if (getGranteePrincipal() != null)
sb.append("GranteePrincipal: ").append(getGranteePrincipal()).append(",");
if (getRetiringPrincipal() != null)
sb.append("RetiringPrincipal: ").append(getRetiringPrincipal()).append(",");
if (getConstraints() != null)
sb.append("Constraints: ").append(getConstraints()).append(",");
if (getIssuingAccount() != null)
sb.append("IssuingAccount: ").append(getIssuingAccount());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof KmsGrantConfiguration == false)
return false;
KmsGrantConfiguration other = (KmsGrantConfiguration) obj;
if (other.getOperations() == null ^ this.getOperations() == null)
return false;
if (other.getOperations() != null && other.getOperations().equals(this.getOperations()) == false)
return false;
if (other.getGranteePrincipal() == null ^ this.getGranteePrincipal() == null)
return false;
if (other.getGranteePrincipal() != null && other.getGranteePrincipal().equals(this.getGranteePrincipal()) == false)
return false;
if (other.getRetiringPrincipal() == null ^ this.getRetiringPrincipal() == null)
return false;
if (other.getRetiringPrincipal() != null && other.getRetiringPrincipal().equals(this.getRetiringPrincipal()) == false)
return false;
if (other.getConstraints() == null ^ this.getConstraints() == null)
return false;
if (other.getConstraints() != null && other.getConstraints().equals(this.getConstraints()) == false)
return false;
if (other.getIssuingAccount() == null ^ this.getIssuingAccount() == null)
return false;
if (other.getIssuingAccount() != null && other.getIssuingAccount().equals(this.getIssuingAccount()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getOperations() == null) ? 0 : getOperations().hashCode());
hashCode = prime * hashCode + ((getGranteePrincipal() == null) ? 0 : getGranteePrincipal().hashCode());
hashCode = prime * hashCode + ((getRetiringPrincipal() == null) ? 0 : getRetiringPrincipal().hashCode());
hashCode = prime * hashCode + ((getConstraints() == null) ? 0 : getConstraints().hashCode());
hashCode = prime * hashCode + ((getIssuingAccount() == null) ? 0 : getIssuingAccount().hashCode());
return hashCode;
}
@Override
public KmsGrantConfiguration clone() {
try {
return (KmsGrantConfiguration) super.clone();
} catch (CloneNotSupportedException e) {
throw new IllegalStateException("Got a CloneNotSupportedException from Object.clone() " + "even though we're Cloneable!", e);
}
}
@com.amazonaws.annotation.SdkInternalApi
@Override
public void marshall(ProtocolMarshaller protocolMarshaller) {
com.amazonaws.services.accessanalyzer.model.transform.KmsGrantConfigurationMarshaller.getInstance().marshall(this, protocolMarshaller);
}
}