# BrowserCustom

Browser resource for AWS Bedrock Agent Core.

Provides a browser environment for web automation and interaction.

Extends: Construct › Resource › BrowserCustomBase › BrowserCustom
Implements: IResource, IBrowserCustom, IConnectable, IGrantable, IEnvironmentAware, IBrowserCustomRef, IConstruct, IDependable

- CloudFormation: [`AWS::BedrockAgentCore::BrowserCustom`](https://docs.aws.amazon.com/AWSCloudFormation/latest/TemplateReference/aws-resource-bedrockagentcore-browsercustom.html)
- L1 type: [`CfnBrowserCustom`](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.CfnBrowserCustom.html)
- Source: [`aws-bedrockagentcore/lib/tools/browser.ts`](https://github.com/aws/aws-cdk/blob/v2.274.0/packages/aws-cdk-lib/aws-bedrockagentcore/lib/tools/browser.ts#L644)
- Type last changed: v2.255.0 · 19 May 2026

## Example

```ts
const browser = new agentcore.BrowserCustom(this, 'BrowserVpcWithRecording', {
  browserCustomName: 'browser_recording',
  networkConfiguration: agentcore.BrowserNetworkConfiguration.usingVpc(this, {
    vpc: new ec2.Vpc(this, 'VPC', { restrictDefaultSecurityGroup: false }),
  }),
});
```

## Initializer

```ts
new BrowserCustom(scope: Construct, id: string, props?: BrowserCustomProps)
```

## Construct Props

- `browserCustomName`: string = auto generate — The name of the browser custom tool Valid characters are a-z, A-Z, 0-9, _ (underscore) The name must start with a letter and can be up to 48 characters long Pattern: [a-zA-Z][a-zA-Z0-9_]{0,47}.

- `browserSigning`: [BrowserSigning](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.BrowserSigning.html) = BrowserSigning.DISABLED — Specifies whether browser signing is enabled.

  When enabled, the browser will cryptographically sign
  HTTP requests to identify itself as an AI agent to bot control vendors.

- `description`: string = No description — Optional description for the browser Valid characters are a-z, A-Z, 0-9, _ (underscore), - (hyphen) and spaces The description can have up to 200 characters.

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) = A new role will be created — The IAM role that provides permissions for the browser to access AWS services.

- `networkConfiguration`: [BrowserNetworkConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.BrowserNetworkConfiguration.html) = PUBLIC network mode — Network configuration for browser.

- `recordingConfig`: [RecordingConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.RecordingConfig.html) = No recording configuration — Recording configuration for browser.

- `tags`: { [key: string]: string } = {} - no tags — Tags (optional) A list of key:value pairs of tags to apply to this Browser resource.

## Properties

- `browserArn`: string (required) — The ARN of the browser resource.

- `browserCustomName`: string (required) — The name of the browser custom tool.

- `browserCustomRef`: [BrowserCustomReference](/cdk/api/v2/docs/aws-cdk-lib.interfaces.aws_bedrockagentcore.BrowserCustomReference.html) (required) — A reference to a BrowserCustom resource.

- `browserId`: string (required) — The id of the browser.

- `browserSigning`: [BrowserSigning](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.BrowserSigning.html) — The browser signing configuration of the browser.

- `connections`: [Connections](/cdk/api/v2/docs/aws-cdk-lib.aws_ec2.Connections.html) (required) — An accessor for the Connections object that will fail if this Browser does not have a VPC configured.

- `createdAt`: string — The created timestamp of the browser.

- `description`: string — The description of the browser.

- `env`: [ResourceEnvironment](/cdk/api/v2/docs/aws-cdk-lib.interfaces.ResourceEnvironment.html) (required) — The environment this resource belongs to.

  For resources that are created and managed in a Stack (those created by
  creating new class instances like `new Role()`, `new Bucket()`, etc.), this
  is always the same as the environment of the stack they belong to.

  For referenced resources (those obtained from referencing methods like
  `Role.fromRoleArn()`, `Bucket.fromBucketName()`, etc.), they might be
  different than the stack they were imported into.

- `executionRole`: [IRole](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IRole.html) (required) — The IAM role associated to the browser.

- `failureReason`: string — The failure reason of the browser.

- `grantPrincipal`: [IPrincipal](/cdk/api/v2/docs/aws-cdk-lib.aws_iam.IPrincipal.html) (required) — The principal to grant permissions to.

- `lastUpdatedAt`: string — The last updated timestamp of the browser.

- `networkConfiguration`: [BrowserNetworkConfiguration](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.BrowserNetworkConfiguration.html) (required) — The network configuration of the browser.

- `node`: [Node](/cdk/api/v2/docs/constructs.Node.html) (required) — The tree node.

- `PROPERTY_INJECTION_ID`: string (required) (static) — Uniquely identifies this class.

- `recordingConfig`: [RecordingConfig](/cdk/api/v2/docs/aws-cdk-lib.aws_bedrockagentcore.RecordingConfig.html) — The recording configuration of the browser.

- `stack`: [Stack](/cdk/api/v2/docs/aws-cdk-lib.Stack.html) (required) — The stack in which this resource is defined.

- `status`: string — The status of the browser.

- `tags`: { [key: string]: string } = No tags applied — Tags applied to this browser resource A map of key-value pairs for resource tagging.

## Methods

- `applyCrossStackReferenceStrength(strength: ReferenceStrength): void` — Override the cross-stack reference strength for this resource.

  When set, any cross-stack reference to this resource will use the specified
  mechanism instead of the global default determined by the
  `@aws-cdk/core:defaultCrossStackReferences` context key. This is useful for
  selectively weakening specific references to avoid the "deadly embrace" problem
  without changing the app-wide default.

  **Parameters**

  - `strength` — - The reference strength to use for this resource.

- `applyRemovalPolicy(policy: RemovalPolicy): void` — Apply the given removal policy to this resource.

  The Removal Policy controls what happens to this resource when it stops
  being managed by CloudFormation, either because you've removed it from the
  CDK application or because you've made a change that requires the resource
  to be replaced.

  The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS
  account for data recovery and cleanup later (`RemovalPolicy.RETAIN`).

- `fromBrowserCustomAttributes(scope: Construct, id: string, attrs: BrowserCustomAttributes): IBrowserCustom` (static) — Creates an Browser Custom reference from an existing browser's attributes.

  **Parameters**

  - `scope` — - The construct scope.
  - `id` — - Identifier of the construct.
  - `attrs` — - Attributes of the existing browser custom.

  **Returns:** An IBrowserCustom reference to the existing browser

- `grant(grantee: IGrantable, ...actions: string[]): Grant` — Grants IAM actions to the IAM Principal.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant permissions to.
  - `actions` — - The actions to grant.

  **Returns:** An IAM Grant object representing the granted permissions

- `grantRead(grantee: IGrantable): Grant` — 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]

  **Parameters**

  - `grantee` — - The IAM principal to grant read permissions to.

  **Returns:** An IAM Grant object representing the granted permissions

