Class CfnAgentPropsMixin
Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.
Implements
Inherited Members
Namespace: Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnAgentPropsMixin : Mixin, IMixinSyntax (vb)
Public Class CfnAgentPropsMixin Inherits Mixin Implements IMixinRemarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Mixins.Preview.Mixins;
using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;
var additionalModelRequestFields;
var cfnAgentPropsMixin = new CfnAgentPropsMixin(new CfnAgentMixinProps {
ActionGroups = new [] { new AgentActionGroupProperty {
ActionGroupExecutor = new ActionGroupExecutorProperty {
CustomControl = "customControl",
Lambda = "lambda"
},
ActionGroupName = "actionGroupName",
ActionGroupState = "actionGroupState",
ApiSchema = new APISchemaProperty {
Payload = "payload",
S3 = new S3IdentifierProperty {
S3BucketName = "s3BucketName",
S3ObjectKey = "s3ObjectKey"
}
},
Description = "description",
FunctionSchema = new FunctionSchemaProperty {
Functions = new [] { new FunctionProperty {
Description = "description",
Name = "name",
Parameters = new Dictionary<string, object> {
{ "parametersKey", new ParameterDetailProperty {
Description = "description",
Required = false,
Type = "type"
} }
},
RequireConfirmation = "requireConfirmation"
} }
},
ParentActionGroupSignature = "parentActionGroupSignature",
SkipResourceInUseCheckOnDelete = false
} },
AgentCollaboration = "agentCollaboration",
AgentCollaborators = new [] { new AgentCollaboratorProperty {
AgentDescriptor = new AgentDescriptorProperty {
AliasArn = "aliasArn"
},
CollaborationInstruction = "collaborationInstruction",
CollaboratorName = "collaboratorName",
RelayConversationHistory = "relayConversationHistory"
} },
AgentName = "agentName",
AgentResourceRoleArn = "agentResourceRoleArn",
AutoPrepare = false,
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
CustomOrchestration = new CustomOrchestrationProperty {
Executor = new OrchestrationExecutorProperty {
Lambda = "lambda"
}
},
Description = "description",
FoundationModel = "foundationModel",
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
},
IdleSessionTtlInSeconds = 123,
Instruction = "instruction",
KnowledgeBases = new [] { new AgentKnowledgeBaseProperty {
Description = "description",
KnowledgeBaseId = "knowledgeBaseId",
KnowledgeBaseState = "knowledgeBaseState"
} },
MemoryConfiguration = new MemoryConfigurationProperty {
EnabledMemoryTypes = new [] { "enabledMemoryTypes" },
SessionSummaryConfiguration = new SessionSummaryConfigurationProperty {
MaxRecentSessions = 123
},
StorageDays = 123
},
OrchestrationType = "orchestrationType",
PromptOverrideConfiguration = new PromptOverrideConfigurationProperty {
OverrideLambda = "overrideLambda",
PromptConfigurations = new [] { new PromptConfigurationProperty {
AdditionalModelRequestFields = additionalModelRequestFields,
BasePromptTemplate = "basePromptTemplate",
FoundationModel = "foundationModel",
InferenceConfiguration = new InferenceConfigurationProperty {
MaximumLength = 123,
StopSequences = new [] { "stopSequences" },
Temperature = 123,
TopK = 123,
TopP = 123
},
ParserMode = "parserMode",
PromptCreationMode = "promptCreationMode",
PromptState = "promptState",
PromptType = "promptType"
} }
},
SkipResourceInUseCheckOnDelete = false,
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TestAliasTags = new Dictionary<string, string> {
{ "testAliasTagsKey", "testAliasTags" }
}
}, new CfnPropertyMixinOptions {
Strategy = PropertyMergeStrategy.OVERRIDE
});Synopsis
Constructors
| CfnAgentPropsMixin(ICfnAgentMixinProps, ICfnPropertyMixinOptions?) | Create a mixin to apply properties to |
Properties
| CFN_PROPERTY_KEYS | Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:. |
| Props | Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:. |
| Strategy | Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:. |
Methods
| ApplyTo(IConstruct) | Apply the mixin properties to the construct. |
| Supports(IConstruct) | Check if this mixin supports the given construct. |
Constructors
CfnAgentPropsMixin(ICfnAgentMixinProps, ICfnPropertyMixinOptions?)
Create a mixin to apply properties to AWS::Bedrock::Agent.
public CfnAgentPropsMixin(ICfnAgentMixinProps props, ICfnPropertyMixinOptions? options = null)Parameters
- props ICfnAgentMixinProps
L1 properties to apply.
- options ICfnPropertyMixinOptions
Mixin options.
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Properties
CFN_PROPERTY_KEYS
Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.
protected static string[] CFN_PROPERTY_KEYS { get; }Property Value
string[]
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Mixins.Preview.Mixins;
using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;
var additionalModelRequestFields;
var cfnAgentPropsMixin = new CfnAgentPropsMixin(new CfnAgentMixinProps {
ActionGroups = new [] { new AgentActionGroupProperty {
ActionGroupExecutor = new ActionGroupExecutorProperty {
CustomControl = "customControl",
Lambda = "lambda"
},
ActionGroupName = "actionGroupName",
ActionGroupState = "actionGroupState",
ApiSchema = new APISchemaProperty {
Payload = "payload",
S3 = new S3IdentifierProperty {
S3BucketName = "s3BucketName",
S3ObjectKey = "s3ObjectKey"
}
},
Description = "description",
FunctionSchema = new FunctionSchemaProperty {
Functions = new [] { new FunctionProperty {
Description = "description",
Name = "name",
Parameters = new Dictionary<string, object> {
{ "parametersKey", new ParameterDetailProperty {
Description = "description",
Required = false,
Type = "type"
} }
},
RequireConfirmation = "requireConfirmation"
} }
},
ParentActionGroupSignature = "parentActionGroupSignature",
SkipResourceInUseCheckOnDelete = false
} },
AgentCollaboration = "agentCollaboration",
AgentCollaborators = new [] { new AgentCollaboratorProperty {
AgentDescriptor = new AgentDescriptorProperty {
AliasArn = "aliasArn"
},
CollaborationInstruction = "collaborationInstruction",
CollaboratorName = "collaboratorName",
RelayConversationHistory = "relayConversationHistory"
} },
AgentName = "agentName",
AgentResourceRoleArn = "agentResourceRoleArn",
AutoPrepare = false,
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
CustomOrchestration = new CustomOrchestrationProperty {
Executor = new OrchestrationExecutorProperty {
Lambda = "lambda"
}
},
Description = "description",
FoundationModel = "foundationModel",
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
},
IdleSessionTtlInSeconds = 123,
Instruction = "instruction",
KnowledgeBases = new [] { new AgentKnowledgeBaseProperty {
Description = "description",
KnowledgeBaseId = "knowledgeBaseId",
KnowledgeBaseState = "knowledgeBaseState"
} },
MemoryConfiguration = new MemoryConfigurationProperty {
EnabledMemoryTypes = new [] { "enabledMemoryTypes" },
SessionSummaryConfiguration = new SessionSummaryConfigurationProperty {
MaxRecentSessions = 123
},
StorageDays = 123
},
OrchestrationType = "orchestrationType",
PromptOverrideConfiguration = new PromptOverrideConfigurationProperty {
OverrideLambda = "overrideLambda",
PromptConfigurations = new [] { new PromptConfigurationProperty {
AdditionalModelRequestFields = additionalModelRequestFields,
BasePromptTemplate = "basePromptTemplate",
FoundationModel = "foundationModel",
InferenceConfiguration = new InferenceConfigurationProperty {
MaximumLength = 123,
StopSequences = new [] { "stopSequences" },
Temperature = 123,
TopK = 123,
TopP = 123
},
ParserMode = "parserMode",
PromptCreationMode = "promptCreationMode",
PromptState = "promptState",
PromptType = "promptType"
} }
},
SkipResourceInUseCheckOnDelete = false,
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TestAliasTags = new Dictionary<string, string> {
{ "testAliasTagsKey", "testAliasTags" }
}
}, new CfnPropertyMixinOptions {
Strategy = PropertyMergeStrategy.OVERRIDE
});Props
Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.
protected virtual ICfnAgentMixinProps Props { get; }Property Value
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Mixins.Preview.Mixins;
using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;
var additionalModelRequestFields;
var cfnAgentPropsMixin = new CfnAgentPropsMixin(new CfnAgentMixinProps {
ActionGroups = new [] { new AgentActionGroupProperty {
ActionGroupExecutor = new ActionGroupExecutorProperty {
CustomControl = "customControl",
Lambda = "lambda"
},
ActionGroupName = "actionGroupName",
ActionGroupState = "actionGroupState",
ApiSchema = new APISchemaProperty {
Payload = "payload",
S3 = new S3IdentifierProperty {
S3BucketName = "s3BucketName",
S3ObjectKey = "s3ObjectKey"
}
},
Description = "description",
FunctionSchema = new FunctionSchemaProperty {
Functions = new [] { new FunctionProperty {
Description = "description",
Name = "name",
Parameters = new Dictionary<string, object> {
{ "parametersKey", new ParameterDetailProperty {
Description = "description",
Required = false,
Type = "type"
} }
},
RequireConfirmation = "requireConfirmation"
} }
},
ParentActionGroupSignature = "parentActionGroupSignature",
SkipResourceInUseCheckOnDelete = false
} },
AgentCollaboration = "agentCollaboration",
AgentCollaborators = new [] { new AgentCollaboratorProperty {
AgentDescriptor = new AgentDescriptorProperty {
AliasArn = "aliasArn"
},
CollaborationInstruction = "collaborationInstruction",
CollaboratorName = "collaboratorName",
RelayConversationHistory = "relayConversationHistory"
} },
AgentName = "agentName",
AgentResourceRoleArn = "agentResourceRoleArn",
AutoPrepare = false,
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
CustomOrchestration = new CustomOrchestrationProperty {
Executor = new OrchestrationExecutorProperty {
Lambda = "lambda"
}
},
Description = "description",
FoundationModel = "foundationModel",
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
},
IdleSessionTtlInSeconds = 123,
Instruction = "instruction",
KnowledgeBases = new [] { new AgentKnowledgeBaseProperty {
Description = "description",
KnowledgeBaseId = "knowledgeBaseId",
KnowledgeBaseState = "knowledgeBaseState"
} },
MemoryConfiguration = new MemoryConfigurationProperty {
EnabledMemoryTypes = new [] { "enabledMemoryTypes" },
SessionSummaryConfiguration = new SessionSummaryConfigurationProperty {
MaxRecentSessions = 123
},
StorageDays = 123
},
OrchestrationType = "orchestrationType",
PromptOverrideConfiguration = new PromptOverrideConfigurationProperty {
OverrideLambda = "overrideLambda",
PromptConfigurations = new [] { new PromptConfigurationProperty {
AdditionalModelRequestFields = additionalModelRequestFields,
BasePromptTemplate = "basePromptTemplate",
FoundationModel = "foundationModel",
InferenceConfiguration = new InferenceConfigurationProperty {
MaximumLength = 123,
StopSequences = new [] { "stopSequences" },
Temperature = 123,
TopK = 123,
TopP = 123
},
ParserMode = "parserMode",
PromptCreationMode = "promptCreationMode",
PromptState = "promptState",
PromptType = "promptType"
} }
},
SkipResourceInUseCheckOnDelete = false,
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TestAliasTags = new Dictionary<string, string> {
{ "testAliasTagsKey", "testAliasTags" }
}
}, new CfnPropertyMixinOptions {
Strategy = PropertyMergeStrategy.OVERRIDE
});Strategy
Specifies an agent as a resource in a top-level template. Minimally, you must specify the following properties:.
protected virtual PropertyMergeStrategy Strategy { get; }Property Value
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.Mixins.Preview.Mixins;
using Amazon.CDK.Mixins.Preview.AWS.Bedrock.Mixins;
var additionalModelRequestFields;
var cfnAgentPropsMixin = new CfnAgentPropsMixin(new CfnAgentMixinProps {
ActionGroups = new [] { new AgentActionGroupProperty {
ActionGroupExecutor = new ActionGroupExecutorProperty {
CustomControl = "customControl",
Lambda = "lambda"
},
ActionGroupName = "actionGroupName",
ActionGroupState = "actionGroupState",
ApiSchema = new APISchemaProperty {
Payload = "payload",
S3 = new S3IdentifierProperty {
S3BucketName = "s3BucketName",
S3ObjectKey = "s3ObjectKey"
}
},
Description = "description",
FunctionSchema = new FunctionSchemaProperty {
Functions = new [] { new FunctionProperty {
Description = "description",
Name = "name",
Parameters = new Dictionary<string, object> {
{ "parametersKey", new ParameterDetailProperty {
Description = "description",
Required = false,
Type = "type"
} }
},
RequireConfirmation = "requireConfirmation"
} }
},
ParentActionGroupSignature = "parentActionGroupSignature",
SkipResourceInUseCheckOnDelete = false
} },
AgentCollaboration = "agentCollaboration",
AgentCollaborators = new [] { new AgentCollaboratorProperty {
AgentDescriptor = new AgentDescriptorProperty {
AliasArn = "aliasArn"
},
CollaborationInstruction = "collaborationInstruction",
CollaboratorName = "collaboratorName",
RelayConversationHistory = "relayConversationHistory"
} },
AgentName = "agentName",
AgentResourceRoleArn = "agentResourceRoleArn",
AutoPrepare = false,
CustomerEncryptionKeyArn = "customerEncryptionKeyArn",
CustomOrchestration = new CustomOrchestrationProperty {
Executor = new OrchestrationExecutorProperty {
Lambda = "lambda"
}
},
Description = "description",
FoundationModel = "foundationModel",
GuardrailConfiguration = new GuardrailConfigurationProperty {
GuardrailIdentifier = "guardrailIdentifier",
GuardrailVersion = "guardrailVersion"
},
IdleSessionTtlInSeconds = 123,
Instruction = "instruction",
KnowledgeBases = new [] { new AgentKnowledgeBaseProperty {
Description = "description",
KnowledgeBaseId = "knowledgeBaseId",
KnowledgeBaseState = "knowledgeBaseState"
} },
MemoryConfiguration = new MemoryConfigurationProperty {
EnabledMemoryTypes = new [] { "enabledMemoryTypes" },
SessionSummaryConfiguration = new SessionSummaryConfigurationProperty {
MaxRecentSessions = 123
},
StorageDays = 123
},
OrchestrationType = "orchestrationType",
PromptOverrideConfiguration = new PromptOverrideConfigurationProperty {
OverrideLambda = "overrideLambda",
PromptConfigurations = new [] { new PromptConfigurationProperty {
AdditionalModelRequestFields = additionalModelRequestFields,
BasePromptTemplate = "basePromptTemplate",
FoundationModel = "foundationModel",
InferenceConfiguration = new InferenceConfigurationProperty {
MaximumLength = 123,
StopSequences = new [] { "stopSequences" },
Temperature = 123,
TopK = 123,
TopP = 123
},
ParserMode = "parserMode",
PromptCreationMode = "promptCreationMode",
PromptState = "promptState",
PromptType = "promptType"
} }
},
SkipResourceInUseCheckOnDelete = false,
Tags = new Dictionary<string, string> {
{ "tagsKey", "tags" }
},
TestAliasTags = new Dictionary<string, string> {
{ "testAliasTagsKey", "testAliasTags" }
}
}, new CfnPropertyMixinOptions {
Strategy = PropertyMergeStrategy.OVERRIDE
});Methods
ApplyTo(IConstruct)
Apply the mixin properties to the construct.
public override IConstruct ApplyTo(IConstruct construct)Parameters
- construct IConstruct
Returns
IConstruct
Overrides
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated
Supports(IConstruct)
Check if this mixin supports the given construct.
public override bool Supports(IConstruct construct)Parameters
- construct IConstruct
Returns
Overrides
Remarks
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.
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrock-agent.html
CloudformationResource: AWS::Bedrock::Agent
Mixin: true
ExampleMetadata: fixture=_generated