class BrowserCustomBase
| Language | Type name |
|---|---|
.NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.BrowserCustomBase |
Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#BrowserCustomBase |
Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.BrowserCustomBase |
Python | aws_cdk.aws_bedrock_agentcore_alpha.BrowserCustomBase |
TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » BrowserCustomBase |
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Implements
IConstruct, IDependable, IResource, IEnvironment, IBrowser, IGrantable, IConnectable, IBrowser
Extends
Resource
Implemented by
Browser
Abstract base class for a Browser.
Contains methods and attributes valid for Browsers either created with CDK or imported.
Initializer
new BrowserCustomBase(scope: Construct, id: string, props?: ResourceProps)
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- scope
Construct - id
string - props
ResourceProps
Properties
| Name | Type | Description |
|---|---|---|
| browser | string | The ARN of the browser resource. |
| browser | Browser | A reference to a BrowserCustom resource. |
| browser | 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 | Resource | The environment this resource belongs to. |
| execution | IRole | The IAM role that provides permissions for the browser to access AWS services. |
| grant | IPrincipal | The principal to grant permissions to. |
| node | Node | The tree node. |
| stack | Stack | The stack in which this resource is defined. |
| created | string | Timestamp when the browser was created. |
| last | string | Timestamp when the browser was last updated. |
| status? | string | The status of the browser. |
browserArn
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
The ARN of the browser resource.
browserCustomRef
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Browser
A reference to a BrowserCustom resource.
browserId
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
The id of the browser.
connections
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Connections
An accessor for the Connections object that will fail if this Browser does not have a VPC configured.
env
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Resource
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
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
IRole
The IAM role that provides permissions for the browser to access AWS services.
grantPrincipal
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
IPrincipal
The principal to grant permissions to.
node
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Node
The tree node.
stack
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
Stack
The stack in which this resource is defined.
createdAt?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
Timestamp when the browser was created.
lastUpdatedAt?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
Timestamp when the browser was last updated.
status?
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Type:
string
(optional)
The status of the browser.
Methods
| Name | Description |
|---|---|
| apply | Override the cross-stack reference strength for this resource. |
| apply | Apply the given removal policy to this resource. |
| grant(grantee, ...actions) | Grants IAM actions to the IAM Principal. |
| grant | Grant read permissions on this browser to an IAM principal. |
| grant | Grant invoke permissions on this browser to an IAM principal. |
| metric(metricName, dimensions, props?) | Return the given named metric for this browser. |
| metric | Creates a CloudWatch metric for tracking browser errors. |
| metric | Creates a CloudWatch metric for tracking browser api operations.. |
| metric | Creates a CloudWatch metric for tracking browser invocations. |
| metric | Creates a CloudWatch metric for tracking browser latencies. |
| metric | Creates a CloudWatch metric for tracking browser session duration. |
| metric | Creates a CloudWatch metric for tracking browser system errors. |
| metric | Creates a CloudWatch metric for tracking browser user takeovers. |
| metric | Creates a CloudWatch metric for tracking browser user takeovers duration. |
| metric | Creates a CloudWatch metric for tracking browser user takeovers released. |
| metric | Creates a CloudWatch metric for tracking browser throttles. |
| metric | Creates a CloudWatch metric for tracking browser user errors. |
| to | Returns a string representation of this construct. |
| with(...mixins) | Applies one or more mixins to this construct. |
applyCrossStackReferenceStrength(strength)
public applyCrossStackReferenceStrength(strength: ReferenceStrength): void
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- strength
Reference— - The reference strength to use for this resource.Strength
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.
applyRemovalPolicy(policy)
public applyRemovalPolicy(policy: RemovalPolicy): void
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
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
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable— - The IAM principal to grant permissions to. - actions
string— - The actions to grant.
Returns
Grants IAM actions to the IAM Principal.
[disable-awslint:no-grants]
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
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.
[disable-awslint:no-grants]
grantUse(grantee)
public grantUse(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable— - The IAM principal to grant invoke permissions to.
Returns
Grant invoke permissions on this browser to an IAM principal.
[disable-awslint:no-grants]
metric(metricName, dimensions, props?)
public metric(metricName: string, dimensions: { [string]: string }, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
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
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser errors.
metricForApiOperation(metricName, operation, props?)
public metricForApiOperation(metricName: string, operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- metricName
string - operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser api operations..
metricInvocationsForApiOperation(operation, props?)
public metricInvocationsForApiOperation(operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser invocations.
metricLatencyForApiOperation(operation, props?)
public metricLatencyForApiOperation(operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser latencies.
metricSessionDuration(props?)
public metricSessionDuration(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser session duration.
metricSystemErrorsForApiOperation(operation, props?)
public metricSystemErrorsForApiOperation(operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser system errors.
metricTakeOverCount(props?)
public metricTakeOverCount(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser user takeovers.
metricTakeOverDuration(props?)
public metricTakeOverDuration(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser user takeovers duration.
metricTakeOverReleaseCount(props?)
public metricTakeOverReleaseCount(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser user takeovers released.
metricThrottlesForApiOperation(operation, props?)
public metricThrottlesForApiOperation(operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser throttles.
metricUserErrorsForApiOperation(operation, props?)
public metricUserErrorsForApiOperation(operation: string, props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- operation
string - props
Metric— - Configuration options for the metric.Options
Returns
Creates a CloudWatch metric for tracking browser user errors.
toString()
public toString(): string
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Returns
string
Returns a string representation of this construct.
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- mixins
IMixin
Returns
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.

.NET
Go
Java
Python
TypeScript (