Package software.amazon.awscdk.services.bedrockagentcore

Class RuntimeBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrockagentcore.RuntimeBase
All Implemented Interfaces:
IRuntimeRef, IEnvironmentAware, IResource, IBedrockAgentRuntime, IConnectable, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
Runtime
@Generated(value="jsii-pacmak/1.129.0 (build eaca441)", date="2026-05-19T08:18:44.497Z") @Stability(Stable) public abstract class RuntimeBase extends Resource implements IBedrockAgentRuntime
Base class for Agent Runtime.

  • Constructor Details

    • RuntimeBase

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

    • RuntimeBase

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

    • RuntimeBase

      @Stability(Stable) protected RuntimeBase(@NotNull software.constructs.Construct scope, @NotNull String id, @Nullable ResourceProps props)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      props -

    • RuntimeBase

      @Stability(Stable) protected RuntimeBase(@NotNull software.constructs.Construct scope, @NotNull String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.

  • Method Details

    • addToRolePolicy

      @Stability(Stable) @NotNull public IBedrockAgentRuntime addToRolePolicy(@NotNull PolicyStatement statement)
      Adds a policy statement to the runtime's execution role.

      Specified by:
      addToRolePolicy in interface IBedrockAgentRuntime
      Parameters:
      statement - The IAM policy statement to add. This parameter is required.
      Returns:
      The runtime instance for chaining

    • grant

      @Stability(Stable) @NotNull public Grant grant(@NotNull List<String> actions, @NotNull List<String> resources)
      Grant the runtime specific actions on AWS resources.

      [disable-awslint:no-grants]

      Specified by:
      grant in interface IBedrockAgentRuntime
      Parameters:
      actions - The actions to grant. This parameter is required.
      resources - The resource ARNs to grant access to. This parameter is required.
      Returns:
      The Grant object for chaining

    • grantInvoke

      @Stability(Stable) @NotNull public Grant grantInvoke(@NotNull IGrantable grantee)
      Permits an IAM principal to invoke this runtime both directly and on behalf of users Grants both bedrock-agentcore:InvokeAgentRuntime and bedrock-agentcore:InvokeAgentRuntimeForUser permissions.

      [disable-awslint:no-grants]

      Specified by:
      grantInvoke in interface IBedrockAgentRuntime
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantInvokeRuntime

      @Stability(Stable) @NotNull public Grant grantInvokeRuntime(@NotNull IGrantable grantee)
      Permits an IAM principal to invoke this runtime Grants the bedrock-agentcore:InvokeAgentRuntime permission.

      [disable-awslint:no-grants]

      Specified by:
      grantInvokeRuntime in interface IBedrockAgentRuntime
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantInvokeRuntimeForUser

      @Stability(Stable) @NotNull public Grant grantInvokeRuntimeForUser(@NotNull IGrantable grantee)
      Permits an IAM principal to invoke this runtime on behalf of a user Grants the bedrock-agentcore:InvokeAgentRuntimeForUser permission Required when using the X-Amzn-Bedrock-AgentCore-Runtime-User-Id header.

      [disable-awslint:no-grants]

      Specified by:
      grantInvokeRuntimeForUser in interface IBedrockAgentRuntime
      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName, @Nullable MetricOptions props)
      Return the given named metric for this agent runtime.

      By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

      Specified by:
      metric in interface IBedrockAgentRuntime
      Parameters:
      metricName - This parameter is required.
      props -

    • metric

      @Stability(Stable) @NotNull public Metric metric(@NotNull String metricName)
      Return the given named metric for this agent runtime.

      By default, the metric will be calculated as a sum over a period of 5 minutes. You can customize this by using the statistic and period properties.

      Specified by:
      metric in interface IBedrockAgentRuntime
      Parameters:
      metricName - This parameter is required.

    • metricInvocations

      @Stability(Stable) @NotNull public Metric metricInvocations(@Nullable MetricOptions props)
      Return a metric containing the total number of invocations for this agent runtime.

      Specified by:
      metricInvocations in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricInvocations

      @Stability(Stable) @NotNull public Metric metricInvocations()
      Return a metric containing the total number of invocations for this agent runtime.
      Specified by:
      metricInvocations in interface IBedrockAgentRuntime

    • metricInvocationsAggregated

      @Stability(Stable) @NotNull public Metric metricInvocationsAggregated(@Nullable MetricOptions props)
      Return a metric containing the total number of invocations across all resources.

      Specified by:
      metricInvocationsAggregated in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricInvocationsAggregated

      @Stability(Stable) @NotNull public Metric metricInvocationsAggregated()
      Return a metric containing the total number of invocations across all resources.
      Specified by:
      metricInvocationsAggregated in interface IBedrockAgentRuntime

    • metricLatency

      @Stability(Stable) @NotNull public Metric metricLatency(@Nullable MetricOptions props)
      Return a metric measuring the latency of requests for this agent runtime.

      The latency metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.

      Specified by:
      metricLatency in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricLatency

      @Stability(Stable) @NotNull public Metric metricLatency()
      Return a metric measuring the latency of requests for this agent runtime.

      The latency metric represents the total time elapsed between receiving the request and sending the final response token, representing complete end-to-end processing time.

      Specified by:
      metricLatency in interface IBedrockAgentRuntime

    • metricSessionCount

      @Stability(Stable) @NotNull public Metric metricSessionCount(@Nullable MetricOptions props)
      Return a metric containing the number of agent sessions for this agent runtime.

      Specified by:
      metricSessionCount in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSessionCount

      @Stability(Stable) @NotNull public Metric metricSessionCount()
      Return a metric containing the number of agent sessions for this agent runtime.
      Specified by:
      metricSessionCount in interface IBedrockAgentRuntime

    • metricSessionsAggregated

      @Stability(Stable) @NotNull public Metric metricSessionsAggregated(@Nullable MetricOptions props)
      Return a metric containing the total number of sessions across all resources.

      Specified by:
      metricSessionsAggregated in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSessionsAggregated

      @Stability(Stable) @NotNull public Metric metricSessionsAggregated()
      Return a metric containing the total number of sessions across all resources.
      Specified by:
      metricSessionsAggregated in interface IBedrockAgentRuntime

    • metricSystemErrors

      @Stability(Stable) @NotNull public Metric metricSystemErrors(@Nullable MetricOptions props)
      Return a metric containing the number of system errors for this agent runtime.

      Specified by:
      metricSystemErrors in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSystemErrors

      @Stability(Stable) @NotNull public Metric metricSystemErrors()
      Return a metric containing the number of system errors for this agent runtime.
      Specified by:
      metricSystemErrors in interface IBedrockAgentRuntime

    • metricThrottles

      @Stability(Stable) @NotNull public Metric metricThrottles(@Nullable MetricOptions props)
      Return a metric containing the number of throttled requests for this agent runtime.

      Specified by:
      metricThrottles in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricThrottles

      @Stability(Stable) @NotNull public Metric metricThrottles()
      Return a metric containing the number of throttled requests for this agent runtime.
      Specified by:
      metricThrottles in interface IBedrockAgentRuntime

    • metricTotalErrors

      @Stability(Stable) @NotNull public Metric metricTotalErrors(@Nullable MetricOptions props)
      Return a metric containing the total number of errors (system + user) for this agent runtime.

      Specified by:
      metricTotalErrors in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricTotalErrors

      @Stability(Stable) @NotNull public Metric metricTotalErrors()
      Return a metric containing the total number of errors (system + user) for this agent runtime.
      Specified by:
      metricTotalErrors in interface IBedrockAgentRuntime

    • metricUserErrors

      @Stability(Stable) @NotNull public Metric metricUserErrors(@Nullable MetricOptions props)
      Return a metric containing the number of user errors for this agent runtime.

      Specified by:
      metricUserErrors in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricUserErrors

      @Stability(Stable) @NotNull public Metric metricUserErrors()
      Return a metric containing the number of user errors for this agent runtime.
      Specified by:
      metricUserErrors in interface IBedrockAgentRuntime

    • getAgentRuntimeArn

      @Stability(Stable) @NotNull public abstract String getAgentRuntimeArn()
      The ARN of the agent runtime resource - Format arn:${Partition}:bedrock-agentcore:${Region}:${Account}:runtime/${RuntimeId}.
      Specified by:
      getAgentRuntimeArn in interface IBedrockAgentRuntime

    • getAgentRuntimeId

      @Stability(Stable) @NotNull public abstract String getAgentRuntimeId()
      The ID of the agent runtime.
      Specified by:
      getAgentRuntimeId in interface IBedrockAgentRuntime

    • getAgentRuntimeName

      @Stability(Stable) @NotNull public abstract String getAgentRuntimeName()
      The name of the agent runtime.
      Specified by:
      getAgentRuntimeName in interface IBedrockAgentRuntime

    • getConnections

      @Stability(Stable) @NotNull public Connections getConnections()
      An accessor for the Connections object that will fail if this Runtime does not have a VPC configured.
      Specified by:
      getConnections in interface IConnectable

    • getGrantPrincipal

      @Stability(Stable) @NotNull public abstract IPrincipal getGrantPrincipal()
      The principal to grant permissions to.
      Specified by:
      getGrantPrincipal in interface IGrantable

    • getRole

      @Stability(Stable) @NotNull public abstract IRole getRole()
      The IAM role that provides permissions for the agent runtime.
      Specified by:
      getRole in interface IBedrockAgentRuntime

    • getRuntimeRef

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

    • getAgentRuntimeVersion

      @Stability(Stable) @Nullable public abstract String getAgentRuntimeVersion()
      The version of the agent runtime.
      Specified by:
      getAgentRuntimeVersion in interface IBedrockAgentRuntime

    • getAgentStatus

      @Stability(Stable) @Nullable public abstract String getAgentStatus()
      The current status of the agent runtime.
      Specified by:
      getAgentStatus in interface IBedrockAgentRuntime

    • getCreatedAt

      @Stability(Stable) @Nullable public abstract String getCreatedAt()
      The time at which the runtime was created.
      Specified by:
      getCreatedAt in interface IBedrockAgentRuntime

    • getLastUpdatedAt

      @Stability(Stable) @Nullable public abstract String getLastUpdatedAt()
      The time at which the runtime was last updated.
      Specified by:
      getLastUpdatedAt in interface IBedrockAgentRuntime