Package software.amazon.awscdk.services.bedrockagentcore

Class CfnRuntime

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.bedrockagentcore.CfnRuntime
All Implemented Interfaces:
IInspectable, ITaggableV2, IRuntimeRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-29T11:15:33.813Z") @Stability(Stable) public class CfnRuntime extends CfnResource implements IInspectable, IRuntimeRef, ITaggableV2
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.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.bedrockagentcore.*;
 CfnRuntime cfnRuntime = CfnRuntime.Builder.create(this, "MyCfnRuntime")
         .agentRuntimeArtifact(AgentRuntimeArtifactProperty.builder()
                 .containerConfiguration(ContainerConfigurationProperty.builder()
                         .containerUri("containerUri")
                         .build())
                 .build())
         .agentRuntimeName("agentRuntimeName")
         .networkConfiguration(NetworkConfigurationProperty.builder()
                 .networkMode("networkMode")
                 // the properties below are optional
                 .networkModeConfig(VpcConfigProperty.builder()
                         .securityGroups(List.of("securityGroups"))
                         .subnets(List.of("subnets"))
                         .build())
                 .build())
         .roleArn("roleArn")
         // the properties below are optional
         .authorizerConfiguration(AuthorizerConfigurationProperty.builder()
                 .customJwtAuthorizer(CustomJWTAuthorizerConfigurationProperty.builder()
                         .discoveryUrl("discoveryUrl")
                         // the properties below are optional
                         .allowedAudience(List.of("allowedAudience"))
                         .allowedClients(List.of("allowedClients"))
                         .build())
                 .build())
         .description("description")
         .environmentVariables(Map.of(
                 "environmentVariablesKey", "environmentVariables"))
         .protocolConfiguration("protocolConfiguration")
         .tags(Map.of(
                 "tagsKey", "tags"))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnRuntime

      protected CfnRuntime(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnRuntime

      protected CfnRuntime(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnRuntime

      @Stability(Stable) public CfnRuntime(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnRuntimeProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAgentRuntimeArn

      @Stability(Stable) @NotNull public String getAttrAgentRuntimeArn()
      The agent runtime ARN.

    • getAttrAgentRuntimeId

      @Stability(Stable) @NotNull public String getAttrAgentRuntimeId()
      The ID for the agent runtime.

    • getAttrAgentRuntimeVersion

      @Stability(Stable) @NotNull public String getAttrAgentRuntimeVersion()
      The version for the agent runtime.

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()
      The time at which the runtime was created.

    • getAttrLastUpdatedAt

      @Stability(Stable) @NotNull public String getAttrLastUpdatedAt()
      The time at which the runtime was last updated.

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()
      The status for the agent runtime.

    • getAttrWorkloadIdentityDetails

      @Stability(Stable) @NotNull public IResolvable getAttrWorkloadIdentityDetails()
      Configuration for workload identity.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getRuntimeRef

      @Stability(Stable) @NotNull public RuntimeReference getRuntimeRef()
      A reference to a Runtime resource.
      Specified by:
      getRuntimeRef in interface IRuntimeRef

    • getAgentRuntimeArtifact

      @Stability(Stable) @NotNull public Object getAgentRuntimeArtifact()
      The artifact of the agent.

      Returns union: either IResolvable or CfnRuntime.AgentRuntimeArtifactProperty

    • setAgentRuntimeArtifact

      @Stability(Stable) public void setAgentRuntimeArtifact(@NotNull IResolvable value)
      The artifact of the agent.

    • setAgentRuntimeArtifact

      @Stability(Stable) public void setAgentRuntimeArtifact(@NotNull CfnRuntime.AgentRuntimeArtifactProperty value)
      The artifact of the agent.

    • getAgentRuntimeName

      @Stability(Stable) @NotNull public String getAgentRuntimeName()
      The name of the AgentCore Runtime endpoint.

    • setAgentRuntimeName

      @Stability(Stable) public void setAgentRuntimeName(@NotNull String value)
      The name of the AgentCore Runtime endpoint.

    • getNetworkConfiguration

      @Stability(Stable) @NotNull public Object getNetworkConfiguration()
      The network configuration.

      Returns union: either IResolvable or CfnRuntime.NetworkConfigurationProperty

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@NotNull IResolvable value)
      The network configuration.

    • setNetworkConfiguration

      @Stability(Stable) public void setNetworkConfiguration(@NotNull CfnRuntime.NetworkConfigurationProperty value)
      The network configuration.

    • getRoleArn

      @Stability(Stable) @NotNull public String getRoleArn()
      The Amazon Resource Name (ARN) for for the role.

    • setRoleArn

      @Stability(Stable) public void setRoleArn(@NotNull String value)
      The Amazon Resource Name (ARN) for for the role.

    • getAuthorizerConfiguration

      @Stability(Stable) @Nullable public Object getAuthorizerConfiguration()
      Represents inbound authorization configuration options used to authenticate incoming requests.

      Returns union: either IResolvable or CfnRuntime.AuthorizerConfigurationProperty

    • setAuthorizerConfiguration

      @Stability(Stable) public void setAuthorizerConfiguration(@Nullable IResolvable value)
      Represents inbound authorization configuration options used to authenticate incoming requests.

    • setAuthorizerConfiguration

      @Stability(Stable) public void setAuthorizerConfiguration(@Nullable CfnRuntime.AuthorizerConfigurationProperty value)
      Represents inbound authorization configuration options used to authenticate incoming requests.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      The agent runtime description.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      The agent runtime description.

    • getEnvironmentVariables

      @Stability(Stable) @Nullable public Object getEnvironmentVariables()
      The environment variables for the agent.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable Map<String,String> value)
      The environment variables for the agent.

    • setEnvironmentVariables

      @Stability(Stable) public void setEnvironmentVariables(@Nullable IResolvable value)
      The environment variables for the agent.

    • getProtocolConfiguration

      @Stability(Stable) @Nullable public String getProtocolConfiguration()
      The protocol configuration for an agent runtime.

    • setProtocolConfiguration

      @Stability(Stable) public void setProtocolConfiguration(@Nullable String value)
      The protocol configuration for an agent runtime.

    • getTags

      @Stability(Stable) @Nullable public Map<String,String> getTags()
      The tags for the agent.

    • setTags

      @Stability(Stable) public void setTags(@Nullable Map<String,String> value)
      The tags for the agent.