Package software.amazon.awscdk.services.bedrock

Interface CfnAgentProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAgentProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.99.0 (build 8f757e4)",
           date="2024-06-13T18:49:15.245Z")
@Stability(Stable)
public interface CfnAgentProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnAgent.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrock.*;
 CfnAgentProps cfnAgentProps = CfnAgentProps.builder()
         .agentName("agentName")
         // the properties below are optional
         .actionGroups(List.of(AgentActionGroupProperty.builder()
                 .actionGroupName("actionGroupName")
                 // the properties below are optional
                 .actionGroupExecutor(ActionGroupExecutorProperty.builder()
                         .customControl("customControl")
                         .lambda("lambda")
                         .build())
                 .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()
                                 .name("name")
                                 // the properties below are optional
                                 .description("description")
                                 .parameters(Map.of(
                                         "parametersKey", ParameterDetailProperty.builder()
                                                 .type("type")
                                                 // the properties below are optional
                                                 .description("description")
                                                 .required(false)
                                                 .build()))
                                 .build()))
                         .build())
                 .parentActionGroupSignature("parentActionGroupSignature")
                 .skipResourceInUseCheckOnDelete(false)
                 .build()))
         .agentResourceRoleArn("agentResourceRoleArn")
         .autoPrepare(false)
         .customerEncryptionKeyArn("customerEncryptionKeyArn")
         .description("description")
         .foundationModel("foundationModel")
         .idleSessionTtlInSeconds(123)
         .instruction("instruction")
         .knowledgeBases(List.of(AgentKnowledgeBaseProperty.builder()
                 .description("description")
                 .knowledgeBaseId("knowledgeBaseId")
                 // the properties below are optional
                 .knowledgeBaseState("knowledgeBaseState")
                 .build()))
         .promptOverrideConfiguration(PromptOverrideConfigurationProperty.builder()
                 .promptConfigurations(List.of(PromptConfigurationProperty.builder()
                         .basePromptTemplate("basePromptTemplate")
                         .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()))
                 // the properties below are optional
                 .overrideLambda("overrideLambda")
                 .build())
         .skipResourceInUseCheckOnDelete(false)
         .tags(Map.of(
                 "tagsKey", "tags"))
         .testAliasTags(Map.of(
                 "testAliasTagsKey", "testAliasTags"))
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnAgentProps.Builder	A builder for CfnAgentProps
static final class	CfnAgentProps.Jsii$Proxy	An implementation for CfnAgentProps

Method Summary

Modifier and Type	Method	Description
static CfnAgentProps.Builder	builder()
default Object	getActionGroups()	The action groups that belong to an agent.
String	getAgentName()	The name of the agent.
default String	getAgentResourceRoleArn()	The Amazon Resource Name (ARN) of the IAM role with permissions to invoke API operations on the agent.
default Object	getAutoPrepare()	Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.
default String	getCustomerEncryptionKeyArn()	The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.
default String	getDescription()	The description of the agent.
default String	getFoundationModel()	The foundation model used for orchestration by the agent.
default Number	getIdleSessionTtlInSeconds()	The number of seconds for which Amazon Bedrock keeps information about a user's conversation with the agent.
default String	getInstruction()	Instructions that tell the agent what it should do and how it should interact with users.
default Object	getKnowledgeBases()	The knowledge bases associated with the agent.
default Object	getPromptOverrideConfiguration()	Contains configurations to override prompt templates in different parts of an agent sequence.
default Object	getSkipResourceInUseCheckOnDelete()	Specifies whether to delete the resource even if it's in use.
default Map<String,String>	getTags()	Metadata that you can assign to a resource as key-value pairs.
default Object	getTestAliasTags()	Metadata that you can assign to a resource as key-value pairs.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAgentName

@Stability(Stable)
@NotNull
String getAgentName()

The name of the agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentname

getActionGroups

@Stability(Stable)
@Nullable
default Object getActionGroups()

The action groups that belong to an agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-actiongroups

getAgentResourceRoleArn

@Stability(Stable)
@Nullable
default String getAgentResourceRoleArn()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-agentresourcerolearn

getAutoPrepare

@Stability(Stable)
@Nullable
default Object getAutoPrepare()

Specifies whether to automatically update the DRAFT version of the agent after making changes to the agent.

The DRAFT version can be continually iterated upon during internal development. By default, this value is false .

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-autoprepare

getCustomerEncryptionKeyArn

@Stability(Stable)
@Nullable
default String getCustomerEncryptionKeyArn()

The Amazon Resource Name (ARN) of the AWS KMS key that encrypts the agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-customerencryptionkeyarn

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

The description of the agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-description

getFoundationModel

@Stability(Stable)
@Nullable
default String getFoundationModel()

The foundation model used for orchestration by the agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-foundationmodel

getIdleSessionTtlInSeconds

@Stability(Stable)
@Nullable
default Number getIdleSessionTtlInSeconds()

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-idlesessionttlinseconds

getInstruction

@Stability(Stable)
@Nullable
default String getInstruction()

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-instruction

getKnowledgeBases

@Stability(Stable)
@Nullable
default Object getKnowledgeBases()

The knowledge bases associated with the agent.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-knowledgebases

getPromptOverrideConfiguration

@Stability(Stable)
@Nullable
default Object getPromptOverrideConfiguration()

Contains configurations to override prompt templates in different parts of an agent sequence.

For more information, see Advanced prompts .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-promptoverrideconfiguration

getSkipResourceInUseCheckOnDelete

@Stability(Stable)
@Nullable
default Object getSkipResourceInUseCheckOnDelete()

Specifies whether to delete the resource even if it's in use.

By default, this value is false .

Default: - false

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-skipresourceinusecheckondelete

getTags

@Stability(Stable)
@Nullable
default Map<String,String> getTags()

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

• Tag naming limits and requirements
• Tagging best practices

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-tags

getTestAliasTags

@Stability(Stable)
@Nullable
default Object getTestAliasTags()

Metadata that you can assign to a resource as key-value pairs. For more information, see the following resources:.

• Tag naming limits and requirements
• Tagging best practices

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html#cfn-bedrock-agent-testaliastags

builder

@Stability(Stable)
static CfnAgentProps.Builder builder()

Returns:

a CfnAgentProps.Builder of CfnAgentProps