Class UpdatePolicyRequest

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

  • Method Details

    • policyStoreId

      public final String policyStoreId()

      Specifies the ID of the policy store that contains the policy that you want to update.

      To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

      • ID: PSEXAMPLEabcdefg111111

      • Alias name: policy-store-alias/example-policy-store

      To view aliases, use ListPolicyStoreAliases.

      Returns:
      Specifies the ID of the policy store that contains the policy that you want to update.

      To specify a policy store, use its ID or alias name. When using an alias name, prefix it with policy-store-alias/. For example:

      • ID: PSEXAMPLEabcdefg111111

      • Alias name: policy-store-alias/example-policy-store

      To view aliases, use ListPolicyStoreAliases.

    • policyId

      public final String policyId()

      Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

      You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

      • ID: SPEXAMPLEabcdefg111111

      • Name: name/example-policy

      Returns:
      Specifies the ID of the policy that you want to update. To find this value, you can use ListPolicies.

      You can use the policy name in place of the policy ID. When using a name, prefix it with name/. For example:

      • ID: SPEXAMPLEabcdefg111111

      • Name: name/example-policy

    • definition

      public final UpdatePolicyDefinition definition()

      Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

      If you don't specify this parameter, the existing policy definition remains unchanged.

      You can change only the following elements from the policy definition:

      • The action referenced by the policy.

      • Any conditional clauses, such as when or unless clauses.

      You can't change the following elements:

      • Changing from static to templateLinked.

      • Changing the effect of the policy from permit or forbid.

      • The principal referenced by the policy.

      • The resource referenced by the policy.

      Returns:
      Specifies the updated policy content that you want to replace on the specified policy. The content must be valid Cedar policy language text.

      If you don't specify this parameter, the existing policy definition remains unchanged.

      You can change only the following elements from the policy definition:

      • The action referenced by the policy.

      • Any conditional clauses, such as when or unless clauses.

      You can't change the following elements:

      • Changing from static to templateLinked.

      • Changing the effect of the policy from permit or forbid.

      • The principal referenced by the policy.

      • The resource referenced by the policy.

    • name

      public final String name()

      Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

      If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

      If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

      Returns:
      Specifies a name for the policy that is unique among all policies within the policy store. You can use the name in place of the policy ID in API operations that reference the policy. The name must be prefixed with name/.

      If you don't include the name in an update request, the existing name is unchanged. To remove a name, set it to an empty string ("").

      If you specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

    • toBuilder

      public UpdatePolicyRequest.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<UpdatePolicyRequest.Builder,UpdatePolicyRequest>
      Specified by:
      toBuilder in class VerifiedPermissionsRequest
      Returns:
      a builder for type T

    • builder

      public static UpdatePolicyRequest.Builder builder()

    • serializableBuilderClass

      public static Class<? extends UpdatePolicyRequest.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.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.