Interface UpdatePolicyRequest.Builder

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

  • Method Details

    • policyEngineId

      UpdatePolicyRequest.Builder policyEngineId(String policyEngineId)

      The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.

      Parameters:
      policyEngineId - The identifier of the policy engine that manages the policy to be updated. This ensures the policy is updated within the correct policy engine context.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyId

      UpdatePolicyRequest.Builder policyId(String policyId)

      The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.

      Parameters:
      policyId - The unique identifier of the policy to be updated. This must be a valid policy ID that exists within the specified policy engine.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      UpdatePolicyRequest.Builder description(String description)

      The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.

      Parameters:
      description - The new human-readable description for the policy. This optional field allows updating the policy's documentation while keeping the same policy logic.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      UpdatePolicyRequest.Builder definition(PolicyDefinition definition)

      The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.

      Parameters:
      definition - The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

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

      The new Cedar policy statement that defines the access control rules. This replaces the existing policy definition with new logic while maintaining the policy's identity.

      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:

    • validationMode

      UpdatePolicyRequest.Builder validationMode(String validationMode)

      The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.

      Parameters:
      validationMode - The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • validationMode

      UpdatePolicyRequest.Builder validationMode(PolicyValidationMode validationMode)

      The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.

      Parameters:
      validationMode - The validation mode for the policy update. Determines how Cedar analyzer validation results are handled during policy updates. FAIL_ON_ANY_FINDINGS runs the Cedar analyzer and fails the update if validation issues are detected, ensuring the policy conforms to the Cedar schema and tool context. IGNORE_ALL_FINDINGS runs the Cedar analyzer but allows updates despite validation warnings. Use FAIL_ON_ANY_FINDINGS to ensure policy correctness during updates, especially when modifying policy logic or conditions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • overrideConfiguration

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

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