CfnRuntimePropsMixin

class aws_cdk.mixins_preview.aws_bedrockagentcore.mixins.CfnRuntimePropsMixin(props, *, strategy=None)

Bases: Mixin

Contains information about an agent runtime. An agent runtime is the execution environment for a Amazon Bedrock Agent.

AgentCore Runtime is a secure, serverless runtime purpose-built for deploying and scaling dynamic AI agents and tools using any open-source framework including LangGraph, CrewAI, and Strands Agents, any protocol, and any model.

For more information about using agent runtime in Amazon Bedrock AgentCore, see Host agent or tools with Amazon Bedrock AgentCore Runtime .

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-bedrockagentcore-runtime.html
CloudformationResource:: AWS::BedrockAgentCore::Runtime
Mixin:: true
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview import mixins
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

cfn_runtime_props_mixin = bedrockagentcore_mixins.CfnRuntimePropsMixin(bedrockagentcore_mixins.CfnRuntimeMixinProps(
    agent_runtime_artifact=bedrockagentcore_mixins.CfnRuntimePropsMixin.AgentRuntimeArtifactProperty(
        code_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeConfigurationProperty(
            code=bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeProperty(
                s3=bedrockagentcore_mixins.CfnRuntimePropsMixin.S3LocationProperty(
                    bucket="bucket",
                    prefix="prefix",
                    version_id="versionId"
                )
            ),
            entry_point=["entryPoint"],
            runtime="runtime"
        ),
        container_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.ContainerConfigurationProperty(
            container_uri="containerUri"
        )
    ),
    agent_runtime_name="agentRuntimeName",
    authorizer_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.AuthorizerConfigurationProperty(
        custom_jwt_authorizer=bedrockagentcore_mixins.CfnRuntimePropsMixin.CustomJWTAuthorizerConfigurationProperty(
            allowed_audience=["allowedAudience"],
            allowed_clients=["allowedClients"],
            discovery_url="discoveryUrl"
        )
    ),
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    lifecycle_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.LifecycleConfigurationProperty(
        idle_runtime_session_timeout=123,
        max_lifetime=123
    ),
    network_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.NetworkConfigurationProperty(
        network_mode="networkMode",
        network_mode_config=bedrockagentcore_mixins.CfnRuntimePropsMixin.VpcConfigProperty(
            security_groups=["securityGroups"],
            subnets=["subnets"]
        )
    ),
    protocol_configuration="protocolConfiguration",
    request_header_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.RequestHeaderConfigurationProperty(
        request_header_allowlist=["requestHeaderAllowlist"]
    ),
    role_arn="roleArn",
    tags={
        "tags_key": "tags"
    }
),
    strategy=mixins.PropertyMergeStrategy.OVERRIDE
)

Create a mixin to apply properties to AWS::BedrockAgentCore::Runtime.

Parameters:

props (Union[CfnRuntimeMixinProps, Dict[str, Any]]) – L1 properties to apply.
strategy (Optional[PropertyMergeStrategy]) – (experimental) Strategy for merging nested properties. Default: - PropertyMergeStrategy.MERGE

Methods

apply_to(construct)

Apply the mixin properties to the construct.

Parameters:: construct (IConstruct)
Return type:: IConstruct

supports(construct)

Check if this mixin supports the given construct.

Parameters:: construct (IConstruct)
Return type:: bool

Attributes

CFN_PROPERTY_KEYS = ['agentRuntimeArtifact', 'agentRuntimeName', 'authorizerConfiguration', 'description', 'environmentVariables', 'lifecycleConfiguration', 'networkConfiguration', 'protocolConfiguration', 'requestHeaderConfiguration', 'roleArn', 'tags']

Static Methods

classmethod is_mixin(x)

(experimental) Checks if x is a Mixin.

Parameters:: x (Any) – Any object.
Return type:: bool
Returns:: true if x is an object created from a class which extends Mixin.
Stability:: experimental

AgentRuntimeArtifactProperty

class CfnRuntimePropsMixin.AgentRuntimeArtifactProperty(*, code_configuration=None, container_configuration=None)

Bases: object

The artifact of the agent.

Parameters:

code_configuration (Union[IResolvable, CodeConfigurationProperty, Dict[str, Any], None]) – Representation of a code configuration.
container_configuration (Union[IResolvable, ContainerConfigurationProperty, Dict[str, Any], None]) – Representation of a container configuration.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

agent_runtime_artifact_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.AgentRuntimeArtifactProperty(
    code_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeConfigurationProperty(
        code=bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeProperty(
            s3=bedrockagentcore_mixins.CfnRuntimePropsMixin.S3LocationProperty(
                bucket="bucket",
                prefix="prefix",
                version_id="versionId"
            )
        ),
        entry_point=["entryPoint"],
        runtime="runtime"
    ),
    container_configuration=bedrockagentcore_mixins.CfnRuntimePropsMixin.ContainerConfigurationProperty(
        container_uri="containerUri"
    )
)

