Class: AWSCDK::BedrockAgentCore::CfnBrowserCustom

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSBedrockagentcore::IBrowserCustomRef
Defined in:
bedrock_agent_core/cfn_browser_custom.rb

Overview

AgentCore Browser tool provides a fast, secure, cloud-based browser runtime to enable AI agents to interact with websites at scale.

For more information about using the custom browser, see Interact with web applications using Amazon Bedrock AgentCore Browser .

See the Properties section below for descriptions of both the required and optional properties.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnBrowserCustom

Create a new AWS::BedrockAgentCore::BrowserCustom.

Parameters:

  • scope (Constructs::Construct)

    Scope in which this resource is defined.

  • id (String)

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::BedrockAgentCore::CfnBrowserCustomProps)

    Resource properties.



22
23
24
25
26
27
28
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 22

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnBrowserCustomProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5Ccm93c2VyQ3VzdG9tUHJvcHMifQ==")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_browser_custom(resource) ⇒ String

Parameters:

Returns:

  • (String)


89
90
91
92
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 89

def self.arn_for_browser_custom(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrYWdlbnRjb3JlLklCcm93c2VyQ3VzdG9tUmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnBrowserCustom", "arnForBrowserCustom", [resource])
end

.CFN_RESOURCE_TYPE_NAMEString

The CloudFormation resource type name for this resource class.

Returns:

  • (String)


222
223
224
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 222

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

.from_browser_custom_arn(scope, id, arn) ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::IBrowserCustomRef

Creates a new IBrowserCustomRef from an ARN.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • arn (String)

Returns:



100
101
102
103
104
105
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 100

def self.from_browser_custom_arn(scope, id, arn)
  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(arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "arn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnBrowserCustom", "fromBrowserCustomArn", [scope, id, arn])
end

.from_browser_id(scope, id, browser_id) ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::IBrowserCustomRef

Creates a new IBrowserCustomRef from a browserId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • browser_id (String)

Returns:



113
114
115
116
117
118
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 113

def self.from_browser_id(scope, id, browser_id)
  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(browser_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "browserId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnBrowserCustom", "fromBrowserId", [scope, id, browser_id])
end

.is_cfn_browser_custom(x) ⇒ Boolean

Checks whether the given object is a CfnBrowserCustom.

Parameters:

  • x (Object)

Returns:

  • (Boolean)


124
125
126
127
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 124

def self.is_cfn_browser_custom(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnBrowserCustom", "isCfnBrowserCustom", [x])
end

.jsii_overridable_methodsObject



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
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 30

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_browser_arn => { kind: :property, name: "attrBrowserArn", is_optional: false },
    :attr_browser_id => { kind: :property, name: "attrBrowserId", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_failure_reason => { kind: :property, name: "attrFailureReason", is_optional: false },
    :attr_last_updated_at => { kind: :property, name: "attrLastUpdatedAt", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :browser_custom_ref => { kind: :property, name: "browserCustomRef", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :network_configuration => { kind: :property, name: "networkConfiguration", is_optional: false },
    :browser_signing => { kind: :property, name: "browserSigning", is_optional: true },
    :certificates => { kind: :property, name: "certificates", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enterprise_policies => { kind: :property, name: "enterprisePolicies", is_optional: true },
    :execution_role_arn => { kind: :property, name: "executionRoleArn", 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 },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", 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 },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String)

    The path of the value to delete.



429
430
431
432
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 429

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.

Parameters:



441
442
443
444
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 441

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



451
452
453
454
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 451

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.



462
463
464
465
466
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 462

def (key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override or prefix path with "Properties." (i.e. Properties.TopicName).

If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.

To include a literal . in the property name, prefix with a \. In most programming languages you will need to write this as "\\." because the \ itself will need to be escaped.

For example,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override will not be processed or translated in any way. Pass raw JSON values in here with the correct capitalization for CloudFormation. If you pass CDK classes or structs, they will be rendered with lowercased key names, and CloudFormation will reject the template.

Parameters:

  • path (String)
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object)
    • The value.


519
520
521
522
523
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 519

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String)

    The path to the property.



529
530
531
532
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 529

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String)

    The path of the property.

  • value (Object)

    The value.



541
542
543
544
545
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 541

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



554
555
556
557
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 554

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 = nil, options = nil) ⇒ void

This method returns an undefined value.

Sets the deletion policy of the resource based on the removal policy specified.

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). In some cases, a snapshot can be taken of the resource prior to deletion (RemovalPolicy.SNAPSHOT). A list of resources that support this policy can be found in the following link:



576
577
578
579
580
581
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 576

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_browser_arnString

The ARN for the custom browser.

Returns:

  • (String)


229
230
231
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 229

def attr_browser_arn()
  jsii_get_property("attrBrowserArn")
end

#attr_browser_idString

The ID for the custom browser.

Returns:

  • (String)


236
237
238
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 236

def attr_browser_id()
  jsii_get_property("attrBrowserId")
end

#attr_created_atString

The time at which the custom browser was created.

Returns:

  • (String)


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

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_failure_reasonString

The reason for failure if the browser creation or operation failed.

Returns:

  • (String)


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

def attr_failure_reason()
  jsii_get_property("attrFailureReason")
end

#attr_last_updated_atString

The time at which the custom browser was last updated.

Returns:

  • (String)


257
258
259
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 257

def attr_last_updated_at()
  jsii_get_property("attrLastUpdatedAt")
end

#attr_statusString

The status of the custom browser.

Returns:

  • (String)


264
265
266
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 264

def attr_status()
  jsii_get_property("attrStatus")
end

#browser_custom_refAWSCDK::Interfaces::AWSBedrockagentcore::BrowserCustomReference

A reference to a BrowserCustom resource.



271
272
273
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 271

def browser_custom_ref()
  jsii_get_property("browserCustomRef")
end

#browser_signingAWSCDK::IResolvable, ...

Browser signing configuration.



310
311
312
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 310

def browser_signing()
  jsii_get_property("browserSigning")
end

#browser_signing=(value) ⇒ Object



314
315
316
317
318
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 314

def browser_signing=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnBrowserCustom::BrowserSigningProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkJyb3dzZXJDdXN0b20uQnJvd3NlclNpZ25pbmdQcm9wZXJ0eSJ9XX19")), "browserSigning") unless value.nil?
  jsii_set_property("browserSigning", value)
end

#cdk_tag_managerAWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



278
279
280
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 278

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#certificatesAWSCDK::IResolvable, ...

List of root CA certificates.



323
324
325
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 323

def certificates()
  jsii_get_property("certificates")
end

#certificates=(value) ⇒ Object



327
328
329
330
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 327

def certificates=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5Ccm93c2VyQ3VzdG9tLkNlcnRpZmljYXRlUHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "certificates") unless value.nil?
  jsii_set_property("certificates", value)
end

#cfn_optionsAWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.



175
176
177
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 175

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_propertiesHash{String => Object}

Returns:

  • (Hash{String => Object})


180
181
182
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 180

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil)


