class BrowserCustom (construct)

Language	Type name
.NET	`Amazon.CDK.AWS.BedrockAgentCore.BrowserCustom`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsbedrockagentcore#BrowserCustom`
Java	`software.amazon.awscdk.services.bedrockagentcore.BrowserCustom`
Python	`aws_cdk.aws_bedrockagentcore.BrowserCustom`
TypeScript (source)	`aws-cdk-lib` » `aws_bedrockagentcore` » `BrowserCustom`

Implements IConstruct, IDependable, IResource, IEnvironmentAware, IBrowserCustom, IGrantable, IConnectable, IBrowserCustomRef

Browser resource for AWS Bedrock Agent Core.

Provides a browser environment for web automation and interaction.

Example

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

Initializer

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

Parameters

scope Construct
id string
props BrowserCustomProps

Construct Props

Name	Type	Description
browserCustomName?	`string`	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`	Specifies whether browser signing is enabled.
description?	`string`	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`	The IAM role that provides permissions for the browser to access AWS services.
networkConfiguration?	`BrowserNetworkConfiguration`	Network configuration for browser.
recordingConfig?	`RecordingConfig`	Recording configuration for browser.
tags?	`{ [string]: string }`	Tags (optional) A list of key:value pairs of tags to apply to this Browser resource.

browserCustomName?

Type: string (optional, default: 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?

Type: BrowserSigning (optional, default: 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?

Type: string (optional, default: 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?

Type: IRole (optional, default: A new role will be created)

The IAM role that provides permissions for the browser to access AWS services.

networkConfiguration?

Type: BrowserNetworkConfiguration (optional, default: PUBLIC network mode)

Network configuration for browser.

recordingConfig?

Type: RecordingConfig (optional, default: No recording configuration)

Recording configuration for browser.

tags?

Type: { [string]: string } (optional, default: {} - no tags)

Tags (optional) A list of key:value pairs of tags to apply to this Browser resource.

Properties

Name	Type	Description
browserArn	`string`	The ARN of the browser resource.
browserCustomName	`string`	The name of the browser custom tool.
browserCustomRef	`BrowserCustomReference`	A reference to a BrowserCustom resource.
browserId	`string`	The id of the browser.
connections	`Connections`	An accessor for the Connections object that will fail if this Browser does not have a VPC configured.
env	`ResourceEnvironment`	The environment this resource belongs to.
executionRole	`IRole`	The IAM role associated to the browser.
grantPrincipal	`IPrincipal`	The principal to grant permissions to.
networkConfiguration	`BrowserNetworkConfiguration`	The network configuration of the browser.
node	`Node`	The tree node.
stack	`Stack`	The stack in which this resource is defined.
browserSigning?	`BrowserSigning`	The browser signing configuration of the browser.
createdAt?	`string`	The created timestamp of the browser.
description?	`string`	The description of the browser.
failureReason?	`string`	The failure reason of the browser.
lastUpdatedAt?	`string`	The last updated timestamp of the browser.
recordingConfig?	`RecordingConfig`	The recording configuration of the browser.
status?	`string`	The status of the browser.
tags?	`{ [string]: string }`	Tags applied to this browser resource A map of key-value pairs for resource tagging.
static PROPERTY_INJECTION_ID	`string`	Uniquely identifies this class.

browserArn

Type: string

The ARN of the browser resource.

browserCustomName

Type: string

The name of the browser custom tool.

browserCustomRef

Type: BrowserCustomReference

A reference to a BrowserCustom resource.

browserId

Type: string

The id of the browser.

connections

Type: Connections

An accessor for the Connections object that will fail if this Browser does not have a VPC configured.

env

Type: ResourceEnvironment

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

Type: IRole

The IAM role associated to the browser.

grantPrincipal

Type: IPrincipal

The principal to grant permissions to.

networkConfiguration

Type: BrowserNetworkConfiguration

The network configuration of the browser.

node

Type: Node

The tree node.

stack

Type: Stack

The stack in which this resource is defined.

browserSigning?

Type: BrowserSigning (optional)

The browser signing configuration of the browser.

createdAt?

Type: string (optional)

The created timestamp of the browser.

description?

Type: string (optional)

The description of the browser.

failureReason?

Type: string (optional)

The failure reason of the browser.

lastUpdatedAt?

Type: string (optional)

The last updated timestamp of the browser.

recordingConfig?

Type: RecordingConfig (optional)

The recording configuration of the browser.

status?

Type: string (optional)

The status of the browser.

tags?

Type: { [string]: string } (optional, default: No tags applied)

Tags applied to this browser resource A map of key-value pairs for resource tagging.

static PROPERTY_INJECTION_ID

Type: string

Uniquely identifies this class.

Methods

Name	Description
applyRemovalPolicy(policy)	Apply the given removal policy to this resource.
grant(grantee, ...actions)	Grants IAM actions to the IAM Principal.
grantRead(grantee)	Grant read permissions on this browser to an IAM principal.
grantUse(grantee)	Grant invoke permissions on this browser to an IAM principal.
metric(metricName, props?)	Return the given named metric for this browser.
metricErrorsForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser errors.
metricForApiOperation(metricName, operation, props?)	Creates a CloudWatch metric for tracking browser api operations..
metricInvocationsForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser invocations.
metricLatencyForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser latencies.
metricSessionDuration(props?)	Creates a CloudWatch metric for tracking browser session duration.
metricSystemErrorsForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser system errors.
metricTakeOverCount(props?)	Creates a CloudWatch metric for tracking browser user takeovers.
metricTakeOverDuration(props?)	Creates a CloudWatch metric for tracking browser user takeovers duration.
metricTakeOverReleaseCount(props?)	Creates a CloudWatch metric for tracking browser user takeovers released.
metricThrottlesForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser throttles.
metricUserErrorsForApiOperation(operation, props?)	Creates a CloudWatch metric for tracking browser user errors.
toString()	Returns a string representation of this construct.
with(...mixins)	Applies one or more mixins to this construct.
static fromBrowserCustomAttributes(scope, id, attrs)	Creates an Browser Custom reference from an existing browser's attributes.

applyRemovalPolicy(policy)

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

policy RemovalPolicy

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).

grant(grantee, ...actions)

public grant(grantee: IGrantable, ...actions: string[]): Grant

Parameters

grantee IGrantable — - The IAM principal to grant permissions to.
actions string — - The actions to grant.

Returns

Grant

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

grantRead(grantee)

public grantRead(grantee: IGrantable): Grant

Parameters

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

Returns

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]

grantUse(grantee)

public grantUse(grantee: IGrantable): Grant

Parameters

grantee IGrantable — - The IAM principal to grant invoke permissions to.

Returns

Grant

Grant invoke permissions on this browser to an IAM principal.

[disable-awslint:no-grants]

metric(metricName, props?)

public metric(metricName: string, props?: MetricOptions): Metric

Parameters

metricName string
props MetricOptions

Returns

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, props?)

public metricErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser errors.

metricForApiOperation(metricName, operation, props?)

public metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metric

Parameters

metricName string
operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser api operations..

metricInvocationsForApiOperation(operation, props?)

public metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser invocations.

metricLatencyForApiOperation(operation, props?)

public metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser latencies.

metricSessionDuration(props?)

public metricSessionDuration(props?: MetricOptions): Metric

Parameters

props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser session duration.

metricSystemErrorsForApiOperation(operation, props?)

public metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser system errors.

metricTakeOverCount(props?)

public metricTakeOverCount(props?: MetricOptions): Metric

Parameters

props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser user takeovers.

metricTakeOverDuration(props?)

public metricTakeOverDuration(props?: MetricOptions): Metric

Parameters

props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser user takeovers duration.

metricTakeOverReleaseCount(props?)

public metricTakeOverReleaseCount(props?: MetricOptions): Metric

Parameters

props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser user takeovers released.

metricThrottlesForApiOperation(operation, props?)

public metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser throttles.

metricUserErrorsForApiOperation(operation, props?)

public metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metric

Parameters

operation string
props MetricOptions — - Configuration options for the metric.

Returns

Metric

Creates a CloudWatch metric for tracking browser user errors.

toString()

public toString(): string

Returns

string

Returns a string representation of this construct.

with(...mixins)

public with(...mixins: IMixin[]): IConstruct

Parameters

mixins IMixin

Returns

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.

static fromBrowserCustomAttributes(scope, id, attrs)

public static fromBrowserCustomAttributes(scope: Construct, id: string, attrs: BrowserCustomAttributes): IBrowserCustom

Parameters

scope Construct — - The construct scope.
id string — - Identifier of the construct.
attrs BrowserCustomAttributes — - Attributes of the existing browser custom.

Returns

IBrowserCustom

Creates an Browser Custom reference from an existing browser's attributes.