Interface CreatePolicyRequest.Builder

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

  • Method Details

    • clientToken

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

      CreatePolicyRequest.Builder policyStoreId(String policyStoreId)

      Specifies the PolicyStoreId of the policy store you want to store the policy in.

      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 - Specifies the PolicyStoreId of the policy store you want to store the policy in.

      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.

    • definition

      CreatePolicyRequest.Builder definition(PolicyDefinition definition)

      A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

      Parameters:
      definition - A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      default CreatePolicyRequest.Builder definition(Consumer<PolicyDefinition.Builder> definition)

      A structure that specifies the policy type and content to use for the new policy. You must include either a static or a templateLinked element. The policy content must be written in the Cedar policy language.

      This is a convenience method that creates an instance of the PolicyDefinition.Builder avoiding the need to create one manually via PolicyDefinition.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to definition(PolicyDefinition).

      Parameters:
      definition - a consumer that will call methods on PolicyDefinition.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • name

      CreatePolicyRequest.Builder name(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 specify a name that is already associated with another policy in the policy store, you receive a ConflictException error.

      Parameters:
      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 specify a name that is already associated with another policy 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

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

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