585
586
587
588
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 585

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_namesHash{String => String}

Returns:

  • (Hash{String => String})


185
186
187
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 185

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_typeString

AWS resource type.

Returns:

  • (String)


192
193
194
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 192

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stackArray<String>

Returns:

  • (Array<String>)


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

def creation_stack()
  jsii_get_property("creationStack")
end

#descriptionString?

The custom browser.

Returns:

  • (String, nil)


335
336
337
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 335

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object



339
340
341
342
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 339

def description=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless value.nil?
  jsii_set_property("description", value)
end

#enterprise_policiesAWSCDK::IResolvable, ...

List of browser enterprise policies.



347
348
349
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 347

def enterprise_policies()
  jsii_get_property("enterprisePolicies")
end

#enterprise_policies=(value) ⇒ Object



351
352
353
354
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 351

def enterprise_policies=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImNvbGxlY3Rpb24iOnsiZWxlbWVudHR5cGUiOnsidW5pb24iOnsidHlwZXMiOlt7ImZxbiI6ImF3cy1jZGstbGliLklSZXNvbHZhYmxlIn0seyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYmVkcm9ja2FnZW50Y29yZS5DZm5Ccm93c2VyQ3VzdG9tLkJyb3dzZXJFbnRlcnByaXNlUG9saWN5UHJvcGVydHkifV19fSwia2luZCI6ImFycmF5In19XX19")), "enterprisePolicies") unless value.nil?
  jsii_set_property("enterprisePolicies", value)
