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

Class PutResourcePolicyRequest

java.lang.Object
software.amazon.awssdk.core.SdkRequest
software.amazon.awssdk.awscore.AwsRequest
software.amazon.awssdk.services.xray.model.XRayRequest
software.amazon.awssdk.services.xray.model.PutResourcePolicyRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
@Generated("software.amazon.awssdk:codegen") public final class PutResourcePolicyRequest extends XRayRequest implements ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>

  • Method Details

    • policyName

      public final String policyName()

      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.

    • policyDocument

      public final String policyDocument()

      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.

    • policyRevisionId

      public final 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.

      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.

    • bypassPolicyLockoutCheck

      public final 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.

      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.

    • toBuilder

      public PutResourcePolicyRequest.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<PutResourcePolicyRequest.Builder,PutResourcePolicyRequest>
      Specified by:
      toBuilder in class XRayRequest
      Returns:
      a builder for type T

    • builder

      public static PutResourcePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends PutResourcePolicyRequest.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class AwsRequest

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class AwsRequest

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final 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

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
      Description copied from class: SdkRequest
      Used to retrieve the value of a field from any class that extends SdkRequest. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, the SdkRequest.getValueForField(String, Class) method will again be available.
      Overrides:
      getValueForField in class SdkRequest
      Parameters:
      fieldName - The name of the member to be retrieved.
      clazz - The class to cast the returned object to.
      Returns:
      Optional containing the casted return value

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.