Interface GetPolicyResponse.Builder

All Superinterfaces:
AwsResponse.Builder, BedrockAgentCoreControlResponse.Builder, Buildable, CopyableBuilder<GetPolicyResponse.Builder,GetPolicyResponse>, SdkBuilder<GetPolicyResponse.Builder,GetPolicyResponse>, SdkPojo, SdkResponse.Builder
Enclosing class:
GetPolicyResponse
@Mutable @NotThreadSafe public static interface GetPolicyResponse.Builder extends BedrockAgentCoreControlResponse.Builder, SdkPojo, CopyableBuilder<GetPolicyResponse.Builder,GetPolicyResponse>

  • Method Details

    • policyId

      GetPolicyResponse.Builder policyId(String policyId)

      The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.

      Parameters:
      policyId - The unique identifier of the retrieved policy. This matches the policy ID provided in the request and serves as the system identifier for the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • name

      GetPolicyResponse.Builder name(String name)

      The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.

      Parameters:
      name - The customer-assigned name of the policy. This is the human-readable identifier that was specified when the policy was created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyEngineId

      GetPolicyResponse.Builder policyEngineId(String policyEngineId)

      The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.

      Parameters:
      policyEngineId - The identifier of the policy engine that manages this policy. This confirms the policy engine context for the retrieved policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

      GetPolicyResponse.Builder definition(PolicyDefinition definition)

      The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

      Parameters:
      definition - The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • definition

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

      The Cedar policy statement that defines the access control rules. This contains the actual policy logic used for agent behavior control and access decisions.

      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:

    • description

      GetPolicyResponse.Builder description(String description)

      The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.

      Parameters:
      description - The human-readable description of the policy's purpose and functionality. This helps administrators understand and manage the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • createdAt

      GetPolicyResponse.Builder createdAt(Instant createdAt)

      The timestamp when the policy was originally created.

      Parameters:
      createdAt - The timestamp when the policy was originally created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • updatedAt

      GetPolicyResponse.Builder updatedAt(Instant updatedAt)

      The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.

      Parameters:
      updatedAt - The timestamp when the policy was last modified. This tracks the most recent changes to the policy configuration.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • policyArn

      GetPolicyResponse.Builder policyArn(String policyArn)

      The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.

      Parameters:
      policyArn - The Amazon Resource Name (ARN) of the policy. This globally unique identifier can be used for cross-service references and IAM policy statements.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • status

      GetPolicyResponse.Builder status(String status)

      The current status of the policy.

      Parameters:
      status - The current status of the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      GetPolicyResponse.Builder status(PolicyStatus status)

      The current status of the policy.

      Parameters:
      status - The current status of the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • statusReasons

      GetPolicyResponse.Builder statusReasons(Collection<String> statusReasons)

      Additional information about the policy status. This provides details about any failures or the current state of the policy.

      Parameters:
      statusReasons - Additional information about the policy status. This provides details about any failures or the current state of the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • statusReasons

      GetPolicyResponse.Builder statusReasons(String... statusReasons)

      Additional information about the policy status. This provides details about any failures or the current state of the policy.

      Parameters:
      statusReasons - Additional information about the policy status. This provides details about any failures or the current state of the policy.
      Returns:
      Returns a reference to this object so that method calls can be chained together.