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
public static interface PutResourcePolicyRequest.Builder extends XRayRequest.Builder, SdkPojo, CopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • 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)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      overrideConfiguration - The override configuration.
      Returns:
      This object for method chaining.

    • overrideConfiguration

      PutResourcePolicyRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
      Description copied from interface: AwsRequest.Builder
      Add an optional request override configuration.
      Specified by:
      overrideConfiguration in interface AwsRequest.Builder
      Parameters:
      builderConsumer - A Consumer to which an empty AwsRequestOverrideConfiguration.Builder will be given.
      Returns:
      This object for method chaining.