2.221.0

class BrowserCustom (construct) 🔹

LanguageType name
.NETAmazon.CDK.AWS.Bedrock.Agentcore.Alpha.BrowserCustom
Gogithub.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#BrowserCustom
Javasoftware.amazon.awscdk.services.bedrock.agentcore.alpha.BrowserCustom
Pythonaws_cdk.aws_bedrock_agentcore_alpha.BrowserCustom
TypeScript (source)@aws-cdk/aws-bedrock-agentcore-alpha » BrowserCustom

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

Browser resource for AWS Bedrock Agent Core.

Provides a browser environment for web automation and interaction.

See also: https://docs.aws.amazon.com/bedrock-agentcore/latest/devguide/browser.html

Example

// Create a custom execution role
const executionRole = new iam.Role(this, "BrowserExecutionRole", {
  assumedBy: new iam.ServicePrincipal("bedrock-agentcore.amazonaws.com"),
  managedPolicies: [
    iam.ManagedPolicy.fromAwsManagedPolicyName("AmazonBedrockAgentCoreBrowserExecutionRolePolicy"),
  ],
});

// Create browser with custom execution role
const browser = new agentcore.BrowserCustom(this, "MyBrowser", {
  browserCustomName: "my_browser",
  description: "Browser with custom execution role",
  networkConfiguration: agentcore.BrowserNetworkConfiguration.usingPublicNetwork(),
  executionRole: executionRole,
});

Initializer

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

Parameters

Construct Props

NameTypeDescription
browserCustomName🔹stringThe name of the browser 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}.
description?🔹stringOptional 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?🔹IRoleThe IAM role that provides permissions for the browser to access AWS services.
networkConfiguration?🔹BrowserNetworkConfigurationNetwork configuration for browser.
recordingConfig?🔹RecordingConfigRecording 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

The name of the browser 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}.

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

NameTypeDescription
browserArn🔹stringThe ARN of the browser resource.
browserId🔹stringThe id of the browser.
connections🔹ConnectionsAn accessor for the Connections object that will fail if this Browser does not have a VPC configured.
env🔹ResourceEnvironmentThe environment this resource belongs to.
executionRole🔹IRoleThe IAM role associated to the browser.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
name🔹stringThe name of the browser.
networkConfiguration🔹BrowserNetworkConfigurationThe network configuration of the browser.
node🔹NodeThe tree node.
stack🔹StackThe stack in which this resource is defined.
createdAt?🔹stringThe created timestamp of the browser.
description?🔹stringThe description of the browser.
failureReason?🔹stringThe failure reason of the browser.
lastUpdatedAt?🔹stringThe last updated timestamp of the browser.
recordingConfig?🔹RecordingConfigThe recording configuration of the browser.
status?🔹stringThe 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🔹stringUniquely identifies this class.

browserArn🔹

Type: string

The ARN of the browser 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 by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that 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.

name🔹

Type: string

The name of the browser.

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.

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

NameDescription
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, dimensions, 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.
static fromBrowserCustomAttributes(scope, id, attrs)🔹Creates an Browser Custom reference from an existing browser's attributes.

applyRemovalPolicy(policy)🔹

public applyRemovalPolicy(policy: RemovalPolicy): void

Parameters

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

Grants IAM actions to the IAM Principal.

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

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

Returns

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.

grantUse(grantee)🔹

public grantUse(grantee: IGrantable): Grant

Parameters

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

Returns

Grant invoke permissions on this browser to an IAM principal.

metric(metricName, dimensions, props?)🔹

public metric(metricName: string, dimensions: { [string]: string }, props?: MetricOptions): Metric

Parameters

  • metricName string
  • dimensions { [string]: string }
  • props MetricOptions

Returns

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

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

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

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

Creates a CloudWatch metric for tracking browser latencies.

metricSessionDuration(props?)🔹

public metricSessionDuration(props?: MetricOptions): Metric

Parameters

  • props MetricOptions — - Configuration options for the metric.

Returns

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

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

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

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

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

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

Creates a CloudWatch metric for tracking browser user errors.

toString()🔹

public toString(): string

Returns

  • string

Returns a string representation of this construct.

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

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

← PreviousNext →