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

Class BrowserCustomBase

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.Resource
software.amazon.awscdk.services.bedrock.agentcore.alpha.BrowserCustomBase
All Implemented Interfaces:
IEnvironmentAware, IResource, IBrowserCustom, IConnectable, IGrantable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
Direct Known Subclasses:
BrowserCustom
@Generated(value="jsii-pacmak/1.125.0 (build fdbe357)", date="2026-01-23T11:20:10.039Z") @Stability(Experimental) public abstract class BrowserCustomBase extends Resource implements IBrowserCustom
(experimental) Abstract base class for a Browser.

Contains methods and attributes valid for Browsers either created with CDK or imported.

  • Constructor Details

    • BrowserCustomBase

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

    • BrowserCustomBase

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

    • BrowserCustomBase

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

    • BrowserCustomBase

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

  • Method Details

    • grant

      @Stability(Experimental) @NotNull public Grant grant(@NotNull IGrantable grantee, @NotNull String... actions)
      (experimental) Grants IAM actions to the IAM Principal.

      [disable-awslint:no-grants]

      Specified by:
      grant in interface IBrowserCustom
      Parameters:
      grantee -
      • The IAM principal to grant permissions to.
      This parameter is required.
      actions -
      • The actions to grant.
      This parameter is required.
      Returns:
      An IAM Grant object representing the granted permissions

    • grantRead

      @Stability(Experimental) @NotNull public Grant grantRead(@NotNull IGrantable grantee)
      (experimental) Grant read permissions on this browser to an IAM principal.

      This includes both read permissions on the specific browser and list permissions on all browsers.

      [disable-awslint:no-grants]

      Default: - Default grant configuration: - actions: ['bedrock-agentcore:GetBrowser', 'bedrock-agentcore:GetBrowserSession'] on this.browserArn - actions: ['bedrock-agentcore:ListBrowsers', 'bedrock-agentcore:ListBrowserSessions'] on all resources (*)

      Specified by:
      grantRead in interface IBrowserCustom
      Parameters:
      grantee -
      • The IAM principal to grant read permissions to.
      This parameter is required.
      Returns:
      An IAM Grant object representing the granted permissions

    • grantUse

      @Stability(Experimental) @NotNull public Grant grantUse(@NotNull IGrantable grantee)
      (experimental) Grant invoke permissions on this browser to an IAM principal.

      [disable-awslint:no-grants]

      Default: - Default grant configuration: - actions: ['bedrock-agentcore:StartBrowserSession', 'bedrock-agentcore:UpdateBrowserStream', 'bedrock-agentcore:StopBrowserSession'] - resourceArns: [this.browserArn]

      Specified by:
      grantUse in interface IBrowserCustom
      Parameters:
      grantee -
      • The IAM principal to grant invoke permissions to.
      This parameter is required.
      Returns:
      An IAM Grant object representing the granted permissions

    • metric

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

      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 IBrowserCustom
      Parameters:
      metricName - This parameter is required.
      dimensions - This parameter is required.
      props -

    • metric

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

      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 IBrowserCustom
      Parameters:
      metricName - This parameter is required.
      dimensions - This parameter is required.

    • metricErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricErrorsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Errors

      Specified by:
      metricErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser errors

    • metricErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricErrorsForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Errors

      Specified by:
      metricErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser errors

    • metricForApiOperation

      @Stability(Experimental) @NotNull public Metric metricForApiOperation(@NotNull String metricName, @NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser api operations..

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: metricName - dimensionsMap: { BrowserId: this.browserId }

      Specified by:
      metricForApiOperation in interface IBrowserCustom
      Parameters:
      metricName - This parameter is required.
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser api operations

    • metricForApiOperation

      @Stability(Experimental) @NotNull public Metric metricForApiOperation(@NotNull String metricName, @NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser api operations..

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: metricName - dimensionsMap: { BrowserId: this.browserId }

      Specified by:
      metricForApiOperation in interface IBrowserCustom
      Parameters:
      metricName - This parameter is required.
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser api operations

    • metricInvocationsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricInvocationsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser invocations.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Invocations

      Specified by:
      metricInvocationsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser latencies

    • metricInvocationsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricInvocationsForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser invocations.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Invocations

      Specified by:
      metricInvocationsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser latencies

    • metricLatencyForApiOperation

      @Stability(Experimental) @NotNull public Metric metricLatencyForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser latencies.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Latency

      Specified by:
      metricLatencyForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser latencies

    • metricLatencyForApiOperation

      @Stability(Experimental) @NotNull public Metric metricLatencyForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser latencies.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Latency

      Specified by:
      metricLatencyForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser latencies

    • metricSessionDuration

      @Stability(Experimental) @NotNull public Metric metricSessionDuration(@Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser session duration.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Duration

      Specified by:
      metricSessionDuration in interface IBrowserCustom
      Parameters:
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser session duration

    • metricSessionDuration

      @Stability(Experimental) @NotNull public Metric metricSessionDuration()
      (experimental) Creates a CloudWatch metric for tracking browser session duration.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Duration

      Specified by:
      metricSessionDuration in interface IBrowserCustom
      Returns:
      A CloudWatch Metric configured for browser session duration

    • metricSystemErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricSystemErrorsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser system errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: SystemErrors

      Specified by:
      metricSystemErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser system errors

    • metricSystemErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricSystemErrorsForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser system errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: SystemErrors

      Specified by:
      metricSystemErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser system errors

    • metricTakeOverCount

      @Stability(Experimental) @NotNull public Metric metricTakeOverCount(@Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverCount

      Specified by:
      metricTakeOverCount in interface IBrowserCustom
      Parameters:
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser user takeovers

    • metricTakeOverCount

      @Stability(Experimental) @NotNull public Metric metricTakeOverCount()
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverCount

      Specified by:
      metricTakeOverCount in interface IBrowserCustom
      Returns:
      A CloudWatch Metric configured for browser user takeovers

    • metricTakeOverDuration

      @Stability(Experimental) @NotNull public Metric metricTakeOverDuration(@Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers duration.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverDuration

      Specified by:
      metricTakeOverDuration in interface IBrowserCustom
      Parameters:
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser user takeovers duration

    • metricTakeOverDuration

      @Stability(Experimental) @NotNull public Metric metricTakeOverDuration()
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers duration.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverDuration

      Specified by:
      metricTakeOverDuration in interface IBrowserCustom
      Returns:
      A CloudWatch Metric configured for browser user takeovers duration

    • metricTakeOverReleaseCount

      @Stability(Experimental) @NotNull public Metric metricTakeOverReleaseCount(@Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers released.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverReleaseCount

      Specified by:
      metricTakeOverReleaseCount in interface IBrowserCustom
      Parameters:
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser user takeovers released

    • metricTakeOverReleaseCount

      @Stability(Experimental) @NotNull public Metric metricTakeOverReleaseCount()
      (experimental) Creates a CloudWatch metric for tracking browser user takeovers released.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverReleaseCount

      Specified by:
      metricTakeOverReleaseCount in interface IBrowserCustom
      Returns:
      A CloudWatch Metric configured for browser user takeovers released

    • metricThrottlesForApiOperation

      @Stability(Experimental) @NotNull public Metric metricThrottlesForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser throttles.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Throttles

      Specified by:
      metricThrottlesForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser throttles

    • metricThrottlesForApiOperation

      @Stability(Experimental) @NotNull public Metric metricThrottlesForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser throttles.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Throttles

      Specified by:
      metricThrottlesForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser throttles

    • metricUserErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricUserErrorsForApiOperation(@NotNull String operation, @Nullable MetricOptions props)
      (experimental) Creates a CloudWatch metric for tracking browser user errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: UserErrors

      Specified by:
      metricUserErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      props -
      • Configuration options for the metric.
      Returns:
      A CloudWatch Metric configured for browser user errors

    • metricUserErrorsForApiOperation

      @Stability(Experimental) @NotNull public Metric metricUserErrorsForApiOperation(@NotNull String operation)
      (experimental) Creates a CloudWatch metric for tracking browser user errors.

      Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: UserErrors

      Specified by:
      metricUserErrorsForApiOperation in interface IBrowserCustom
      Parameters:
      operation - This parameter is required.
      Returns:
      A CloudWatch Metric configured for browser user errors

    • getBrowserArn

      @Stability(Experimental) @NotNull public abstract String getBrowserArn()
      (experimental) The ARN of the browser resource.
      Specified by:
      getBrowserArn in interface IBrowserCustom

    • getBrowserId

      @Stability(Experimental) @NotNull public abstract String getBrowserId()
      (experimental) The id of the browser.
      Specified by:
      getBrowserId in interface IBrowserCustom

    • getConnections

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

    • getExecutionRole

      @Stability(Experimental) @NotNull public abstract IRole getExecutionRole()
      (experimental) The IAM role that provides permissions for the browser to access AWS services.
      Specified by:
      getExecutionRole in interface IBrowserCustom

    • getGrantPrincipal

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

    • getCreatedAt

      @Stability(Experimental) @Nullable public abstract String getCreatedAt()
      (experimental) Timestamp when the browser was created.
      Specified by:
      getCreatedAt in interface IBrowserCustom

    • getLastUpdatedAt

      @Stability(Experimental) @Nullable public abstract String getLastUpdatedAt()
      (experimental) Timestamp when the browser was last updated.
      Specified by:
      getLastUpdatedAt in interface IBrowserCustom

    • getStatus

      @Stability(Experimental) @Nullable public abstract String getStatus()
      (experimental) The status of the browser.
      Specified by:
      getStatus in interface IBrowserCustom