end

#envAWSCDK::Interfaces::ResourceEnvironment



197
198
199
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 197

def env()
  jsii_get_property("env")
end

#execution_role_arnString?

The Amazon Resource Name (ARN) of the execution role.

Returns:

  • (String, nil)


359
360
361
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 359

def execution_role_arn()
  jsii_get_property("executionRoleArn")
end

#execution_role_arn=(value) ⇒ Object



363
364
365
366
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 363

def execution_role_arn=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "executionRoleArn") unless value.nil?
  jsii_set_property("executionRoleArn", value)
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

Returns a token for an runtime attribute of this resource.

Ideally, use generated attribute accessors (e.g. resource.arn), but this can be used for future compatibility in case there is no generated attribute.

Parameters:

Returns:



598
599
600
601
602
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 598

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.



609
610
611
612
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 609

def (key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



679
680
681
682
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 679

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_idString

The logical ID for this CloudFormation stack element.

The logical ID of the element is calculated from the path of the resource node in the construct tree.

To override this value, use override_logical_id(new_logical_id).

Returns:

  • (String)


149
150
151
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 149

def logical_id()
  jsii_get_property("logicalId")
end

#nameString

The name of the custom browser.

Returns:

  • (String)


285
286
287
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 285

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object



289
290
291
292
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 289

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#network_configurationAWSCDK::IResolvable, AWSCDK::BedrockAgentCore::CfnBrowserCustom::BrowserNetworkConfigurationProperty

The network configuration for a code interpreter.



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

def network_configuration()
  jsii_get_property("networkConfiguration")
end

#network_configuration=(value) ⇒ Object



301
302
303
304
305
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 301

def network_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnBrowserCustom::BrowserNetworkConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkJyb3dzZXJDdXN0b20uQnJvd3Nlck5ldHdvcmtDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "networkConfiguration")
  jsii_set_property("networkConfiguration", value)
end

#nodeConstructs::Node

The tree node.

Returns:

  • (Constructs::Node)


132
133
134
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 132

def node()
  jsii_get_property("node")
end

#obtain_dependenciesArray<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



620
621
622
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 620

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependenciesArray<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



627
628
629
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 627

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String)

    The new logical ID to use for this stack element.



420
421
422
423
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 420

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#recording_configAWSCDK::IResolvable, ...

THe custom browser configuration.



371
372
373
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 371

def recording_config()
  jsii_get_property("recordingConfig")
end

#recording_config=(value) ⇒ Object



375
376
377
378
379
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 375

def recording_config=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnBrowserCustom::RecordingConfigProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkJyb3dzZXJDdXN0b20uUmVjb3JkaW5nQ29uZmlnUHJvcGVydHkifV19fQ==")), "recordingConfig") unless value.nil?
  jsii_set_property("recordingConfig", value)
end

#refString

Return a string that will be resolved to a CloudFormation { Ref } for this element.

If, by any chance, the intrinsic reference of a resource is not a string, you could coerce it to an IResolvable through Lazy.any({ produce: resource.ref }).

Returns:

  • (String)


168
169
170
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 168

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

Indicates that this resource no longer depends on another resource.

This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.

Parameters:



638
639
640
641
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 638

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object})


645
646
647
648
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 645

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



655
656
657
658
659
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 655

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#should_synthesizeBoolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean)

    true if the resource should be included or false is the resource should be omitted.



664
665
666
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 664

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stackAWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tagsHash{String => String}?

The tags for the custom browser.

Returns:

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


384
385
386
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 384

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object



388
389
390
391
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 388

def tags=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoibWFwIn19")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_stringString

Returns a string representation of this construct.

Returns:

  • (String)

    a string representation of this resource



396
397
398
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 396

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

#updated_properitesHash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object})


205
206
207
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 205

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_propertiesHash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object})


215
216
217
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 215

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object)


670
671
672
673
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 670

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
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)


409
410
411
412
413
414
# File 'bedrock_agent_core/cfn_browser_custom.rb', line 409

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