interface IBrowserCustom
| Language | Type name |
|---|---|
 .NET | Amazon.CDK.AWS.Bedrock.Agentcore.Alpha.IBrowserCustom |
 Go | github.com/aws/aws-cdk-go/awsbedrockagentcorealpha/v2#IBrowserCustom |
 Java | software.amazon.awscdk.services.bedrock.agentcore.alpha.IBrowserCustom |
 Python | aws_cdk.aws_bedrock_agentcore_alpha.IBrowserCustom |
 TypeScript (source) | @aws-cdk/aws-bedrock-agentcore-alpha » IBrowserCustom |
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Implements
IDependable, IConstruct, IEnvironment, IResource, IGrantable, IConnectable, IBrowser
Implemented by
Browser
Obtainable from
Browser.fromBrowserCustomAttributes()
Interface for Browser resources.
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 | The network connections associated with this resource. |
| 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
The network connections associated with this resource.
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 | Apply the given removal policy to this resource. |
| grant(grantee, ...actions) | Grants IAM actions to the IAM Principal. |
| grant | Grants Get and List actions on the Browser. |
| grant | Grants Invoke, Start, and Update actions on the Browser. |
| metric(metricName, dimensions, props?) | Return the given named metric for this browser. |
| metric | Return a metric containing the number of errors for a specific API operation performed on this browser. |
| metric | Return the given named metric related to the API operation performed on this browser. |
| metric | Return a metric containing the total number of API requests made for a specific browser operation. |
| metric | Return a metric measuring the latency of a specific API operation performed on this browser. |
| metric | Return a metric measuring the duration of browser sessions. |
| metric | Return a metric containing the number of system errors for a specific API operation performed on this browser. |
| metric | Return a metric containing the number of user takeovers. |
| metric | Return a metric measuring the duration of user takeovers. |
| metric | Return a metric containing the number of user takeovers released. |
| metric | Return a metric containing the number of throttled requests for a specific API operation performed on this browser. |
| metric | Return a metric containing the number of user errors for a specific API operation performed on this browser. |
| with(...mixins) | Applies one or more mixins to this construct. |
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 - actions
string
Returns
Grants IAM actions to the IAM Principal.
grantRead(grantee)
public grantRead(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable
Returns
Grants Get and List actions on the Browser.
grantUse(grantee)
public grantUse(grantee: IGrantable): Grant
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- grantee
IGrantable
Returns
Grants Invoke, Start, and Update actions on the Browser.
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.
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
MetricOptions
Returns
Return a metric containing the number of errors for a specific API operation performed on this browser.
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
MetricOptions
Returns
Return the given named metric related to the API operation performed on this browser.
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
MetricOptions
Returns
Return a metric containing the total number of API requests made for a specific browser operation.
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
MetricOptions
Returns
Return a metric measuring the latency of a specific API operation performed on this browser.
metricSessionDuration(props?)
public metricSessionDuration(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
MetricOptions
Returns
Return a metric measuring the duration of browser sessions.
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
MetricOptions
Returns
Return a metric containing the number of system errors for a specific API operation performed on this browser.
metricTakeOverCount(props?)
public metricTakeOverCount(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
MetricOptions
Returns
Return a metric containing the number of user takeovers.
metricTakeOverDuration(props?)
public metricTakeOverDuration(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
MetricOptions
Returns
Return a metric measuring the duration of user takeovers.
metricTakeOverReleaseCount(props?)
public metricTakeOverReleaseCount(props?: MetricOptions): Metric
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- props
MetricOptions
Returns
Return a metric containing the number of 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
MetricOptions
Returns
Return a metric containing the number of throttled requests for a specific API operation performed on this browser.
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
MetricOptions
Returns
Return a metric containing the number of user errors for a specific API operation performed on this browser.
with(...mixins)
public with(...mixins: IMixin[]): IConstruct
⚠️ Deprecated: Use the equivalent construct from aws-cdk-lib/aws-bedrockagentcore instead.
Parameters
- mixins
IMixin— The mixins to apply.
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.