RuntimeProps

class aws_cdk.aws_bedrock_agentcore_alpha.RuntimeProps(*, agent_runtime_artifact, authorizer_configuration=None, description=None, environment_variables=None, execution_role=None, lifecycle_configuration=None, logging_configs=None, network_configuration=None, protocol_configuration=None, request_header_configuration=None, runtime_name=None, tags=None, tracing_enabled=None)

Bases: object

(experimental) Properties for creating a Bedrock Agent Core Runtime resource.

Parameters:

agent_runtime_artifact (AgentRuntimeArtifact) – (experimental) The artifact configuration for the agent runtime Contains the container configuration with ECR URI.
authorizer_configuration (Optional[RuntimeAuthorizerConfiguration]) – (experimental) Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration. Default: - RuntimeAuthorizerConfiguration.iam() (IAM authentication)
description (Optional[str]) – (experimental) Optional description for the agent runtime. Default: - No description Length Minimum: 1 , Maximum: 1200
environment_variables (Optional[Mapping[str, str]]) – (experimental) Environment variables for the agent runtime - Maximum 50 environment variables - Key: Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value: Must be 0-2048 characters (per CloudFormation specification). Default: - No environment variables
execution_role (Optional[IRole]) – (experimental) The IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically. Default: - A new role will be created
lifecycle_configuration (Union[LifecycleConfiguration, Dict[str, Any], None]) – (experimental) The life cycle configuration for the AgentCore Runtime. Default: - No lifecycle configuration
logging_configs (Optional[Sequence[Union[LoggingConfig, Dict[str, Any]]]]) – (experimental) Logging configuration for the runtime. Allows sending APPLICATION_LOGS and USAGE_LOGS to CloudWatch Logs, S3, or Kinesis Data Firehose. Default: - No logging configured
network_configuration (Optional[RuntimeNetworkConfiguration]) – (experimental) Network configuration for the agent runtime. Default: - RuntimeNetworkConfiguration.usingPublicNetwork()
protocol_configuration (Optional[ProtocolType]) – (experimental) Protocol configuration for the agent runtime. Default: - ProtocolType.HTTP
request_header_configuration (Union[RequestHeaderConfiguration, Dict[str, Any], None]) – (experimental) Configuration for HTTP request headers that will be passed through to the runtime. Default: - No request headers configured
runtime_name (Optional[str]) – (experimental) The name of the agent runtime Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern: ^[a-zA-Z][a-zA-Z0-9_]{0,47}$. Default: - auto generate
tags (Optional[Mapping[str, str]]) – (experimental) Tags for the agent runtime A list of key:value pairs of tags to apply to this Runtime resource. Default: {} - no tags
tracing_enabled (Optional[bool]) – (experimental) Whether to enable X-Ray tracing for this runtime. When enabled, traces will be delivered to AWS X-Ray. Default: false

Stability:

experimental

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_bedrock_agentcore_alpha as bedrock_agentcore_alpha
import aws_cdk as cdk
from aws_cdk import aws_iam as iam

# agent_runtime_artifact: bedrock_agentcore_alpha.AgentRuntimeArtifact
# logging_destination: bedrock_agentcore_alpha.LoggingDestination
# log_type: bedrock_agentcore_alpha.LogType
# role: iam.Role
# runtime_authorizer_configuration: bedrock_agentcore_alpha.RuntimeAuthorizerConfiguration
# runtime_network_configuration: bedrock_agentcore_alpha.RuntimeNetworkConfiguration

runtime_props = bedrock_agentcore_alpha.RuntimeProps(
    agent_runtime_artifact=agent_runtime_artifact,

    # the properties below are optional
    authorizer_configuration=runtime_authorizer_configuration,
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    execution_role=role,
    lifecycle_configuration=bedrock_agentcore_alpha.LifecycleConfiguration(
        idle_runtime_session_timeout=cdk.Duration.minutes(30),
        max_lifetime=cdk.Duration.minutes(30)
    ),
    logging_configs=[bedrock_agentcore_alpha.LoggingConfig(
        destination=logging_destination,
        log_type=log_type
    )],
    network_configuration=runtime_network_configuration,
    protocol_configuration=bedrock_agentcore_alpha.ProtocolType.MCP,
    request_header_configuration=bedrock_agentcore_alpha.RequestHeaderConfiguration(
        allowlisted_headers=["allowlistedHeaders"]
    ),
    runtime_name="runtimeName",
    tags={
        "tags_key": "tags"
    },
    tracing_enabled=False
)

Attributes

agent_runtime_artifact

(experimental) The artifact configuration for the agent runtime Contains the container configuration with ECR URI.

Stability:: experimental

authorizer_configuration

(experimental) Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.

Default:

RuntimeAuthorizerConfiguration.iam() (IAM authentication)

Stability:

experimental

description

(experimental) Optional description for the agent runtime.

Default:

No description

Length Minimum: 1 , Maximum: 1200

Stability:: experimental

environment_variables

Must be 0-2048 characters (per CloudFormation specification).

Default:

No environment variables

Stability:

experimental

Type:

(experimental) Environment variables for the agent runtime - Maximum 50 environment variables - Key

Type:

Must be 1-100 characters, start with letter or underscore, contain only letters, numbers, and underscores - Value

execution_role

(experimental) The IAM role that provides permissions for the agent runtime If not provided, a role will be created automatically.

Default:

A new role will be created

Stability:

experimental

lifecycle_configuration

(experimental) The life cycle configuration for the AgentCore Runtime.

Default:

No lifecycle configuration

Stability:

experimental

logging_configs

(experimental) Logging configuration for the runtime.

Allows sending APPLICATION_LOGS and USAGE_LOGS to CloudWatch Logs, S3, or Kinesis Data Firehose.

Default:

No logging configured

See:

https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/observability.html

Stability:

experimental

network_configuration

(experimental) Network configuration for the agent runtime.

Default:

RuntimeNetworkConfiguration.usingPublicNetwork()

Stability:

experimental

protocol_configuration

(experimental) Protocol configuration for the agent runtime.

Default:

ProtocolType.HTTP

Stability:

experimental

request_header_configuration

(experimental) Configuration for HTTP request headers that will be passed through to the runtime.

Default:

No request headers configured

Stability:

experimental

runtime_name

^[a-zA-Z][a-zA-Z0-9_]{0,47}$.

Default:

auto generate

Stability:

experimental

Type:

(experimental) The name of the agent runtime Valid characters are a-z, A-Z, 0-9, _ (underscore) Must start with a letter and can be up to 48 characters long Pattern

tags

value pairs of tags to apply to this Runtime resource.

Default:: {} - no tags
Stability:: experimental
Type:: (experimental) Tags for the agent runtime A list of key

tracing_enabled

(experimental) Whether to enable X-Ray tracing for this runtime.

When enabled, traces will be delivered to AWS X-Ray.

Default:: false
See:: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/observability.html
Stability:: experimental