Package software.amazon.awssdk.services.xray.model

Interface PutResourcePolicyRequest.Builder

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, SdkBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>, SdkPojo, SdkRequest.Builder, XRayRequest.Builder

Enclosing class:

PutResourcePolicyRequest

@Mutable
@NotThreadSafe
public static interface PutResourcePolicyRequest.Builder
extends XRayRequest.Builder, SdkPojo, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

Method Summary

Modifier and Type	Method	Description
PutResourcePolicyRequest.Builder	bypassPolicyLockoutCheck(Boolean bypassPolicyLockoutCheck)	A flag to indicate whether to bypass the resource policy lockout safety check.
PutResourcePolicyRequest.Builder	overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
PutResourcePolicyRequest.Builder	overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
PutResourcePolicyRequest.Builder	policyDocument(String policyDocument)	The resource policy document, which can be up to 5kb in size.
PutResourcePolicyRequest.Builder	policyName(String policyName)	The name of the resource policy.
PutResourcePolicyRequest.Builder	policyRevisionId(String policyRevisionId)	Specifies a specific policy revision, to ensure an atomic create operation.

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

overrideConfiguration

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

applyMutation, build

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

equalsBySdkFields, sdkFieldNameToField, sdkFields

Methods inherited from interface software.amazon.awssdk.services.xray.model.XRayRequest.Builder

build

Method Detail

policyName

PutResourcePolicyRequest.Builder policyName(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.

policyDocument

PutResourcePolicyRequest.Builder policyDocument(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.

policyRevisionId

PutResourcePolicyRequest.Builder policyRevisionId(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.

bypassPolicyLockoutCheck

PutResourcePolicyRequest.Builder bypassPolicyLockoutCheck(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.

overrideConfiguration

PutResourcePolicyRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)

Specified by:

overrideConfiguration in interface AwsRequest.Builder

overrideConfiguration

PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)

Specified by:

overrideConfiguration in interface AwsRequest.Builder