- `grantUse(grantee: IGrantable): Grant` — Grant permissions to use this browser to an IAM principal.

  This includes `ConnectBrowserAutomationStream`, which is required to connect
  to the automation stream of a session over the Chrome DevTools Protocol.
  Without it, `StartBrowserSession` succeeds but the subsequent connection to
  the returned stream endpoint is rejected.

  [disable-awslint:no-grants]

  **Parameters**

  - `grantee` — - The IAM principal to grant use permissions to.

  **Returns:** An IAM Grant object representing the granted permissions

- `isConstruct(x: any): boolean` (static) — Checks if `x` is a construct.

  Use this method instead of `instanceof` to properly detect `Construct`
  instances, even when the construct library is symlinked.

  Explanation: in JavaScript, multiple copies of the `constructs` library on
  disk are seen as independent, completely different libraries. As a
  consequence, the class `Construct` in each copy of the `constructs` library
  is seen as a different class, and an instance of one class will not test as
  `instanceof` the other class. `npm install` will not create installations
  like this, but users may manually symlink construct libraries together or
  use a monorepo tool: in those cases, multiple copies of the `constructs`
  library can be accidentally installed, and `instanceof` will behave
  unpredictably. It is safest to avoid using `instanceof`, and using
  this type-testing method instead.

  **Parameters**

  - `x` — Any object.

  **Returns:** true if `x` is an object created from a class which extends `Construct`.

- `isOwnedResource(construct: IConstruct): boolean` (static) — Returns true if the construct was created by CDK, and false otherwise.

- `isResource(construct: IConstruct): boolean` (static) — Check whether the given construct is a Resource.

- `metric(metricName: string, props?: MetricOptions): Metric` — 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.

- `metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser errors

- `metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser api operations..

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser api operations

- `metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser invocations.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser latencies

- `metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser latencies.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser latencies

- `metricSessionDuration(props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser session duration.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser session duration

- `metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser system errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser system errors

- `metricTakeOverCount(props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser user takeovers.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser user takeovers

- `metricTakeOverDuration(props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser user takeovers duration.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser user takeovers duration

- `metricTakeOverReleaseCount(props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser user takeovers released.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser user takeovers released

- `metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser throttles.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser throttles

- `metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metric` — Creates a CloudWatch metric for tracking browser user errors.

  **Parameters**

  - `props` — - Configuration options for the metric.

  **Returns:** A CloudWatch Metric configured for browser user errors

- `toString(): string` — Returns a string representation of this construct.

- `with(...mixins: IMixin[]): IConstruct` — Applies one or more mixins to this construct.

  Mixins are applied in order. The list of constructs is captured at the
  start of the call, so constructs added by a mixin will not be visited.
  Use multiple `with()` calls if subsequent mixins should apply to added
  constructs.