Interface CreatePolicyTemplateRequest.Builder

All Superinterfaces:
AwsRequest.Builder, Buildable, CopyableBuilder<CreatePolicyTemplateRequest.Builder,CreatePolicyTemplateRequest>, SdkBuilder<CreatePolicyTemplateRequest.Builder,CreatePolicyTemplateRequest>, SdkPojo, SdkRequest.Builder, VerifiedPermissionsRequest.Builder
Enclosing class:
CreatePolicyTemplateRequest
@Mutable @NotThreadSafe public static interface CreatePolicyTemplateRequest.Builder extends VerifiedPermissionsRequest.Builder, SdkPojo, CopyableBuilder<CreatePolicyTemplateRequest.Builder,CreatePolicyTemplateRequest>

  • Method Details

    • clientToken

      CreatePolicyTemplateRequest.Builder clientToken(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • policyStoreId

      CreatePolicyTemplateRequest.Builder policyStoreId(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreatePolicyTemplateRequest.Builder description(String description)

      Specifies a description for the policy template.

      Parameters:
      description - Specifies a description for the policy template.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statement

      CreatePolicyTemplateRequest.Builder statement(String statement)

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

      Parameters:
      statement - Specifies the content that you want to use for the new policy template, written in the Cedar policy language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      CreatePolicyTemplateRequest.Builder name(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.

      Parameters:
      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:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

      CreatePolicyTemplateRequest.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

      CreatePolicyTemplateRequest.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.