Package software.amazon.awscdk.services.bedrockagentcore

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, IRuntimeRef, IRuntimeRef.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, IRuntimeRef.Jsii$Default, IConnectable.Jsii$Default, IGrantable.Jsii$Default
Internal default implementation for IBedrockAgentRuntime.

  • Method Details

    • getAgentRuntimeArn

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

    • getAgentRuntimeId

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

      Example: 

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

    • getAgentRuntimeName

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

    • getApplicationLogGroup

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

    • getRole

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

    • getAgentRuntimeVersion

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

    • getAgentStatus

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

    • getCreatedAt

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

      Example: 

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

    • getLastUpdatedAt

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

      Example: 

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

    • addToRolePolicy

      @Stability(Stable) @NotNull default 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 default Grant grant(@NotNull List<String> actions, @NotNull List<String> resources)
      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(Stable) @NotNull default 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.

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

    • grantInvokeRuntime

      @Stability(Stable) @NotNull default Grant grantInvokeRuntime(@NotNull IGrantable grantee)
      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(Stable) @NotNull default 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.

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

    • metric

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

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

    • metric

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

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

    • metricInvocations

      @Stability(Stable) @NotNull default 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 default 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 default 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 default Metric metricInvocationsAggregated()
      Return a metric containing the total number of invocations across all resources.
      Specified by:
      metricInvocationsAggregated in interface IBedrockAgentRuntime

    • metricLatency

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

      Specified by:
      metricLatency in interface IBedrockAgentRuntime
      Parameters:
      props -

    • metricLatency

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

    • metricSessionCount

      @Stability(Stable) @NotNull default 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 default 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 default 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 default Metric metricSessionsAggregated()
      Return a metric containing the total number of sessions across all resources.
      Specified by:
      metricSessionsAggregated in interface IBedrockAgentRuntime

    • metricSystemErrors

      @Stability(Stable) @NotNull default 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 default 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 default 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 default 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 default 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 default 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 default 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 default Metric metricUserErrors()
      Return a metric containing the number of user errors for this agent runtime.
      Specified by:
      metricUserErrors in interface IBedrockAgentRuntime