Package software.amazon.awscdk.services.bedrockagentcore

Interface RuntimeProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
RuntimeProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.502Z") @Stability(Stable) public interface RuntimeProps extends software.amazon.jsii.JsiiSerializable
Properties for creating a Bedrock Agent Core Runtime resource.

Example: 

 // S3 bucket containing the agent core
 Bucket codeBucket = Bucket.Builder.create(this, "AgentCode")
         .bucketName("my-code-bucket")
         .removalPolicy(RemovalPolicy.DESTROY)
         .build();
 // the bucket above needs to contain the agent code
 AgentRuntimeArtifact agentRuntimeArtifact = AgentRuntimeArtifact.fromS3(Location.builder()
         .bucketName(codeBucket.getBucketName())
         .objectKey("deployment_package.zip")
         .build(), AgentCoreRuntime.PYTHON_3_12, List.of("opentelemetry-instrument", "main.py"));
 Runtime runtimeInstance = Runtime.Builder.create(this, "MyAgentRuntime")
         .runtimeName("myAgent")
         .agentRuntimeArtifact(agentRuntimeArtifact)
         .build();

  • Method Details

    • getAgentRuntimeArtifact

      @Stability(Stable) @NotNull AgentRuntimeArtifact getAgentRuntimeArtifact()
      The artifact configuration for the agent runtime Contains the container configuration with ECR URI.

    • getAuthorizerConfiguration

      @Stability(Stable) @Nullable default RuntimeAuthorizerConfiguration getAuthorizerConfiguration()
      Authorizer configuration for the agent runtime Use RuntimeAuthorizerConfiguration static methods to create the configuration.

      Default: - RuntimeAuthorizerConfiguration.iam() (IAM authentication)

    • getDescription

      @Stability(Stable) @Nullable default String getDescription()
      Optional description for the agent runtime.

      Default: - No description Length Minimum: 1 , Maximum: 1200

    • getEnvironmentVariables

      @Stability(Stable) @Nullable default Map<String,String> getEnvironmentVariables()
      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

    • getExecutionRole

      @Stability(Stable) @Nullable default IRole getExecutionRole()
      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

    • getLifecycleConfiguration

      @Stability(Stable) @Nullable default LifecycleConfiguration getLifecycleConfiguration()
      The life cycle configuration for the AgentCore Runtime.

      Default: - No lifecycle configuration

    • getLoggingConfigs

      @Stability(Stable) @Nullable default List<LoggingConfig> getLoggingConfigs()
      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 Also:

    • getNetworkConfiguration

      @Stability(Stable) @Nullable default RuntimeNetworkConfiguration getNetworkConfiguration()
      Network configuration for the agent runtime.

      Default: - RuntimeNetworkConfiguration.usingPublicNetwork()

    • getProtocolConfiguration

      @Stability(Stable) @Nullable default ProtocolType getProtocolConfiguration()
      Protocol configuration for the agent runtime.

      Default: - ProtocolType.HTTP

    • getRequestHeaderConfiguration

      @Stability(Stable) @Nullable default RequestHeaderConfiguration getRequestHeaderConfiguration()
      Configuration for HTTP request headers that will be passed through to the runtime.

      Default: - No request headers configured

    • getRuntimeName

      @Stability(Stable) @Nullable default String getRuntimeName()
      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

    • getTags

      @Stability(Stable) @Nullable default Map<String,String> getTags()
      Tags for the agent runtime A list of key:value pairs of tags to apply to this Runtime resource.

      Default: {} - no tags

    • getTracingEnabled

      @Stability(Stable) @Nullable default Boolean getTracingEnabled()
      Whether to enable X-Ray tracing for this runtime.

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

      Default: false

      See Also:

    • builder

      @Stability(Stable) static RuntimeProps.Builder builder()
      Returns:
      a RuntimeProps.Builder of RuntimeProps