com.amazonaws.services.xray.model.PutResourcePolicyRequest Maven / Gradle / Ivy
Show all versions of aws-java-sdk-xray Show documentation
/*
* Copyright 2019-2024 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.xray.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 PutResourcePolicyRequest extends com.amazonaws.AmazonWebServiceRequest implements Serializable, Cloneable {
/**
*
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*
*/
private String policyName;
/**
*
* The resource policy document, which can be up to 5kb in size.
*
*/
private String policyDocument;
/**
*
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is
* created if it does not exist, or updated with an incremented revision id. The revision id is unique to each
* policy in the account.
*
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of
* 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a
* resource policy with the same name already exists.
*
*/
private String policyRevisionId;
/**
*
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
*
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true
* indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal that is
* making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*
*/
private Boolean bypassPolicyLockoutCheck;
/**
*
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*
*
* @param policyName
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*/
public void setPolicyName(String policyName) {
this.policyName = policyName;
}
/**
*
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*
*
* @return The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*/
public String getPolicyName() {
return this.policyName;
}
/**
*
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
*
*
* @param policyName
* The name of the resource policy. Must be unique within a specific Amazon Web Services account.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withPolicyName(String policyName) {
setPolicyName(policyName);
return this;
}
/**
*
* The resource policy document, which can be up to 5kb in size.
*
*
* @param policyDocument
* The resource policy document, which can be up to 5kb in size.
*/
public void setPolicyDocument(String policyDocument) {
this.policyDocument = policyDocument;
}
/**
*
* The resource policy document, which can be up to 5kb in size.
*
*
* @return The resource policy document, which can be up to 5kb in size.
*/
public String getPolicyDocument() {
return this.policyDocument;
}
/**
*
* The resource policy document, which can be up to 5kb in size.
*
*
* @param policyDocument
* The resource policy document, which can be up to 5kb in size.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withPolicyDocument(String policyDocument) {
setPolicyDocument(policyDocument);
return this;
}
/**
*
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is
* created if it does not exist, or updated with an incremented revision id. The revision id is unique to each
* policy in the account.
*
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of
* 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a
* resource policy with the same name already exists.
*
*
* @param policyRevisionId
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy
* is created if it does not exist, or updated with an incremented revision id. The revision id is unique to
* each policy in the account.
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a
* PolicyRevisionId of 0. In this case, the operation will fail with an
* InvalidPolicyRevisionIdException exception if a resource policy with the same name already
* exists.
*/
public void setPolicyRevisionId(String policyRevisionId) {
this.policyRevisionId = policyRevisionId;
}
/**
*
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is
* created if it does not exist, or updated with an incremented revision id. The revision id is unique to each
* policy in the account.
*
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of
* 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a
* resource policy with the same name already exists.
*
*
* @return Specifies a specific policy revision, to ensure an atomic create operation. By default the resource
* policy is created if it does not exist, or updated with an incremented revision id. The revision id is
* unique to each policy in the account.
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a
* PolicyRevisionId of 0. In this case, the operation will fail with an
* InvalidPolicyRevisionIdException exception if a resource policy with the same name already
* exists.
*/
public String getPolicyRevisionId() {
return this.policyRevisionId;
}
/**
*
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy is
* created if it does not exist, or updated with an incremented revision id. The revision id is unique to each
* policy in the account.
*
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a PolicyRevisionId of
* 0. In this case, the operation will fail with an InvalidPolicyRevisionIdException exception if a
* resource policy with the same name already exists.
*
*
* @param policyRevisionId
* Specifies a specific policy revision, to ensure an atomic create operation. By default the resource policy
* is created if it does not exist, or updated with an incremented revision id. The revision id is unique to
* each policy in the account.
*
* If the policy revision id does not match the latest revision id, the operation will fail with an
* InvalidPolicyRevisionIdException exception. You can also provide a
* PolicyRevisionId of 0. In this case, the operation will fail with an
* InvalidPolicyRevisionIdException exception if a resource policy with the same name already
* exists.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withPolicyRevisionId(String policyRevisionId) {
setPolicyRevisionId(policyRevisionId);
return this;
}
/**
*
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
*
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true
* indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal that is
* making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*
*
* @param bypassPolicyLockoutCheck
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal
* that is making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*/
public void setBypassPolicyLockoutCheck(Boolean bypassPolicyLockoutCheck) {
this.bypassPolicyLockoutCheck = bypassPolicyLockoutCheck;
}
/**
*
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
*
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true
* indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal that is
* making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*
*
* @return A flag to indicate whether to bypass the resource policy lockout safety check.
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal
* that is making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*/
public Boolean getBypassPolicyLockoutCheck() {
return this.bypassPolicyLockoutCheck;
}
/**
*
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
*
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true
* indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal that is
* making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*
*
* @param bypassPolicyLockoutCheck
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal
* that is making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
* @return Returns a reference to this object so that method calls can be chained together.
*/
public PutResourcePolicyRequest withBypassPolicyLockoutCheck(Boolean bypassPolicyLockoutCheck) {
setBypassPolicyLockoutCheck(bypassPolicyLockoutCheck);
return this;
}
/**
*
* A flag to indicate whether to bypass the resource policy lockout safety check.
*
*
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value to true
* indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal that is
* making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*
*
* @return A flag to indicate whether to bypass the resource policy lockout safety check.
*
* Setting this value to true increases the risk that the policy becomes unmanageable. Do not set this value
* to true indiscriminately.
*
*
*
* Use this parameter only when you include a policy in the request and you intend to prevent the principal
* that is making the request from making a subsequent PutResourcePolicy request.
*
*
* The default value is false.
*/
public Boolean isBypassPolicyLockoutCheck() {
return this.bypassPolicyLockoutCheck;
}
/**
* 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 (getPolicyName() != null)
sb.append("PolicyName: ").append(getPolicyName()).append(",");
if (getPolicyDocument() != null)
sb.append("PolicyDocument: ").append(getPolicyDocument()).append(",");
if (getPolicyRevisionId() != null)
sb.append("PolicyRevisionId: ").append(getPolicyRevisionId()).append(",");
if (getBypassPolicyLockoutCheck() != null)
sb.append("BypassPolicyLockoutCheck: ").append(getBypassPolicyLockoutCheck());
sb.append("}");
return sb.toString();
}
@Override
public boolean equals(Object obj) {
if (this == obj)
return true;
if (obj == null)
return false;
if (obj instanceof PutResourcePolicyRequest == false)
return false;
PutResourcePolicyRequest other = (PutResourcePolicyRequest) obj;
if (other.getPolicyName() == null ^ this.getPolicyName() == null)
return false;
if (other.getPolicyName() != null && other.getPolicyName().equals(this.getPolicyName()) == false)
return false;
if (other.getPolicyDocument() == null ^ this.getPolicyDocument() == null)
return false;
if (other.getPolicyDocument() != null && other.getPolicyDocument().equals(this.getPolicyDocument()) == false)
return false;
if (other.getPolicyRevisionId() == null ^ this.getPolicyRevisionId() == null)
return false;
if (other.getPolicyRevisionId() != null && other.getPolicyRevisionId().equals(this.getPolicyRevisionId()) == false)
return false;
if (other.getBypassPolicyLockoutCheck() == null ^ this.getBypassPolicyLockoutCheck() == null)
return false;
if (other.getBypassPolicyLockoutCheck() != null && other.getBypassPolicyLockoutCheck().equals(this.getBypassPolicyLockoutCheck()) == false)
return false;
return true;
}
@Override
public int hashCode() {
final int prime = 31;
int hashCode = 1;
hashCode = prime * hashCode + ((getPolicyName() == null) ? 0 : getPolicyName().hashCode());
hashCode = prime * hashCode + ((getPolicyDocument() == null) ? 0 : getPolicyDocument().hashCode());
hashCode = prime * hashCode + ((getPolicyRevisionId() == null) ? 0 : getPolicyRevisionId().hashCode());
hashCode = prime * hashCode + ((getBypassPolicyLockoutCheck() == null) ? 0 : getBypassPolicyLockoutCheck().hashCode());
return hashCode;
}
@Override
public PutResourcePolicyRequest clone() {
return (PutResourcePolicyRequest) super.clone();
}
}