2.221.0

interface IBrowserCustom 🔹

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

Implemented by BrowserCustom

Obtainable from BrowserCustom.fromBrowserCustomAttributes()

Interface for Browser resources.

Properties

NameTypeDescription
browserArn🔹stringThe ARN of the browser resource.
browserId🔹stringThe id of the browser.
connections🔹ConnectionsThe network connections associated with this resource.
env🔹ResourceEnvironmentThe environment this resource belongs to.
executionRole🔹IRoleThe IAM role that provides permissions for the browser to access AWS services.
grantPrincipal🔹IPrincipalThe principal to grant permissions to.
node🔹NodeThe tree node.
stack🔹StackThe stack in which this resource is defined.
createdAt?🔹stringTimestamp when the browser was created.
lastUpdatedAt?🔹stringTimestamp when the browser was last updated.
status?🔹stringThe status of the browser.

browserArn🔹

Type: string

The ARN of the browser resource.

browserId🔹

Type: string

The id of the browser.

connections🔹

Type: Connections

The network connections associated with this resource.

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 that provides permissions for the browser to access AWS services.

grantPrincipal🔹

Type: IPrincipal

The principal to grant permissions to.

node🔹

Type: Node

The tree node.

stack🔹

Type: Stack

The stack in which this resource is defined.

createdAt?🔹

Type: string (optional)

Timestamp when the browser was created.

lastUpdatedAt?🔹

Type: string (optional)

Timestamp when the browser was last updated.

status?🔹

Type: string (optional)

The status of the browser.

Methods

NameDescription
applyRemovalPolicy(policy)🔹Apply the given removal policy to this resource.
grant(grantee, ...actions)🔹Grants IAM actions to the IAM Principal.
grantRead(grantee)🔹Grants Get and List actions on the Browser.
grantUse(grantee)🔹Grants Invoke, Start, and Update actions on the Browser.
metric(metricName, dimensions, props?)🔹Return the given named metric for this browser.
metricErrorsForApiOperation(operation, props?)🔹Return a metric containing the number of errors for a specific API operation performed on this browser.
metricForApiOperation(metricName, operation, props?)🔹Return the given named metric related to the API operation performed on this browser.
metricInvocationsForApiOperation(operation, props?)🔹Return a metric containing the total number of API requests made for a specific browser operation.
metricLatencyForApiOperation(operation, props?)🔹Return a metric measuring the latency of a specific API operation performed on this browser.
metricSessionDuration(props?)🔹Return a metric measuring the duration of browser sessions.
metricSystemErrorsForApiOperation(operation, props?)🔹Return a metric containing the number of system errors for a specific API operation performed on this browser.
metricTakeOverCount(props?)🔹Return a metric containing the number of user takeovers.
metricTakeOverDuration(props?)🔹Return a metric measuring the duration of user takeovers.
metricTakeOverReleaseCount(props?)🔹Return a metric containing the number of user takeovers released.
metricThrottlesForApiOperation(operation, props?)🔹Return a metric containing the number of throttled requests for a specific API operation performed on this browser.
metricUserErrorsForApiOperation(operation, props?)🔹Return a metric containing the number of user errors for a specific API operation performed on this browser.

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

Returns

Grants IAM actions to the IAM Principal.

grantRead(grantee)🔹

public grantRead(grantee: IGrantable): Grant

Parameters

Returns

Grants Get and List actions on the Browser.

grantUse(grantee)🔹

public grantUse(grantee: IGrantable): Grant

Parameters

Returns

Grants Invoke, Start, and Update actions on the Browser.

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.

metricErrorsForApiOperation(operation, props?)🔹

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

Parameters

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

Parameters

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

Parameters

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

Parameters

Returns

Return a metric measuring the latency of a specific API operation performed on this browser.

metricSessionDuration(props?)🔹

public metricSessionDuration(props?: MetricOptions): Metric

Parameters

Returns

Return a metric measuring the duration of browser sessions.

metricSystemErrorsForApiOperation(operation, props?)🔹

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

Parameters

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

Parameters

Returns

Return a metric containing the number of user takeovers.

metricTakeOverDuration(props?)🔹

public metricTakeOverDuration(props?: MetricOptions): Metric

Parameters

Returns

Return a metric measuring the duration of user takeovers.

metricTakeOverReleaseCount(props?)🔹

public metricTakeOverReleaseCount(props?: MetricOptions): Metric

Parameters

Returns

Return a metric containing the number of user takeovers released.

metricThrottlesForApiOperation(operation, props?)🔹

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

Parameters

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

Parameters

Returns

Return a metric containing the number of user errors for a specific API operation performed on this browser.

← PreviousNext →