interface CfnRuntimeProps
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.BedrockAgentCore.CfnRuntimeProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#CfnRuntimeProps |
Java | software.amazon.awscdk.services.bedrockagentcore.CfnRuntimeProps |
Python | aws_cdk.aws_bedrockagentcore.CfnRuntimeProps |
TypeScript | aws-cdk-lib » aws_bedrockagentcore » CfnRuntimeProps |
Properties for defining a CfnRuntime.
Example
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_bedrockagentcore as bedrockagentcore } from 'aws-cdk-lib';
const cfnRuntimeProps: bedrockagentcore.CfnRuntimeProps = {
agentRuntimeArtifact: {
codeConfiguration: {
code: {
s3: {
bucket: 'bucket',
prefix: 'prefix',
// the properties below are optional
versionId: 'versionId',
},
},
entryPoint: ['entryPoint'],
runtime: 'runtime',
},
containerConfiguration: {
containerUri: 'containerUri',
},
},
agentRuntimeName: 'agentRuntimeName',
networkConfiguration: {
networkMode: 'networkMode',
// the properties below are optional
networkModeConfig: {
securityGroups: ['securityGroups'],
subnets: ['subnets'],
},
},
roleArn: 'roleArn',
// the properties below are optional
authorizerConfiguration: {
customJwtAuthorizer: {
discoveryUrl: 'discoveryUrl',
// the properties below are optional
allowedAudience: ['allowedAudience'],
allowedClients: ['allowedClients'],
},
},
description: 'description',
environmentVariables: {
environmentVariablesKey: 'environmentVariables',
},
lifecycleConfiguration: {
idleRuntimeSessionTimeout: 123,
maxLifetime: 123,
},
protocolConfiguration: 'protocolConfiguration',
requestHeaderConfiguration: {
requestHeaderAllowlist: ['requestHeaderAllowlist'],
},
tags: {
tagsKey: 'tags',
},
};
Properties
| Name | Type | Description |
|---|---|---|
| agent | IResolvable | Agent | The artifact of the agent. |
| agent | string | The name of the AgentCore Runtime endpoint. |
| network | IResolvable | Network | The network configuration. |
| role | string | The Amazon Resource Name (ARN) for for the role. |
| authorizer | IResolvable | Authorizer | Represents inbound authorization configuration options used to authenticate incoming requests. |
| description? | string | The agent runtime description. |
| environment | { [string]: string } | IResolvable | The environment variables for the agent. |
| lifecycle | IResolvable | Lifecycle | Configuration for managing the lifecycle of runtime sessions and resources. |
| protocol | string | The protocol configuration for an agent runtime. |
| request | IResolvable | Request | Configuration for HTTP request headers. |
| tags? | { [string]: string } | The tags for the agent. |
agentRuntimeArtifact
Type:
IResolvable | Agent
The artifact of the agent.
agentRuntimeName
Type:
string
The name of the AgentCore Runtime endpoint.
networkConfiguration
Type:
IResolvable | Network
The network configuration.
roleArn
Type:
string
The Amazon Resource Name (ARN) for for the role.
authorizerConfiguration?
Type:
IResolvable | Authorizer
(optional)
Represents inbound authorization configuration options used to authenticate incoming requests.
description?
Type:
string
(optional)
The agent runtime description.
environmentVariables?
Type:
{ [string]: string } | IResolvable
(optional)
The environment variables for the agent.
lifecycleConfiguration?
Type:
IResolvable | Lifecycle
(optional)
Configuration for managing the lifecycle of runtime sessions and resources.
protocolConfiguration?
Type:
string
(optional)
The protocol configuration for an agent runtime.
This structure defines how the agent runtime communicates with clients.
requestHeaderConfiguration?
Type:
IResolvable | Request
(optional)
Configuration for HTTP request headers.
tags?
Type:
{ [string]: string }
(optional)
The tags for the agent.

.NET
Go
Java
Python
TypeScript