/* * 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; /** *

* Deletes a grant. Typically, you retire a grant when you no longer need its * permissions. To identify the grant to retire, use a grant token, or both the grant ID and a key identifier (key ID or key * ARN) of the KMS key. The CreateGrant operation returns both values. *

*

* This operation can be called by the retiring principal for a grant, by * the grantee principal if the grant allows the RetireGrant * operation, and by the Amazon Web Services account in which the grant is * created. It can also be called by principals to whom permission for retiring * a grant is delegated. For details, see Retiring and revoking grants in the Key Management Service Developer * Guide. *

*

* For detailed information about grants, including grant terminology, see Grants * in KMS in the Key Management Service Developer Guide . For * examples of working with grants in several programming languages, see Programming grants. *

*

* Cross-account use: Yes. You can retire a grant on a KMS key in a * different Amazon Web Services account. *

*

* Required permissions::Permission to retire a grant is determined * primarily by the grant. For details, see Retiring and revoking grants in the Key Management Service Developer * Guide. *

*

* Related operations: *

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

* Identifies the grant to be retired. You can use a grant token to identify * a new grant even before it has achieved eventual consistency. *

*

* Only the CreateGrant operation returns a grant token. For details, * see Grant token and Eventual consistency in the Key Management Service Developer * Guide. *

*

* Constraints:
* Length: 1 - 8192
*/ private String grantToken; /** *

* The key ARN KMS key associated with the grant. To find the key ARN, use * the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

*

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

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or ListRetirableGrants. *

* *

* Constraints:
* Length: 1 - 128
*/ private String grantId; /** *

* Checks if your request will succeed. DryRun is an optional * parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

*/ private Boolean dryRun; /** *

* Identifies the grant to be retired. You can use a grant token to identify * a new grant even before it has achieved eventual consistency. *

*

* Only the CreateGrant operation returns a grant token. For details, * see Grant token and Eventual consistency in the Key Management Service Developer * Guide. *

*

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

* Identifies the grant to be retired. You can use a grant token to * identify a new grant even before it has achieved eventual * consistency. *

*

* Only the CreateGrant operation returns a grant token. For * details, see Grant token and Eventual consistency in the Key Management Service * Developer Guide. *

*/ public String getGrantToken() { return grantToken; } /** *

* Identifies the grant to be retired. You can use a grant token to identify * a new grant even before it has achieved eventual consistency. *

*

* Only the CreateGrant operation returns a grant token. For details, * see Grant token and Eventual consistency in the Key Management Service Developer * Guide. *

*

* Constraints:
* Length: 1 - 8192
* * @param grantToken

* Identifies the grant to be retired. You can use a grant token * to identify a new grant even before it has achieved eventual * consistency. *

*

* Only the CreateGrant operation returns a grant token. * For details, see Grant token and Eventual consistency in the Key Management Service * Developer Guide. *

*/ public void setGrantToken(String grantToken) { this.grantToken = grantToken; } /** *

* Identifies the grant to be retired. You can use a grant token to identify * a new grant even before it has achieved eventual consistency. *

*

* Only the CreateGrant operation returns a grant token. For details, * see Grant token and Eventual consistency in the Key Management Service Developer * Guide. *

*

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

* Constraints:
* Length: 1 - 8192
* * @param grantToken

* Identifies the grant to be retired. You can use a grant token * to identify a new grant even before it has achieved eventual * consistency. *

*

* Only the CreateGrant operation returns a grant token. * For details, see Grant token and Eventual consistency in the Key Management Service * Developer Guide. *

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

* The key ARN KMS key associated with the grant. To find the key ARN, use * the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

*

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

* The key ARN KMS key associated with the grant. To find the key * ARN, use the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

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

* The key ARN KMS key associated with the grant. To find the key ARN, use * the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

*

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

* The key ARN KMS key associated with the grant. To find the key * ARN, use the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

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

* The key ARN KMS key associated with the grant. To find the key ARN, use * the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

*

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

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

* The key ARN KMS key associated with the grant. To find the key * ARN, use the ListKeys operation. *

*

* For example: * arn:aws:kms:us-east-2:444455556666:key/1234abcd-12ab-34cd-56ef-1234567890ab *

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

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or ListRetirableGrants. *

* *

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

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or * ListRetirableGrants. *

* */ public String getGrantId() { return grantId; } /** *

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or ListRetirableGrants. *

* *

* Constraints:
* Length: 1 - 128
* * @param grantId

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or * ListRetirableGrants. *

* */ public void setGrantId(String grantId) { this.grantId = grantId; } /** *

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or ListRetirableGrants. *

* *

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

* Constraints:
* Length: 1 - 128
* * @param grantId

* Identifies the grant to retire. To get the grant ID, use * CreateGrant, ListGrants, or * ListRetirableGrants. *

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

* Checks if your request will succeed. DryRun is an optional * parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

* * @return

* Checks if your request will succeed. DryRun is an * optional parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

*/ public Boolean isDryRun() { return dryRun; } /** *

* Checks if your request will succeed. DryRun is an optional * parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

* * @return

* Checks if your request will succeed. DryRun is an * optional parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

*/ public Boolean getDryRun() { return dryRun; } /** *

* Checks if your request will succeed. DryRun is an optional * parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

* * @param dryRun

* Checks if your request will succeed. DryRun is an * optional parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management * Service Developer Guide. *

*/ public void setDryRun(Boolean dryRun) { this.dryRun = dryRun; } /** *

* Checks if your request will succeed. DryRun is an optional * parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management Service * Developer Guide. *

*

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

* Checks if your request will succeed. DryRun is an * optional parameter. *

*

* To learn more about how to use this parameter, see Testing your KMS API calls in the Key Management * Service Developer Guide. *

* @return A reference to this updated object so that method calls can be * chained together. */ public RetireGrantRequest withDryRun(Boolean dryRun) { this.dryRun = dryRun; 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 (getGrantToken() != null) sb.append("GrantToken: " + getGrantToken() + ","); if (getKeyId() != null) sb.append("KeyId: " + getKeyId() + ","); if (getGrantId() != null) sb.append("GrantId: " + getGrantId() + ","); if (getDryRun() != null) sb.append("DryRun: " + getDryRun()); sb.append("}"); return sb.toString(); } @Override public int hashCode() { final int prime = 31; int hashCode = 1; hashCode = prime * hashCode + ((getGrantToken() == null) ? 0 : getGrantToken().hashCode()); hashCode = prime * hashCode + ((getKeyId() == null) ? 0 : getKeyId().hashCode()); hashCode = prime * hashCode + ((getGrantId() == null) ? 0 : getGrantId().hashCode()); hashCode = prime * hashCode + ((getDryRun() == null) ? 0 : getDryRun().hashCode()); return hashCode; } @Override public boolean equals(Object obj) { if (this == obj) return true; if (obj == null) return false; if (obj instanceof RetireGrantRequest == false) return false; RetireGrantRequest other = (RetireGrantRequest) obj; if (other.getGrantToken() == null ^ this.getGrantToken() == null) return false; if (other.getGrantToken() != null && other.getGrantToken().equals(this.getGrantToken()) == false) return false; if (other.getKeyId() == null ^ this.getKeyId() == null) return false; if (other.getKeyId() != null && other.getKeyId().equals(this.getKeyId()) == false) return false; if (other.getGrantId() == null ^ this.getGrantId() == null) return false; if (other.getGrantId() != null && other.getGrantId().equals(this.getGrantId()) == false) return false; if (other.getDryRun() == null ^ this.getDryRun() == null) return false; if (other.getDryRun() != null && other.getDryRun().equals(this.getDryRun()) == false) return false; return true; } }