Package software.amazon.awssdk.services.bedrockagent.model

Interface CreateAgentRequest.Builder

All Superinterfaces:
AwsRequest.Builder, BedrockAgentRequest.Builder, Buildable, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>, SdkBuilder<CreateAgentRequest.Builder,CreateAgentRequest>, SdkPojo, SdkRequest.Builder
Enclosing class:
CreateAgentRequest
public static interface CreateAgentRequest.Builder extends BedrockAgentRequest.Builder, SdkPojo, CopyableBuilder<CreateAgentRequest.Builder,CreateAgentRequest>

  • Method Details

    • agentName

      CreateAgentRequest.Builder agentName(String agentName)

      A name for the agent that you create.

      Parameters:
      agentName - A name for the agent that you create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • agentResourceRoleArn

      CreateAgentRequest.Builder agentResourceRoleArn(String agentResourceRoleArn)

      The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.

      Parameters:
      agentResourceRoleArn - The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • clientToken

      CreateAgentRequest.Builder clientToken(String clientToken)

      A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.

      Parameters:
      clientToken - A unique, case-sensitive identifier to ensure that the API request completes no more than one time. If this token matches a previous request, Amazon Bedrock ignores the request, but does not return an error. For more information, see Ensuring idempotency.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • customerEncryptionKeyArn

      CreateAgentRequest.Builder customerEncryptionKeyArn(String customerEncryptionKeyArn)

      The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.

      Parameters:
      customerEncryptionKeyArn - The Amazon Resource Name (ARN) of the KMS key with which to encrypt the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      CreateAgentRequest.Builder description(String description)

      A description of the agent.

      Parameters:
      description - A description of the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • foundationModel

      CreateAgentRequest.Builder foundationModel(String foundationModel)

      The foundation model to be used for orchestration by the agent you create.

      Parameters:
      foundationModel - The foundation model to be used for orchestration by the agent you create.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • guardrailConfiguration

      CreateAgentRequest.Builder guardrailConfiguration(GuardrailConfiguration guardrailConfiguration)

      The unique Guardrail configuration assigned to the agent when it is created.

      Parameters:
      guardrailConfiguration - The unique Guardrail configuration assigned to the agent when it is created.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • guardrailConfiguration

      default CreateAgentRequest.Builder guardrailConfiguration(Consumer<GuardrailConfiguration.Builder> guardrailConfiguration)

      The unique Guardrail configuration assigned to the agent when it is created.

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

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

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

    • idleSessionTTLInSeconds

      CreateAgentRequest.Builder idleSessionTTLInSeconds(Integer idleSessionTTLInSeconds)

      The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

      Parameters:
      idleSessionTTLInSeconds - The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.

      A user interaction remains active for the amount of time specified. If no conversation occurs during this time, the session expires and Amazon Bedrock deletes any data provided before the timeout.

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

    • instruction

      CreateAgentRequest.Builder instruction(String instruction)

      Instructions that tell the agent what it should do and how it should interact with users.

      Parameters:
      instruction - Instructions that tell the agent what it should do and how it should interact with users.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memoryConfiguration

      CreateAgentRequest.Builder memoryConfiguration(MemoryConfiguration memoryConfiguration)

      Contains the details of the memory configured for the agent.

      Parameters:
      memoryConfiguration - Contains the details of the memory configured for the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • memoryConfiguration

      default CreateAgentRequest.Builder memoryConfiguration(Consumer<MemoryConfiguration.Builder> memoryConfiguration)

      Contains the details of the memory configured for the agent.

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

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

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

    • promptOverrideConfiguration

      CreateAgentRequest.Builder promptOverrideConfiguration(PromptOverrideConfiguration promptOverrideConfiguration)

      Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

      Parameters:
      promptOverrideConfiguration - Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • promptOverrideConfiguration

      default CreateAgentRequest.Builder promptOverrideConfiguration(Consumer<PromptOverrideConfiguration.Builder> promptOverrideConfiguration)

      Contains configurations to override prompts in different parts of an agent sequence. For more information, see Advanced prompts.

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

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

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

    • tags

      CreateAgentRequest.Builder tags(Map<String,String> tags)

      Any tags that you want to attach to the agent.

      Parameters:
      tags - Any tags that you want to attach to the agent.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • overrideConfiguration

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

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