Attributes

code_configuration

Representation of a code configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-codeconfiguration

container_configuration

Representation of a container configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-agentruntimeartifact.html#cfn-bedrockagentcore-runtime-agentruntimeartifact-containerconfiguration

AuthorizerConfigurationProperty

class CfnRuntimePropsMixin.AuthorizerConfigurationProperty(*, custom_jwt_authorizer=None)

Bases: object

The authorizer configuration.

Parameters:: custom_jwt_authorizer (Union[IResolvable, CustomJWTAuthorizerConfigurationProperty, Dict[str, Any], None]) – Represents inbound authorization configuration options used to authenticate incoming requests.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

authorizer_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.AuthorizerConfigurationProperty(
    custom_jwt_authorizer=bedrockagentcore_mixins.CfnRuntimePropsMixin.CustomJWTAuthorizerConfigurationProperty(
        allowed_audience=["allowedAudience"],
        allowed_clients=["allowedClients"],
        discovery_url="discoveryUrl"
    )
)

Attributes

custom_jwt_authorizer

Represents inbound authorization configuration options used to authenticate incoming requests.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-authorizerconfiguration.html#cfn-bedrockagentcore-runtime-authorizerconfiguration-customjwtauthorizer

CodeConfigurationProperty

class CfnRuntimePropsMixin.CodeConfigurationProperty(*, code=None, entry_point=None, runtime=None)

Bases: object

Representation of a code configuration.

Parameters:

code (Union[IResolvable, CodeProperty, Dict[str, Any], None]) – Object represents source code from zip file.
entry_point (Optional[Sequence[str]]) – List of entry points.
runtime (Optional[str]) – Managed runtime types.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

code_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeConfigurationProperty(
    code=bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeProperty(
        s3=bedrockagentcore_mixins.CfnRuntimePropsMixin.S3LocationProperty(
            bucket="bucket",
            prefix="prefix",
            version_id="versionId"
        )
    ),
    entry_point=["entryPoint"],
    runtime="runtime"
)

Attributes

code

Object represents source code from zip file.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-code

entry_point

List of entry points.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-entrypoint

runtime

Managed runtime types.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-codeconfiguration.html#cfn-bedrockagentcore-runtime-codeconfiguration-runtime

CodeProperty

class CfnRuntimePropsMixin.CodeProperty(*, s3=None)

Bases: object

Object represents source code from zip file.

Parameters:: s3 (Union[IResolvable, S3LocationProperty, Dict[str, Any], None]) – S3 Location Configuration.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-code.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

code_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.CodeProperty(
    s3=bedrockagentcore_mixins.CfnRuntimePropsMixin.S3LocationProperty(
        bucket="bucket",
        prefix="prefix",
        version_id="versionId"
    )
)

Attributes

s3

S3 Location Configuration.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-code.html#cfn-bedrockagentcore-runtime-code-s3

ContainerConfigurationProperty

class CfnRuntimePropsMixin.ContainerConfigurationProperty(*, container_uri=None)

Bases: object

The container configuration.

Parameters:: container_uri (Optional[str]) – The container Uri.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-containerconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

container_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.ContainerConfigurationProperty(
    container_uri="containerUri"
)

Attributes

container_uri

The container Uri.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-containerconfiguration.html#cfn-bedrockagentcore-runtime-containerconfiguration-containeruri

CustomJWTAuthorizerConfigurationProperty

class CfnRuntimePropsMixin.CustomJWTAuthorizerConfigurationProperty(*, allowed_audience=None, allowed_clients=None, discovery_url=None)

Bases: object

Configuration for custom JWT authorizer.

Parameters:

allowed_audience (Optional[Sequence[str]]) – Represents inbound authorization configuration options used to authenticate incoming requests.
allowed_clients (Optional[Sequence[str]]) – Represents individual client IDs that are validated in the incoming JWT token validation process.
discovery_url (Optional[str]) – The configuration authorization.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

custom_jWTAuthorizer_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.CustomJWTAuthorizerConfigurationProperty(
    allowed_audience=["allowedAudience"],
    allowed_clients=["allowedClients"],
    discovery_url="discoveryUrl"
)

Attributes

allowed_audience

Represents inbound authorization configuration options used to authenticate incoming requests.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedaudience

allowed_clients

Represents individual client IDs that are validated in the incoming JWT token validation process.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-allowedclients

discovery_url

The configuration authorization.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-customjwtauthorizerconfiguration.html#cfn-bedrockagentcore-runtime-customjwtauthorizerconfiguration-discoveryurl

