Class CreatePolicyTemplateRequest

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.CreatePolicyTemplateRequest
All Implemented Interfaces:
SdkPojo, ToCopyableBuilder<CreatePolicyTemplateRequest.Builder,CreatePolicyTemplateRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreatePolicyTemplateRequest extends VerifiedPermissionsRequest implements ToCopyableBuilder<CreatePolicyTemplateRequest.Builder,CreatePolicyTemplateRequest>

  • Method Details

    • clientToken

      public final String clientToken()

      Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

      Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

      Returns:
      Specifies a unique, case-sensitive ID that you provide to ensure the idempotency of the request. This lets you safely retry the request without accidentally performing the same operation a second time. Passing the same value to a later call to an operation requires that you also pass the same value for all other parameters. We recommend that you use a UUID type of value..

      If you don't provide this value, then Amazon Web Services generates a random one for you.

      If you retry the operation with the same ClientToken, but with different parameters, the retry fails with an ConflictException error.

      Verified Permissions recognizes a ClientToken for eight hours. After eight hours, the next request with the same parameters performs the operation again regardless of the value of ClientToken.

    • policyStoreId

      public final String policyStoreId()

      The ID of the policy store in which to create the policy template.

      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:
      The ID of the policy store in which to create the policy template.

      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.

    • description

      public final String description()

      Specifies a description for the policy template.

      Returns:
      Specifies a description for the policy template.

    • statement

      public final String statement()

      Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

      Returns:
      Specifies the content that you want to use for the new policy template, written in the Cedar policy language.

    • name

      public final String name()

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

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

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

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

    • toBuilder

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

    • builder

      public static CreatePolicyTemplateRequest.Builder builder()

    • serializableBuilderClass

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