CfnRuntimeProps

class aws_cdk.aws_bedrockagentcore.CfnRuntimeProps(*, agent_runtime_artifact, agent_runtime_name, network_configuration, role_arn, authorizer_configuration=None, description=None, environment_variables=None, protocol_configuration=None, tags=None)

Bases: object

Properties for defining a CfnRuntime.

Parameters:
  • agent_runtime_artifact (Union[IResolvable, AgentRuntimeArtifactProperty, Dict[str, Any]]) – The artifact of the agent.

  • agent_runtime_name (str) – The name of the AgentCore Runtime endpoint.

  • network_configuration (Union[IResolvable, NetworkConfigurationProperty, Dict[str, Any]]) – The network configuration.

  • role_arn (str) – The Amazon Resource Name (ARN) for for the role.

  • authorizer_configuration (Union[IResolvable, AuthorizerConfigurationProperty, Dict[str, Any], None]) – Represents inbound authorization configuration options used to authenticate incoming requests.

  • description (Optional[str]) – The agent runtime description.

  • environment_variables (Union[Mapping[str, str], IResolvable, None]) – The environment variables for the agent.

  • protocol_configuration (Optional[str]) – The protocol configuration for an agent runtime. This structure defines how the agent runtime communicates with clients.

  • tags (Optional[Mapping[str, str]]) – The tags for the agent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.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 import aws_bedrockagentcore as bedrockagentcore

cfn_runtime_props = bedrockagentcore.CfnRuntimeProps(
    agent_runtime_artifact=bedrockagentcore.CfnRuntime.AgentRuntimeArtifactProperty(
        container_configuration=bedrockagentcore.CfnRuntime.ContainerConfigurationProperty(
            container_uri="containerUri"
        )
    ),
    agent_runtime_name="agentRuntimeName",
    network_configuration=bedrockagentcore.CfnRuntime.NetworkConfigurationProperty(
        network_mode="networkMode"
    ),
    role_arn="roleArn",

    # the properties below are optional
    authorizer_configuration=bedrockagentcore.CfnRuntime.AuthorizerConfigurationProperty(
        custom_jwt_authorizer=bedrockagentcore.CfnRuntime.CustomJWTAuthorizerConfigurationProperty(
            discovery_url="discoveryUrl",

            # the properties below are optional
            allowed_audience=["allowedAudience"],
            allowed_clients=["allowedClients"]
        )
    ),
    description="description",
    environment_variables={
        "environment_variables_key": "environmentVariables"
    },
    protocol_configuration="protocolConfiguration",
    tags={
        "tags_key": "tags"
    }
)

Attributes

agent_runtime_artifact

The artifact of the agent.

See:

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

agent_runtime_name

The name of the AgentCore Runtime endpoint.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-agentruntimename

authorizer_configuration

Represents inbound authorization configuration options used to authenticate incoming requests.

See:

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

description

The agent runtime description.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-description

environment_variables

The environment variables for the agent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-environmentvariables

network_configuration

The network configuration.

See:

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

protocol_configuration

The protocol configuration for an agent runtime.

This structure defines how the agent runtime communicates with clients.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-protocolconfiguration

role_arn

The Amazon Resource Name (ARN) for for the role.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-rolearn

tags

The tags for the agent.

See:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-bedrockagentcore-runtime.html#cfn-bedrockagentcore-runtime-tags