com.amazonaws.services.xray.model

Class PutResourcePolicyRequest

java.lang.Object

com.amazonaws.AmazonWebServiceRequest

com.amazonaws.services.xray.model.PutResourcePolicyRequest

All Implemented Interfaces:

HandlerContextAware, ReadLimitInfo, Serializable, Cloneable

@Generated(value="com.amazonaws:aws-java-sdk-code-generator")
public class PutResourcePolicyRequest
extends AmazonWebServiceRequest
implements Serializable, Cloneable

See Also:

AWS API Documentation, Serialized Form

Field Summary

Fields inherited from class com.amazonaws.AmazonWebServiceRequest

NOOP

Constructor Summary

Constructors

Constructor and Description
PutResourcePolicyRequest()

Method Summary

Modifier and Type	Method and Description
PutResourcePolicyRequest	clone() Creates a shallow clone of this object for all fields except the handler context.
boolean	equals(Object obj)
Boolean	getBypassPolicyLockoutCheck() A flag to indicate whether to bypass the resource policy lockout safety check.
String	getPolicyDocument() The resource policy document, which can be up to 5kb in size.
String	getPolicyName() The name of the resource policy.
String	getPolicyRevisionId() Specifies a specific policy revision, to ensure an atomic create operation.
int	hashCode()
Boolean	isBypassPolicyLockoutCheck() A flag to indicate whether to bypass the resource policy lockout safety check.
void	setBypassPolicyLockoutCheck(Boolean bypassPolicyLockoutCheck) A flag to indicate whether to bypass the resource policy lockout safety check.
void	setPolicyDocument(String policyDocument) The resource policy document, which can be up to 5kb in size.
void	setPolicyName(String policyName) The name of the resource policy.
void	setPolicyRevisionId(String policyRevisionId) Specifies a specific policy revision, to ensure an atomic create operation.
String	toString() Returns a string representation of this object.
PutResourcePolicyRequest	withBypassPolicyLockoutCheck(Boolean bypassPolicyLockoutCheck) A flag to indicate whether to bypass the resource policy lockout safety check.
PutResourcePolicyRequest	withPolicyDocument(String policyDocument) The resource policy document, which can be up to 5kb in size.
PutResourcePolicyRequest	withPolicyName(String policyName) The name of the resource policy.
PutResourcePolicyRequest	withPolicyRevisionId(String policyRevisionId) Specifies a specific policy revision, to ensure an atomic create operation.

Methods inherited from class com.amazonaws.AmazonWebServiceRequest

addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

PutResourcePolicyRequest

public PutResourcePolicyRequest()

Method Detail

setPolicyName

public void setPolicyName(String policyName)

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Parameters:

policyName - The name of the resource policy. Must be unique within a specific Amazon Web Services account.

getPolicyName

public String getPolicyName()

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Returns:

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

withPolicyName

public PutResourcePolicyRequest withPolicyName(String policyName)

The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Parameters:

policyName - The name of the resource policy. Must be unique within a specific Amazon Web Services account.

Returns:

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

setPolicyDocument

public void setPolicyDocument(String policyDocument)

The resource policy document, which can be up to 5kb in size.

Parameters:

policyDocument - The resource policy document, which can be up to 5kb in size.

getPolicyDocument

public String getPolicyDocument()

The resource policy document, which can be up to 5kb in size.

Returns:

The resource policy document, which can be up to 5kb in size.

withPolicyDocument

public PutResourcePolicyRequest withPolicyDocument(String policyDocument)

The resource policy document, which can be up to 5kb in size.

Parameters:

policyDocument - The resource policy document, which can be up to 5kb in size.

Returns:

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

setPolicyRevisionId

public void setPolicyRevisionId(String 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.

Parameters:

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.

getPolicyRevisionId

public String getPolicyRevisionId()

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.

Returns:

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.

withPolicyRevisionId

public PutResourcePolicyRequest withPolicyRevisionId(String 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.

Parameters:

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.

Returns:

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

setBypassPolicyLockoutCheck

public void setBypassPolicyLockoutCheck(Boolean 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.

Parameters:

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.

getBypassPolicyLockoutCheck

public Boolean getBypassPolicyLockoutCheck()

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.

Returns:

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.

withBypassPolicyLockoutCheck

public PutResourcePolicyRequest withBypassPolicyLockoutCheck(Boolean 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.

Parameters:

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.

Returns:

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

isBypassPolicyLockoutCheck

public Boolean isBypassPolicyLockoutCheck()

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.

Returns:

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.

toString

public String toString()

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.

Overrides:

toString in class Object

Returns:

A string representation of this object.

See Also:

Object.toString()

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public PutResourcePolicyRequest clone()

Description copied from class: AmazonWebServiceRequest

Creates a shallow clone of this object for all fields except the handler context. Explicitly does not clone the deep structure of the other fields in the message.

Overrides:

clone in class AmazonWebServiceRequest

See Also:

Object.clone()