Package software.amazon.awscdk.services.bedrock.agentcore.alpha

Interface IBedrockAgentRuntime

All Superinterfaces:
IConnectable, software.constructs.IConstruct, software.constructs.IDependable, IEnvironmentAware, IGrantable, IResource, software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
IBedrockAgentRuntime.Jsii$Default
All Known Implementing Classes:
IBedrockAgentRuntime.Jsii$Proxy, Runtime, RuntimeBase
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-15T15:35:20.997Z") @Stability(Experimental) public interface IBedrockAgentRuntime extends software.amazon.jsii.JsiiSerializable, IResource, IGrantable, IConnectable
(experimental) Interface for Agent Runtime resources.

  • Method Details

    • getAgentRuntimeArn

      @Stability(Experimental) @NotNull String getAgentRuntimeArn()
      (experimental) 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(Experimental) @NotNull String getAgentRuntimeId()
      (experimental) The ID of the agent runtime.

      Example: 

       "runtime-abc123";

    • getAgentRuntimeName

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

    • getRole

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

    • getAgentRuntimeVersion

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

    • getAgentStatus

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

    • getCreatedAt

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

      Example: 

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

    • getLastUpdatedAt

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

      Example: 

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

    • addToRolePolicy

      @Stability(Experimental) @NotNull IBedrockAgentRuntime addToRolePolicy(@NotNull PolicyStatement statement)
      (experimental) 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(Experimental) @NotNull Grant grant(@NotNull List<String> actions, @NotNull List<String> resources)
      (experimental) 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(Experimental) @NotNull Grant grantInvoke(@NotNull IGrantable grantee)
      (experimental) 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(Experimental) @NotNull Grant grantInvokeRuntime(@NotNull IGrantable grantee)
      (experimental) 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(Experimental) @NotNull Grant grantInvokeRuntimeForUser(@NotNull IGrantable grantee)
      (experimental) 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(Experimental) @NotNull Metric metric(@NotNull String metricName, @NotNull Map<String,String> dimensions, @Nullable MetricOptions props)
      (experimental) Return the given named metric for this agent runtime.

      Parameters:
      metricName - This parameter is required.
      dimensions - This parameter is required.
      props -

    • metric

      @Stability(Experimental) @NotNull Metric metric(@NotNull String metricName, @NotNull Map<String,String> dimensions)
      (experimental) Return the given named metric for this agent runtime.

      Parameters:
      metricName - This parameter is required.
      dimensions - This parameter is required.

    • metricInvocations

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

      Parameters:
      props -

    • metricInvocations

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

    • metricInvocationsAggregated

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

      Parameters:
      props -

    • metricInvocationsAggregated

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

    • metricLatency

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

      Parameters:
      props -

    • metricLatency

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

    • metricSessionCount

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

      Parameters:
      props -

    • metricSessionCount

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

    • metricSessionsAggregated

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

      Parameters:
      props -

    • metricSessionsAggregated

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

    • metricSystemErrors

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

      Parameters:
      props -

    • metricSystemErrors

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

    • metricThrottles

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

      Parameters:
      props -

    • metricThrottles

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

    • metricTotalErrors

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

      Parameters:
      props -

    • metricTotalErrors

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

    • metricUserErrors

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

      Parameters:
      props -

    • metricUserErrors

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