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

Interface IBedrockAgentRuntime.Jsii$Default

All Superinterfaces:
IBedrockAgentRuntime, IConnectable, IConnectable.Jsii$Default, software.constructs.IConstruct, software.constructs.IConstruct.Jsii$Default, software.constructs.IDependable, software.constructs.IDependable.Jsii$Default, IEnvironmentAware, IEnvironmentAware.Jsii$Default, IGrantable, IGrantable.Jsii$Default, IResource, IResource.Jsii$Default, software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
IBedrockAgentRuntime.Jsii$Proxy
Enclosing interface:
IBedrockAgentRuntime
@Internal public static interface IBedrockAgentRuntime.Jsii$Default extends IBedrockAgentRuntime, IResource.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IBedrockAgentRuntime.

  • Method Details

    • getAgentRuntimeArn

      @Stability(Experimental) @NotNull default 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";
      Specified by:
      getAgentRuntimeArn in interface IBedrockAgentRuntime

    • getAgentRuntimeId

      @Stability(Experimental) @NotNull default String getAgentRuntimeId()
      (experimental) The ID of the agent runtime.

      Example: 

       "runtime-abc123";
      Specified by:
      getAgentRuntimeId in interface IBedrockAgentRuntime

    • getAgentRuntimeName

      @Stability(Experimental) @NotNull default String getAgentRuntimeName()
      (experimental) The name of the agent runtime.
      Specified by:
      getAgentRuntimeName in interface IBedrockAgentRuntime

    • getRole

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

    • getAgentRuntimeVersion

      @Stability(Experimental) @Nullable default String getAgentRuntimeVersion()
      (experimental) The version of the agent runtime.
      Specified by:
      getAgentRuntimeVersion in interface IBedrockAgentRuntime

    • getAgentStatus

      @Stability(Experimental) @Nullable default String getAgentStatus()
      (experimental) The current status of the agent runtime.
      Specified by:
      getAgentStatus in interface IBedrockAgentRuntime

    • getCreatedAt

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

      Example: 

       "2024-01-15T10:30:00Z";
      Specified by:
      getCreatedAt in interface IBedrockAgentRuntime

    • getLastUpdatedAt

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

      Example: 

       "2024-01-15T14:45:00Z";
      Specified by:
      getLastUpdatedAt in interface IBedrockAgentRuntime

    • addToRolePolicy

      @Stability(Experimental) @NotNull default IBedrockAgentRuntime addToRolePolicy(@NotNull PolicyStatement statement)
      (experimental) 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(Experimental) @NotNull default Grant grant(@NotNull List<String> actions, @NotNull List<String> resources)
      (experimental) Grant the runtime specific actions on AWS resources.

      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(Experimental) @NotNull default 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.

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

    • grantInvokeRuntime

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

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

    • grantInvokeRuntimeForUser

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

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

    • metric

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

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

    • metric

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

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

    • metricInvocations

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

      Specified by:
      metricInvocations in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricInvocations

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

    • metricInvocationsAggregated

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

      Specified by:
      metricInvocationsAggregated in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricInvocationsAggregated

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

    • metricLatency

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

      Specified by:
      metricLatency in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricLatency

      @Stability(Experimental) @NotNull default Metric metricLatency()
      (experimental) Return a metric measuring the latency of requests for this agent runtime.
      Specified by:
      metricLatency in interface IBedrockAgentRuntime

    • metricSessionCount

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

      Specified by:
      metricSessionCount in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSessionCount

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

    • metricSessionsAggregated

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

      Specified by:
      metricSessionsAggregated in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSessionsAggregated

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

    • metricSystemErrors

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

      Specified by:
      metricSystemErrors in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricSystemErrors

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

    • metricThrottles

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

      Specified by:
      metricThrottles in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricThrottles

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

    • metricTotalErrors

      @Stability(Experimental) @NotNull default Metric metricTotalErrors(@Nullable MetricOptions props)
      (experimental) 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(Experimental) @NotNull default Metric metricTotalErrors()
      (experimental) Return a metric containing the total number of errors (system + user) for this agent runtime.
      Specified by:
      metricTotalErrors in interface IBedrockAgentRuntime

    • metricUserErrors

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

      Specified by:
      metricUserErrors in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricUserErrors

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