Package software.amazon.awscdk.cfnpropertymixins.services.bedrock

Class CfnAgentPropsMixin

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.Mixin
software.amazon.awscdk.cfnpropertymixins.services.bedrock.CfnAgentPropsMixin
All Implemented Interfaces:
software.amazon.jsii.JsiiSerializable, software.constructs.IMixin
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-11T13:19:56.423Z") @Stability(Stable) public class CfnAgentPropsMixin extends Mixin implements software.constructs.IMixin
Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.

For more information about using agents in Amazon Bedrock , see Agents for Amazon Bedrock .

See the Properties section below for descriptions of both the required and optional properties.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.cfnpropertymixins.services.bedrock.*;
 import software.amazon.awscdk.*;
 Object additionalModelRequestFields;
 IMergeStrategy mergeStrategy;
 CfnAgentPropsMixin cfnAgentPropsMixin = CfnAgentPropsMixin.Builder.create(CfnAgentMixinProps.builder()
         .actionGroups(List.of(AgentActionGroupProperty.builder()
                 .actionGroupExecutor(ActionGroupExecutorProperty.builder()
                         .customControl("customControl")
                         .lambda("lambda")
                         .build())
                 .actionGroupName("actionGroupName")
                 .actionGroupState("actionGroupState")
                 .apiSchema(APISchemaProperty.builder()
                         .payload("payload")
                         .s3(S3IdentifierProperty.builder()
                                 .s3BucketName("s3BucketName")
                                 .s3ObjectKey("s3ObjectKey")
                                 .build())
                         .build())
                 .description("description")
                 .functionSchema(FunctionSchemaProperty.builder()
                         .functions(List.of(FunctionProperty.builder()
                                 .description("description")
                                 .name("name")
                                 .parameters(Map.of(
                                         "parametersKey", ParameterDetailProperty.builder()
                                                 .description("description")
                                                 .required(false)
                                                 .type("type")
                                                 .build()))
                                 .requireConfirmation("requireConfirmation")
                                 .build()))
                         .build())
                 .parentActionGroupSignature("parentActionGroupSignature")
                 .skipResourceInUseCheckOnDelete(false)
                 .build()))
         .agentCollaboration("agentCollaboration")
         .agentCollaborators(List.of(AgentCollaboratorProperty.builder()
                 .agentDescriptor(AgentDescriptorProperty.builder()
                         .aliasArn("aliasArn")
                         .build())
                 .collaborationInstruction("collaborationInstruction")
                 .collaboratorName("collaboratorName")
                 .relayConversationHistory("relayConversationHistory")
                 .build()))
         .agentName("agentName")
         .agentResourceRoleArn("agentResourceRoleArn")
         .autoPrepare(false)
         .customerEncryptionKeyArn("customerEncryptionKeyArn")
         .customOrchestration(CustomOrchestrationProperty.builder()
                 .executor(OrchestrationExecutorProperty.builder()
                         .lambda("lambda")
                         .build())
                 .build())
         .description("description")
         .foundationModel("foundationModel")
         .guardrailConfiguration(GuardrailConfigurationProperty.builder()
                 .guardrailIdentifier("guardrailIdentifier")
                 .guardrailVersion("guardrailVersion")
                 .build())
         .idleSessionTtlInSeconds(123)
         .instruction("instruction")
         .knowledgeBases(List.of(AgentKnowledgeBaseProperty.builder()
                 .description("description")
                 .knowledgeBaseId("knowledgeBaseId")
                 .knowledgeBaseState("knowledgeBaseState")
                 .build()))
         .memoryConfiguration(MemoryConfigurationProperty.builder()
                 .enabledMemoryTypes(List.of("enabledMemoryTypes"))
                 .sessionSummaryConfiguration(SessionSummaryConfigurationProperty.builder()
                         .maxRecentSessions(123)
                         .build())
                 .storageDays(123)
                 .build())
         .orchestrationType("orchestrationType")
         .promptOverrideConfiguration(PromptOverrideConfigurationProperty.builder()
                 .overrideLambda("overrideLambda")
                 .promptConfigurations(List.of(PromptConfigurationProperty.builder()
                         .additionalModelRequestFields(additionalModelRequestFields)
                         .basePromptTemplate("basePromptTemplate")
                         .foundationModel("foundationModel")
                         .inferenceConfiguration(InferenceConfigurationProperty.builder()
                                 .maximumLength(123)
                                 .stopSequences(List.of("stopSequences"))
                                 .temperature(123)
                                 .topK(123)
                                 .topP(123)
                                 .build())
                         .parserMode("parserMode")
                         .promptCreationMode("promptCreationMode")
                         .promptState("promptState")
                         .promptType("promptType")
                         .build()))
                 .build())
         .skipResourceInUseCheckOnDelete(false)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .testAliasTags(Map.of(
                 "testAliasTagsKey", "testAliasTags"))
         .build())
 .strategy(mergeStrategy)
 .build();

See Also:

  • Field Details

    • CFN_PROPERTY_KEYS

      @Stability(Stable) protected static final List<String> CFN_PROPERTY_KEYS

  • Constructor Details

    • CfnAgentPropsMixin

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

    • CfnAgentPropsMixin

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

    • CfnAgentPropsMixin

      @Stability(Stable) public CfnAgentPropsMixin(@NotNull CfnAgentMixinProps props, @Nullable CfnPropertyMixinOptions options)
      Create a mixin to apply properties to AWS::Bedrock::Agent.

      Parameters:
      props - L1 properties to apply. This parameter is required.
      options - Mixin options.

    • CfnAgentPropsMixin

      @Stability(Stable) public CfnAgentPropsMixin(@NotNull CfnAgentMixinProps props)
      Create a mixin to apply properties to AWS::Bedrock::Agent.

      Parameters:
      props - L1 properties to apply. This parameter is required.

  • Method Details

    • applyTo

      @Stability(Stable) public void applyTo(@NotNull software.constructs.IConstruct construct)
      Apply the mixin properties to the construct.

      Specified by:
      applyTo in interface software.constructs.IMixin
      Specified by:
      applyTo in class Mixin
      Parameters:
      construct - This parameter is required.

    • supports

      @Stability(Stable) @NotNull public Boolean supports(@NotNull software.constructs.IConstruct construct)
      Check if this mixin supports the given construct.

      Specified by:
      supports in interface software.constructs.IMixin
      Overrides:
      supports in class Mixin
      Parameters:
      construct - This parameter is required.

    • getProps

      @Stability(Stable) @NotNull protected CfnAgentMixinProps getProps()

    • getStrategy

      @Stability(Stable) @NotNull protected IMergeStrategy getStrategy()