Package software.amazon.awscdk.services.bedrock.alpha

Class Agent

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrock.alpha.AgentBase
software.amazon.awscdk.services.bedrock.alpha.Agent
All Implemented Interfaces:
IEnvironmentAware, IResource, IAgent, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.120.0 (build 192dc88)", date="2025-12-05T22:26:49.415Z") @Stability(Experimental) public class Agent extends AgentBase implements IAgent
(experimental) Class to create (or import) an Agent with CDK.

Example: 

 Function parserFunction = Function.Builder.create(this, "ParserFunction")
         .runtime(Runtime.PYTHON_3_10)
         .handler("index.handler")
         .code(Code.fromAsset("lambda"))
         .build();
 Agent agent = Agent.Builder.create(this, "Agent")
         .foundationModel(BedrockFoundationModel.AMAZON_NOVA_LITE_V1)
         .instruction("You are a helpful assistant.")
         .promptOverrideConfiguration(PromptOverrideConfiguration.withCustomParser(CustomParserProps.builder()
                 .parser(parserFunction)
                 .preProcessingStep(PromptPreProcessingConfigCustomParser.builder()
                         .stepType(AgentStepType.PRE_PROCESSING)
                         .useCustomParser(true)
                         .build())
                 .build()))
         .build();

  • Field Details

    • PROPERTY_INJECTION_ID

      @Stability(Experimental) public static final String PROPERTY_INJECTION_ID
      (experimental) Uniquely identifies this class.

  • Constructor Details

    • Agent

      protected Agent(software.amazon.jsii.JsiiObjectRef objRef)

    • Agent

      protected Agent(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • Agent

      @Stability(Experimental) public Agent(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull AgentProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props - This parameter is required.

  • Method Details

    • fromAgentAttributes

      @Stability(Experimental) @NotNull public static IAgent fromAgentAttributes(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull AgentAttributes attrs)
      (experimental) Creates an Agent reference from an existing agent's attributes.

      Default: - For attrs.agentVersion: 'DRAFT' if no explicit version is provided

      Parameters:
      scope -
      • The construct scope.
      This parameter is required.
      id -
      • Identifier of the construct.
      This parameter is required.
      attrs -
      • Attributes of the existing agent.
      This parameter is required.
      Returns:
      An IAgent reference to the existing agent

    • addActionGroup

      @Stability(Experimental) public void addActionGroup(@NotNull AgentActionGroup actionGroup)
      (experimental) Adds an action group to the agent and configures necessary permissions.

      Default: - Default permissions: - Lambda function invoke permissions if executor is present - S3 GetObject permissions if apiSchema.s3File is present

      Parameters:
      actionGroup -
      • The action group to add.
      This parameter is required.

    • addActionGroups

      @Stability(Experimental) public void addActionGroups(@NotNull AgentActionGroup... actionGroups)
      (experimental) Configuration for agent collaboration.

      Default: - No collaboration configuration.

      Parameters:
      actionGroups - This parameter is required.

    • addGuardrail

      @Stability(Experimental) public void addGuardrail(@NotNull IGuardrail guardrail)
      (experimental) Add guardrail to the agent.

      Parameters:
      guardrail - This parameter is required.

    • generatePhysicalName

      @Stability(Experimental) @NotNull protected String generatePhysicalName()
      (experimental) Generates a physical name for the agent.

      Default: - Generated name format: 'agent-{hash}-{uniqueName}' with: - maxLength: MAXLENGTH_FOR_ROLE_NAME - '-bedrockagent'.length - lower: true - separator: '-'

      Overrides:
      generatePhysicalName in class Resource
      Returns:
      A unique name for the agent with appropriate length constraints

    • getActionGroups

      @Stability(Experimental) @NotNull public List<AgentActionGroup> getActionGroups()
      (experimental) action groups associated with the ageny.

    • getAgentArn

      @Stability(Experimental) @NotNull public String getAgentArn()
      (experimental) The ARN of the agent.
      Specified by:
      getAgentArn in interface IAgent
      Specified by:
      getAgentArn in class AgentBase

    • getAgentId

      @Stability(Experimental) @NotNull public String getAgentId()
      (experimental) The unique identifier for the agent.
      Specified by:
      getAgentId in interface IAgent
      Specified by:
      getAgentId in class AgentBase

    • getAgentVersion

      @Stability(Experimental) @NotNull public String getAgentVersion()
      (experimental) The version of the agent.
      Specified by:
      getAgentVersion in class AgentBase

    • getGrantPrincipal

      @Stability(Experimental) @NotNull public IPrincipal getGrantPrincipal()
      (experimental) The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable
      Specified by:
      getGrantPrincipal in class AgentBase

    • getName

      @Stability(Experimental) @NotNull public String getName()
      (experimental) The name of the agent.

    • getRole

      @Stability(Experimental) @NotNull public IRole getRole()
      (experimental) The IAM role associated to the agent.
      Specified by:
      getRole in interface IAgent
      Specified by:
      getRole in class AgentBase

    • getTestAlias

      @Stability(Experimental) @NotNull public IAgentAlias getTestAlias()
      (experimental) Default alias of the agent.

    • getKmsKey

      @Stability(Experimental) @Nullable public IKey getKmsKey()
      (experimental) Optional KMS encryption key associated with this agent.
      Specified by:
      getKmsKey in interface IAgent
      Specified by:
      getKmsKey in class AgentBase

    • getLastUpdated

      @Stability(Experimental) @Nullable public String getLastUpdated()
      (experimental) When this agent was last updated.
      Specified by:
      getLastUpdated in interface IAgent
      Specified by:
      getLastUpdated in class AgentBase

    • getGuardrail

      @Stability(Experimental) @Nullable public IGuardrail getGuardrail()
      (experimental) The guardrail that will be associated with the agent.

    • setGuardrail

      @Stability(Experimental) public void setGuardrail(@Nullable IGuardrail value)
      (experimental) The guardrail that will be associated with the agent.