LifecycleConfigurationProperty

class CfnRuntimePropsMixin.LifecycleConfigurationProperty(*, idle_runtime_session_timeout=None, max_lifetime=None)

Bases: object

Configuration for managing the lifecycle of runtime sessions and resources.

Parameters:

idle_runtime_session_timeout (Union[int, float, None]) – Timeout in seconds for idle runtime sessions.
max_lifetime (Union[int, float, None]) – Maximum lifetime in seconds for runtime sessions.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

lifecycle_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.LifecycleConfigurationProperty(
    idle_runtime_session_timeout=123,
    max_lifetime=123
)

Attributes

idle_runtime_session_timeout

Timeout in seconds for idle runtime sessions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-idleruntimesessiontimeout

max_lifetime

Maximum lifetime in seconds for runtime sessions.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-lifecycleconfiguration.html#cfn-bedrockagentcore-runtime-lifecycleconfiguration-maxlifetime

NetworkConfigurationProperty

class CfnRuntimePropsMixin.NetworkConfigurationProperty(*, network_mode=None, network_mode_config=None)

Bases: object

The network configuration for the agent.

Parameters:

network_mode (Optional[str]) – The network mode.
network_mode_config (Union[IResolvable, VpcConfigProperty, Dict[str, Any], None]) – Network mode configuration for VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

network_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.NetworkConfigurationProperty(
    network_mode="networkMode",
    network_mode_config=bedrockagentcore_mixins.CfnRuntimePropsMixin.VpcConfigProperty(
        security_groups=["securityGroups"],
        subnets=["subnets"]
    )
)

Attributes

network_mode

The network mode.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmode

network_mode_config

Network mode configuration for VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-networkconfiguration.html#cfn-bedrockagentcore-runtime-networkconfiguration-networkmodeconfig

RequestHeaderConfigurationProperty

class CfnRuntimePropsMixin.RequestHeaderConfigurationProperty(*, request_header_allowlist=None)

Bases: object

Configuration for HTTP request headers.

Parameters:: request_header_allowlist (Optional[Sequence[str]]) – List of allowed HTTP headers for agent runtime requests.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

request_header_configuration_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.RequestHeaderConfigurationProperty(
    request_header_allowlist=["requestHeaderAllowlist"]
)

Attributes

request_header_allowlist

List of allowed HTTP headers for agent runtime requests.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-requestheaderconfiguration.html#cfn-bedrockagentcore-runtime-requestheaderconfiguration-requestheaderallowlist

S3LocationProperty

class CfnRuntimePropsMixin.S3LocationProperty(*, bucket=None, prefix=None, version_id=None)

Bases: object

S3 Location Configuration.

Parameters:

bucket (Optional[str]) – S3 bucket name.
prefix (Optional[str]) – S3 object key prefix.
version_id (Optional[str]) – S3 object version ID.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

s3_location_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.S3LocationProperty(
    bucket="bucket",
    prefix="prefix",
    version_id="versionId"
)

Attributes

bucket

S3 bucket name.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-bucket

prefix

S3 object key prefix.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-prefix

version_id

S3 object version ID.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-s3location.html#cfn-bedrockagentcore-runtime-s3location-versionid

VpcConfigProperty

class CfnRuntimePropsMixin.VpcConfigProperty(*, security_groups=None, subnets=None)

Bases: object

Network mode configuration for VPC.

Parameters:

security_groups (Optional[Sequence[str]]) – Security groups for VPC.
subnets (Optional[Sequence[str]]) – Subnets for VPC.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

vpc_config_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.VpcConfigProperty(
    security_groups=["securityGroups"],
    subnets=["subnets"]
)

Attributes

security_groups

Security groups for VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-securitygroups

subnets

Subnets for VPC.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-vpcconfig.html#cfn-bedrockagentcore-runtime-vpcconfig-subnets

WorkloadIdentityDetailsProperty

class CfnRuntimePropsMixin.WorkloadIdentityDetailsProperty(*, workload_identity_arn=None)

Bases: object

The workload identity details for the agent.

Parameters:: workload_identity_arn (Optional[str]) – The Amazon Resource Name (ARN) for the workload identity.
See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-workloadidentitydetails.html
ExampleMetadata:: fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk.mixins_preview.aws_bedrockagentcore import mixins as bedrockagentcore_mixins

workload_identity_details_property = bedrockagentcore_mixins.CfnRuntimePropsMixin.WorkloadIdentityDetailsProperty(
    workload_identity_arn="workloadIdentityArn"
)

Attributes

workload_identity_arn

The Amazon Resource Name (ARN) for the workload identity.

See:: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-bedrockagentcore-runtime-workloadidentitydetails.html#cfn-bedrockagentcore-runtime-workloadidentitydetails-workloadidentityarn