Package software.amazon.awscdk.services.bedrockagentcore

Interface IBedrockAgentRuntime

All Superinterfaces:
IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IResource, IRuntimeRef, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IBedrockAgentRuntime.Jsii$Default
All Known Implementing Classes:
IBedrockAgentRuntime.Jsii$Proxy, Runtime, RuntimeBase
@Generated(value="jsii-pacmak/1.133.0 (build 0f43e37)", date="2026-07-02T13:32:34.141Z") @Stability(Stable) public interface IBedrockAgentRuntime extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IConnectable, IRuntimeRef
Interface for Agent Runtime resources.

  • Method Details

    • getAgentRuntimeArn

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

      Example: 

       "arn:aws:bedrock-agentcore:us-west-2:123456789012:runtime/runtime-abc123";

    • getAgentRuntimeId

      @Stability(Stable) @NotNull String getAgentRuntimeId()
      The ID of the agent runtime.

      Example: 

       "runtime-abc123";

    • getAgentRuntimeName

      @Stability(Stable) @NotNull String getAgentRuntimeName()
      The name of the agent runtime.

    • getApplicationLogGroup

      @Stability(Stable) @NotNull ILogGroup getApplicationLogGroup()
      The CloudWatch Logs application log group for the default endpoint of this runtime, located at /aws/bedrock-agentcore/runtimes/{agentRuntimeId}-DEFAULT.

      Use this property to attach metric filters, subscription filters, or alarms to the log group without hardcoding its name.

      The log group is created by the AgentCore service on the runtime's first invocation, not by CDK. Constructs that require the log group to exist at deploy time (such as MetricFilter) may race the first invocation; in that case, ensure at least one invocation has occurred before deploying the dependent resources, or pre-create the log group with a LogRetention custom resource using the same name.

      Example: 

       "/aws/bedrock-agentcore/runtimes/runtime-abc123-DEFAULT";

    • getRole

      @Stability(Stable) @NotNull IRole getRole()
      The IAM role that provides permissions for the agent runtime.

    • getAgentRuntimeVersion

      @Stability(Stable) @Nullable default String getAgentRuntimeVersion()
      The version of the agent runtime.

    • getAgentStatus

      @Stability(Stable) @Nullable default String getAgentStatus()
      The current status of the agent runtime.

    • getCreatedAt

      @Stability(Stable) @Nullable default String getCreatedAt()
      The time at which the runtime was created.

      Example: 

       "2024-01-15T10:30:00Z";

    • getLastUpdatedAt

      @Stability(Stable) @Nullable default String getLastUpdatedAt()
      The time at which the runtime was last updated.

      Example: 

       "2024-01-15T14:45:00Z";

    • addToRolePolicy

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

      Parameters:
      statement - The IAM policy statement to add. This parameter is required.
      Returns:
      The runtime instance for chaining

    • grant

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

      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 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.

      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantInvokeRuntime

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

      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • grantInvokeRuntimeForUser

      @Stability(Stable) @NotNull 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.

      Parameters:
      grantee - The principal to grant access to. This parameter is required.

    • metric

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

      Parameters:
      metricName - This parameter is required.
      props -

    • metric

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

      Parameters:
      metricName - This parameter is required.

    • metricInvocations

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

      Parameters:
      props -

    • metricInvocations

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

    • metricInvocationsAggregated

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

      Parameters:
      props -

    • metricInvocationsAggregated

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

    • metricLatency

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

      Parameters:
      props -

    • metricLatency

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

    • metricSessionCount

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

      Parameters:
      props -

    • metricSessionCount

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

    • metricSessionsAggregated

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

      Parameters:
      props -

    • metricSessionsAggregated

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

    • metricSystemErrors

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

      Parameters:
      props -

    • metricSystemErrors

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

    • metricThrottles

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

      Parameters:
      props -

    • metricThrottles

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

    • metricTotalErrors

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

      Parameters:
      props -

    • metricTotalErrors

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

    • metricUserErrors

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

      Parameters:
      props -

    • metricUserErrors

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