Header menu logo FsCDK

BedrockAgentBuilder Type

Constructors

Constructor Description

BedrockAgentBuilder(name)

Full Usage: BedrockAgentBuilder(name)

Parameters:
    name : string

Returns: BedrockAgentBuilder
name : string
Returns: BedrockAgentBuilder

Instance members

Instance member Description

agentResourceRoleArn roleArn

Full Usage: agentResourceRoleArn roleArn

Parameters:
    roleArn : string - The IAM role ARN.

Returns: BedrockAgentConfig

Sets the IAM role ARN for the agent.

roleArn : string

The IAM role ARN.

Returns: BedrockAgentConfig

autoPrepare value

Full Usage: autoPrepare value

Parameters:
    value : bool - True to auto-prepare.

Returns: BedrockAgentConfig

Sets whether the agent should be auto-prepared after creation (default: true).

value : bool

True to auto-prepare.

Returns: BedrockAgentConfig

this.Combine

Full Usage: this.Combine

Parameters:
Returns: BedrockAgentConfig
state1 : BedrockAgentConfig
state2 : BedrockAgentConfig
Returns: BedrockAgentConfig

constructId id

Full Usage: constructId id

Parameters:
    id : string - The construct ID.

Returns: BedrockAgentConfig

Sets the construct ID for the Bedrock agent.

id : string

The construct ID.

Returns: BedrockAgentConfig

customerEncryptionKeyArn keyArn

Full Usage: customerEncryptionKeyArn keyArn

Parameters:
    keyArn : string - The KMS key ARN.

Returns: BedrockAgentConfig

Sets the KMS key ARN for customer-managed encryption.

keyArn : string

The KMS key ARN.

Returns: BedrockAgentConfig

this.Delay

Full Usage: this.Delay

Parameters:
Returns: BedrockAgentConfig
Modifiers: inline
f : unit -> BedrockAgentConfig
Returns: BedrockAgentConfig

description description

Full Usage: description description

Parameters:
    description : string - The agent description.

Returns: BedrockAgentConfig

Sets the description for the agent.

description : string

The agent description.

Returns: BedrockAgentConfig

this.For

Full Usage: this.For

Parameters:
Returns: BedrockAgentConfig
Modifiers: inline
config : BedrockAgentConfig
f : unit -> BedrockAgentConfig
Returns: BedrockAgentConfig

foundationModel model

Full Usage: foundationModel model

Parameters:
    model : string - The foundation model identifier string.

Returns: BedrockAgentConfig

Sets the foundation model for the agent (e.g., "anthropic.claude-3-sonnet-20240229-v1:0").

model : string

The foundation model identifier string.

Returns: BedrockAgentConfig

foundationModelId model

Full Usage: foundationModelId model

Parameters:
Returns: BedrockAgentConfig

Sets the foundation model using a FoundationModelIdentifier.

model : FoundationModelIdentifier

The foundation model identifier.

Returns: BedrockAgentConfig

idleSessionTtlInSeconds seconds

Full Usage: idleSessionTtlInSeconds seconds

Parameters:
    seconds : int - Idle session timeout in seconds.

Returns: BedrockAgentConfig

Sets the idle session TTL in seconds.

seconds : int

Idle session timeout in seconds.

Returns: BedrockAgentConfig

instruction instruction

Full Usage: instruction instruction

Parameters:
    instruction : string - The instruction text.

Returns: BedrockAgentConfig

Sets the instruction/system prompt for the agent.

instruction : string

The instruction text.

Returns: BedrockAgentConfig

this.Run

Full Usage: this.Run

Parameters:
Returns: BedrockAgentSpec
config : BedrockAgentConfig
Returns: BedrockAgentSpec

skipResourceInUseCheckOnDelete value

Full Usage: skipResourceInUseCheckOnDelete value

Parameters:
    value : bool - True to skip the check.

Returns: BedrockAgentConfig

Sets whether to skip the resource-in-use check on delete.

value : bool

True to skip the check.

Returns: BedrockAgentConfig

tags tags

Full Usage: tags tags

Parameters:
    tags : (string * string) list - List of key-value tag pairs.

Returns: BedrockAgentConfig

Adds tags to the agent.

tags : (string * string) list

List of key-value tag pairs.

Returns: BedrockAgentConfig

this.Yield

Full Usage: this.Yield

Parameters:
    () : unit

Returns: BedrockAgentConfig
() : unit
Returns: BedrockAgentConfig

this.Zero

Full Usage: this.Zero

Returns: BedrockAgentConfig
Returns: BedrockAgentConfig

Type something to start searching.