Interface UpdatePolicyTemplateRequest.Builder

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

  • Method Details

    • policyStoreId

      UpdatePolicyTemplateRequest.Builder policyStoreId(String policyStoreId)

      Specifies the ID of the policy store that contains the policy template 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.

      Parameters:
      policyStoreId - Specifies the ID of the policy store that contains the policy template 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:
      Returns a reference to this object so that method calls can be chained together.

    • policyTemplateId

      UpdatePolicyTemplateRequest.Builder policyTemplateId(String policyTemplateId)

      Specifies the ID of the policy template that you want to update.

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

      • ID: PTEXAMPLEabcdefg111111

      • Name: name/example-policy-template

      Parameters:
      policyTemplateId - Specifies the ID of the policy template that you want to update.

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

      • ID: PTEXAMPLEabcdefg111111

      • Name: name/example-policy-template

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdatePolicyTemplateRequest.Builder description(String description)

      Specifies a new description to apply to the policy template.

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

    • statement

      UpdatePolicyTemplateRequest.Builder statement(String statement)

      Specifies new statement content written in Cedar policy language to replace the current body of the policy template.

      You can change only the following elements of the policy body:

      • The action referenced by the policy template.

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

      You can't change the following elements:

      • The effect (permit or forbid) of the policy template.

      • The principal referenced by the policy template.

      • The resource referenced by the policy template.

      Parameters:
      statement - Specifies new statement content written in Cedar policy language to replace the current body of the policy template.

      You can change only the following elements of the policy body:

      • The action referenced by the policy template.

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

      You can't change the following elements:

      • The effect (permit or forbid) of the policy template.

      • The principal referenced by the policy template.

      • The resource referenced by the policy template.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

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

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

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