Class: AWSCDK::BedrockAgentCore::BrowserCustom

Inherits:
BrowserCustomBase
  • Object
show all
Defined in:
bedrock_agent_core/browser_custom.rb

Overview

Browser resource for AWS Bedrock Agent Core.

Provides a browser environment for web automation and interaction.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props = nil) ⇒ BrowserCustom

Returns a new instance of BrowserCustom.

Parameters:



15
16
17
18
19
20
21
 
# File 'bedrock_agent_core/browser_custom.rb', line 15

def initialize(scope, id, props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::BrowserCustomProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5Ccm93c2VyQ3VzdG9tUHJvcHMifQ==")), "props") unless props.nil?
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.from_browser_custom_attributes(scope, id, attrs) ⇒ AWSCDK::BedrockAgentCore::IBrowserCustom

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

Parameters:

Returns:



76
77
78
79
80
81
82
 
# File 'bedrock_agent_core/browser_custom.rb', line 76

def self.from_browser_custom_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::BrowserCustomAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5Ccm93c2VyQ3VzdG9tQXR0cmlidXRlcyJ9")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.BrowserCustom", "fromBrowserCustomAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
 
# File 'bedrock_agent_core/browser_custom.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :browser_arn => { kind: :property, name: "browserArn", is_optional: false },
    :browser_custom_ref => { kind: :property, name: "browserCustomRef", is_optional: false },
    :browser_id => { kind: :property, name: "browserId", is_optional: false },
    :connections => { kind: :property, name: "connections", is_optional: false },
    :execution_role => { kind: :property, name: "executionRole", is_optional: false },
    :grant_principal => { kind: :property, name: "grantPrincipal", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :last_updated_at => { kind: :property, name: "lastUpdatedAt", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :browser_custom_name => { kind: :property, name: "browserCustomName", is_optional: false },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: false },
    :browser_signing => { kind: :property, name: "browserSigning", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :failure_reason => { kind: :property, name: "failureReason", is_optional: true },
    :recording_config => { kind: :property, name: "recordingConfig", is_optional: true },
    :tags => { kind: :property, name: "tags", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
    :grant_use => { kind: :method, name: "grantUse", is_optional: false },
    :metric => { kind: :method, name: "metric", is_optional: false },
    :metric_errors_for_api_operation => { kind: :method, name: "metricErrorsForApiOperation", is_optional: false },
    :metric_for_api_operation => { kind: :method, name: "metricForApiOperation", is_optional: false },
    :metric_invocations_for_api_operation => { kind: :method, name: "metricInvocationsForApiOperation", is_optional: false },
    :metric_latency_for_api_operation => { kind: :method, name: "metricLatencyForApiOperation", is_optional: false },
    :metric_session_duration => { kind: :method, name: "metricSessionDuration", is_optional: false },
    :metric_system_errors_for_api_operation => { kind: :method, name: "metricSystemErrorsForApiOperation", is_optional: false },
    :metric_take_over_count => { kind: :method, name: "metricTakeOverCount", is_optional: false },
    :metric_take_over_duration => { kind: :method, name: "metricTakeOverDuration", is_optional: false },
    :metric_take_over_release_count => { kind: :method, name: "metricTakeOverReleaseCount", is_optional: false },
    :metric_throttles_for_api_operation => { kind: :method, name: "metricThrottlesForApiOperation", is_optional: false },
    :metric_user_errors_for_api_operation => { kind: :method, name: "metricUserErrorsForApiOperation", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


193
194
195
 
# File 'bedrock_agent_core/browser_custom.rb', line 193

def self.PROPERTY_INJECTION_ID()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_bedrockagentcore.BrowserCustom", "PROPERTY_INJECTION_ID")
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

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.

Parameters:



280
281
282
283
 
# File 'bedrock_agent_core/browser_custom.rb', line 280

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

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

Parameters:



297
298
299
300
 
# File 'bedrock_agent_core/browser_custom.rb', line 297

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
end

#browser_arn ⇒ String

The ARN of the browser resource.

Returns:

  • (String) 


130
131
132
 
# File 'bedrock_agent_core/browser_custom.rb', line 130

def browser_arn()
  jsii_get_property("browserArn")
end

#browser_custom_name ⇒ String

The name of the browser custom tool.

Returns:

  • (String) 


200
201
202
 
# File 'bedrock_agent_core/browser_custom.rb', line 200

def browser_custom_name()
  jsii_get_property("browserCustomName")
end

#browser_custom_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::BrowserCustomReference

A reference to a BrowserCustom resource.

Returns:



137
138
139
 
# File 'bedrock_agent_core/browser_custom.rb', line 137

def browser_custom_ref()
  jsii_get_property("browserCustomRef")
end

#browser_id ⇒ String

The id of the browser.

Returns:

  • (String) 


144
145
146
 
# File 'bedrock_agent_core/browser_custom.rb', line 144

def browser_id()
  jsii_get_property("browserId")
end

#browser_signing ⇒ AWSCDK::BedrockAgentCore::BrowserSigning?

The browser signing configuration of the browser.

Returns:



214
215
216
 
# File 'bedrock_agent_core/browser_custom.rb', line 214

def browser_signing()
  jsii_get_property("browserSigning")
end

#connections ⇒ AWSCDK::EC2::Connections

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

Returns:



151
152
153
 
# File 'bedrock_agent_core/browser_custom.rb', line 151

def connections()
  jsii_get_property("connections")
end

#created_at ⇒ String?

The created timestamp of the browser.

Returns:

  • (String, nil) 


172
173
174
 
# File 'bedrock_agent_core/browser_custom.rb', line 172

def created_at()
  jsii_get_property("createdAt")
end

#description ⇒ String?

The description of the browser.

Returns:

  • (String, nil) 


221
222
223
 
# File 'bedrock_agent_core/browser_custom.rb', line 221

def description()
  jsii_get_property("description")
end

#env ⇒ AWSCDK::Interfaces::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.

Returns:



102
103
104
 
# File 'bedrock_agent_core/browser_custom.rb', line 102

def env()
  jsii_get_property("env")
end

#execution_role ⇒ AWSCDK::IAM::IRole

The IAM role associated to the browser.

Returns:



158
159
160
 
# File 'bedrock_agent_core/browser_custom.rb', line 158

def execution_role()
  jsii_get_property("executionRole")
end

#failure_reason ⇒ String?

The failure reason of the browser.

Returns:

  • (String, nil) 


228
229
230
 
# File 'bedrock_agent_core/browser_custom.rb', line 228

def failure_reason()
  jsii_get_property("failureReason")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


303
304
305
 
# File 'bedrock_agent_core/browser_custom.rb', line 303

def generate_physical_name()
  jsii_call_method("generatePhysicalName", [])
end

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "ARN" attribute (e.g. bucket.bucketArn).

Normally, this token will resolve to arn_attr, but if the resource is referenced across environments, arn_components will be used to synthesize a concrete ARN with the resource's physical name. Make sure to reference this.physicalName in arn_components.

Parameters:

  • arn_attr (String) —

    The CFN attribute which resolves to the ARN of the resource.

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


317
318
319
320
321
322
 
# File 'bedrock_agent_core/browser_custom.rb', line 317

def get_resource_arn_attribute(arn_attr, arn_components)
  Jsii::Type.check_type(arn_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arnAttr")
  arn_components = arn_components.is_a?(Hash) ? ::AWSCDK::ARNComponents.new(**arn_components.transform_keys(&:to_sym)) : arn_components
  Jsii::Type.check_type(arn_components, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5Bcm5Db21wb25lbnRzIn0=")), "arnComponents")
  jsii_call_method("getResourceArnAttribute", [arn_attr, arn_components])
end

#get_resource_name_attribute(name_attr) ⇒ String

Returns an environment-sensitive token that should be used for the resource's "name" attribute (e.g. bucket.bucketName).

Normally, this token will resolve to name_attr, but if the resource is referenced across environments, it will be resolved to this.physicalName, which will be a concrete name.

Parameters:

  • name_attr (String) —

    The CFN attribute which resolves to the resource's name.

Returns:

  • (String) 


332
333
334
335
 
# File 'bedrock_agent_core/browser_custom.rb', line 332

def get_resource_name_attribute(name_attr)
  Jsii::Type.check_type(name_attr, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "nameAttr")
  jsii_call_method("getResourceNameAttribute", [name_attr])
end

#grant(grantee, *actions) ⇒ AWSCDK::IAM::Grant

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —
    • The IAM principal to grant permissions to.
  • actions (Array<String>) —
    • The actions to grant.

Returns:



344
345
346
347
348
349
350
 
# File 'bedrock_agent_core/browser_custom.rb', line 344

def grant(grantee, *actions)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  actions.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "actions[#{index}]")
  end
  jsii_call_method("grant", [grantee, *actions])
end

#grant_principal ⇒ AWSCDK::IAM::IPrincipal

The principal to grant permissions to.

Returns:



165
166
167
 
# File 'bedrock_agent_core/browser_custom.rb', line 165

def grant_principal()
  jsii_get_property("grantPrincipal")
end

#grant_read(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:GetBrowser', 'bedrock-agentcore:GetBrowserSession'] on this.browserArn - actions: ['bedrock-agentcore:ListBrowsers', 'bedrock-agentcore:ListBrowserSessions'] on all resources (*)

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]

Parameters:

Returns:



361
362
363
364
 
# File 'bedrock_agent_core/browser_custom.rb', line 361

def grant_read(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantRead", [grantee])
end

#grant_use(grantee) ⇒ AWSCDK::IAM::Grant

Note:

Default: - Default grant configuration: - actions: ['bedrock-agentcore:StartBrowserSession', 'bedrock-agentcore:UpdateBrowserStream', 'bedrock-agentcore:StopBrowserSession'] - resourceArns: [this.browserArn]

Grant invoke permissions on this browser to an IAM principal.

[disable-awslint:no-grants]

Parameters:

Returns:



373
374
375
376
 
# File 'bedrock_agent_core/browser_custom.rb', line 373

def grant_use(grantee)
  Jsii::Type.check_type(grantee, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "grantee")
  jsii_call_method("grantUse", [grantee])
end

#last_updated_at ⇒ String?

The last updated timestamp of the browser.

Returns:

  • (String, nil) 


179
180
181
 
# File 'bedrock_agent_core/browser_custom.rb', line 179

def last_updated_at()
  jsii_get_property("lastUpdatedAt")
end

#metric(metric_name, props = nil) ⇒ AWSCDK::CloudWatch::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.

Parameters:

Returns:



386
387
388
389
390
391
 
# File 'bedrock_agent_core/browser_custom.rb', line 386

def metric(metric_name, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metric", [metric_name, props])
end

#metric_errors_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Errors

Creates a CloudWatch metric for tracking browser errors.

Parameters:

Returns:



399
400
401
402
403
404
 
# File 'bedrock_agent_core/browser_custom.rb', line 399

def metric_errors_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricErrorsForApiOperation", [operation, props])
end

#metric_for_api_operation(metric_name, operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: metricName - dimensionsMap: { BrowserId: this.browserId }

Creates a CloudWatch metric for tracking browser api operations..

Parameters:

Returns:



413
414
415
416
417
418
419
 
# File 'bedrock_agent_core/browser_custom.rb', line 413

def metric_for_api_operation(metric_name, operation, props = nil)
  Jsii::Type.check_type(metric_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "metricName")
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricForApiOperation", [metric_name, operation, props])
end

#metric_invocations_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Invocations

Creates a CloudWatch metric for tracking browser invocations.

Parameters:

Returns:



427
428
429
430
431
432
 
# File 'bedrock_agent_core/browser_custom.rb', line 427

def metric_invocations_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricInvocationsForApiOperation", [operation, props])
end

#metric_latency_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Latency

Creates a CloudWatch metric for tracking browser latencies.

Parameters:

Returns:



440
441
442
443
444
445
 
# File 'bedrock_agent_core/browser_custom.rb', line 440

def metric_latency_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricLatencyForApiOperation", [operation, props])
end

#metric_session_duration(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Duration

Creates a CloudWatch metric for tracking browser session duration.

Parameters:

Returns:



452
453
454
455
456
 
# File 'bedrock_agent_core/browser_custom.rb', line 452

def metric_session_duration(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSessionDuration", [props])
end

#metric_system_errors_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: SystemErrors

Creates a CloudWatch metric for tracking browser system errors.

Parameters:

Returns:



464
465
466
467
468
469
 
# File 'bedrock_agent_core/browser_custom.rb', line 464

def metric_system_errors_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricSystemErrorsForApiOperation", [operation, props])
end

#metric_take_over_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverCount

Creates a CloudWatch metric for tracking browser user takeovers.

Parameters:

Returns:



476
477
478
479
480
 
# File 'bedrock_agent_core/browser_custom.rb', line 476

def metric_take_over_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTakeOverCount", [props])
end

#metric_take_over_duration(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverDuration

Creates a CloudWatch metric for tracking browser user takeovers duration.

Parameters:

Returns:



487
488
489
490
491
 
# File 'bedrock_agent_core/browser_custom.rb', line 487

def metric_take_over_duration(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTakeOverDuration", [props])
end

#metric_take_over_release_count(props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: TakeOverReleaseCount

Creates a CloudWatch metric for tracking browser user takeovers released.

Parameters:

Returns:



498
499
500
501
502
 
# File 'bedrock_agent_core/browser_custom.rb', line 498

def metric_take_over_release_count(props = nil)
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricTakeOverReleaseCount", [props])
end

#metric_throttles_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: Throttles

Creates a CloudWatch metric for tracking browser throttles.

Parameters:

Returns:



510
511
512
513
514
515
 
# File 'bedrock_agent_core/browser_custom.rb', line 510

def metric_throttles_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricThrottlesForApiOperation", [operation, props])
end

#metric_user_errors_for_api_operation(operation, props = nil) ⇒ AWSCDK::CloudWatch::Metric

Note:

Default: - Default metric configuration: - namespace: 'AWS/Bedrock-AgentCore' - metricName: UserErrors

Creates a CloudWatch metric for tracking browser user errors.

Parameters:

Returns:



523
524
525
526
527
528
 
# File 'bedrock_agent_core/browser_custom.rb', line 523

def metric_user_errors_for_api_operation(operation, props = nil)
  Jsii::Type.check_type(operation, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "operation")
  props = props.is_a?(Hash) ? ::AWSCDK::CloudWatch::MetricOptions.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfY2xvdWR3YXRjaC5NZXRyaWNPcHRpb25zIn0=")), "props") unless props.nil?
  jsii_call_method("metricUserErrorsForApiOperation", [operation, props])
end

#network_configuration ⇒ AWSCDK::BedrockAgentCore::BrowserNetworkConfiguration

The network configuration of the browser.

Returns:



207
208
209
 
# File 'bedrock_agent_core/browser_custom.rb', line 207

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


87
88
89
 
# File 'bedrock_agent_core/browser_custom.rb', line 87

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

Returns a string-encoded token that resolves to the physical name that should be passed to the CloudFormation resource.

This value will resolve to one of the following:

  • a concrete value (e.g. "my-awesome-bucket")
  • undefined, when a name should be generated by CloudFormation
  • a concrete name generated automatically during synthesis, in cross-environment scenarios.

Returns:

  • (String) 


116
117
118
 
# File 'bedrock_agent_core/browser_custom.rb', line 116

def physical_name()
  jsii_get_property("physicalName")
end

#recording_config ⇒ AWSCDK::BedrockAgentCore::RecordingConfig?

The recording configuration of the browser.

Returns:



235
236
237
 
# File 'bedrock_agent_core/browser_custom.rb', line 235

def recording_config()
  jsii_get_property("recordingConfig")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



123
124
125
 
# File 'bedrock_agent_core/browser_custom.rb', line 123

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of the browser.

Returns:

  • (String, nil) 


186
187
188
 
# File 'bedrock_agent_core/browser_custom.rb', line 186

def status()
  jsii_get_property("status")
end

#tags ⇒ Hash{String => String}?

Note:

Default: - No tags applied

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

Returns:

  • (Hash{String => String}, nil) 


243
244
245
 
# File 'bedrock_agent_core/browser_custom.rb', line 243

def tags()
  jsii_get_property("tags")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


250
251
252
 
# File 'bedrock_agent_core/browser_custom.rb', line 250

def to_string()
  jsii_call_method("toString", [])
end

#with(*mixins) ⇒ Constructs::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.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


263
264
265
266
267
268
 
# File 'bedrock_agent_core/browser_custom.rb', line 263

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end