Class: AWSCDK::BedrockAgentCore::CfnGateway

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

Overview

Amazon Bedrock AgentCore Gateway provides a unified connectivity layer between agents and the tools and resources they need to interact with.

For more information about creating a gateway, see Set up an Amazon Bedrock AgentCore gateway .

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

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnGateway

Create a new AWS::BedrockAgentCore::Gateway.

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::CfnGatewayProps) —

    Resource properties.



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

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

Class Method Details

.arn_for_gateway(resource) ⇒ String

Parameters:

Returns:

  • (String) 


94
95
96
97
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 94

def self.arn_for_gateway(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19iZWRyb2NrYWdlbnRjb3JlLklHYXRld2F5UmVmIn0=")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_bedrockagentcore.CfnGateway", "arnForGateway", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


201
202
203
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 201

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

.is_cfn_gateway(x) ⇒ Boolean

Checks whether the given object is a CfnGateway.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


103
104
105
106
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 103

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

.jsii_overridable_methods ⇒ Object 



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
86
87
88
89
90
 
# File 'bedrock_agent_core/cfn_gateway.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_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_gateway_arn => { kind: :property, name: "attrGatewayArn", is_optional: false },
    :attr_gateway_identifier => { kind: :property, name: "attrGatewayIdentifier", is_optional: false },
    :attr_gateway_url => { kind: :property, name: "attrGatewayUrl", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_reasons => { kind: :property, name: "attrStatusReasons", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :attr_workload_identity_details => { kind: :property, name: "attrWorkloadIdentityDetails", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :gateway_ref => { kind: :property, name: "gatewayRef", is_optional: false },
    :authorizer_type => { kind: :property, name: "authorizerType", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :role_arn => { kind: :property, name: "roleArn", is_optional: false },
    :authorizer_configuration => { kind: :property, name: "authorizerConfiguration", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :exception_level => { kind: :property, name: "exceptionLevel", is_optional: true },
    :interceptor_configurations => { kind: :property, name: "interceptorConfigurations", is_optional: true },
    :kms_key_arn => { kind: :property, name: "kmsKeyArn", is_optional: true },
    :policy_engine_configuration => { kind: :property, name: "policyEngineConfiguration", is_optional: true },
    :protocol_configuration => { kind: :property, name: "protocolConfiguration", is_optional: true },
    :protocol_type => { kind: :property, name: "protocolType", 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.



446
447
448
449
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 446

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:



458
459
460
461
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 458

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:



468
469
470
471
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 468

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.

Parameters:

  • key (String)
  • value (Object)

See Also:



479
480
481
482
483
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 479

def add_metadata(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.


536
537
538
539
540
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 536

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.



546
547
548
549
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 546

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.



558
559
560
561
562
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 558

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:



571
572
573
574
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 571

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:

Parameters:

See Also:



593
594
595
596
597
598
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 593

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_created_at ⇒ String

The date and time at which the gateway was created.

Returns:

  • (String) 


208
209
210
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 208

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_gateway_arn ⇒ String

The ARN for the gateway.

Returns:

  • (String) 


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

def attr_gateway_arn()
  jsii_get_property("attrGatewayArn")
end

#attr_gateway_identifier ⇒ String

Returns:

  • (String) 


220
221
222
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 220

def attr_gateway_identifier()
  jsii_get_property("attrGatewayIdentifier")
end

#attr_gateway_url ⇒ String

The gateway URL for the gateway.

Returns:

  • (String) 


227
228
229
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 227

def attr_gateway_url()
  jsii_get_property("attrGatewayUrl")
end

#attr_status ⇒ String

The status for the gateway.

Returns:

  • (String) 


234
235
236
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 234

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_reasons ⇒ Array<String>

The status reasons for the gateway.

Returns:

  • (Array<String>) 


241
242
243
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 241

def attr_status_reasons()
  jsii_get_property("attrStatusReasons")
end

#attr_updated_at ⇒ String

Returns:

  • (String) 


246
247
248
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 246

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#attr_workload_identity_details ⇒ AWSCDK::IResolvable

Returns:



251
252
253
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 251

def attr_workload_identity_details()
  jsii_get_property("attrWorkloadIdentityDetails")
end

#authorizer_configuration ⇒ AWSCDK::IResolvable, ...

Returns:



304
305
306
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 304

def authorizer_configuration()
  jsii_get_property("authorizerConfiguration")
end

#authorizer_configuration=(value) ⇒ Object 



308
309
310
311
312
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 308

def authorizer_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGateway::AuthorizerConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXkuQXV0aG9yaXplckNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "authorizerConfiguration") unless value.nil?
  jsii_set_property("authorizerConfiguration", value)
end

#authorizer_type ⇒ String

The authorizer type for the gateway.

Returns:

  • (String) 


272
273
274
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 272

def authorizer_type()
  jsii_get_property("authorizerType")
end

#authorizer_type=(value) ⇒ Object 



276
277
278
279
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 276

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

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



258
259
260
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 258

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



154
155
156
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 154

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


159
160
161
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 159

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


602
603
604
605
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 602

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_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


164
165
166
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 164

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


171
172
173
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 171

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

The description for the gateway.

Returns:

  • (String, nil) 


317
318
319
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 317

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



321
322
323
324
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 321

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

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



176
177
178
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 176

def env()
  jsii_get_property("env")
end

#exception_level ⇒ String?

The exception level for the gateway.

Returns:

  • (String, nil) 


329
330
331
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 329

def exception_level()
  jsii_get_property("exceptionLevel")
end

#exception_level=(value) ⇒ Object 



333
334
335
336
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 333

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

#gateway_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayReference

A reference to a Gateway resource.

Returns:



265
266
267
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 265

def gateway_ref()
  jsii_get_property("gatewayRef")
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:



615
616
617
618
619
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 615

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.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



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

def get_metadata(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:



696
697
698
699
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 696

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

#interceptor_configurations ⇒ AWSCDK::IResolvable, ...

Returns:



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

def interceptor_configurations()
  jsii_get_property("interceptorConfigurations")
end

#interceptor_configurations=(value) ⇒ Object 



343
344
345
346
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 343

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

#kms_key_arn ⇒ String?

The KMS key ARN for the gateway.

Returns:

  • (String, nil) 


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

def kms_key_arn()
  jsii_get_property("kmsKeyArn")
end

#kms_key_arn=(value) ⇒ Object 



355
356
357
358
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 355

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

#logical_id ⇒ String

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) 


128
129
130
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 128

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The name for the gateway.

Returns:

  • (String) 


284
285
286
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 284

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



288
289
290
291
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 288

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


111
112
113
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 111

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<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:



637
638
639
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 637

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

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

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

Returns:



644
645
646
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 644

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.



437
438
439
440
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 437

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

#policy_engine_configuration ⇒ AWSCDK::IResolvable, ...

The configuration for a policy engine associated with a gateway.

Returns:



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

def policy_engine_configuration()
  jsii_get_property("policyEngineConfiguration")
end

#policy_engine_configuration=(value) ⇒ Object 



367
368
369
370
371
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 367

def policy_engine_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGateway::GatewayPolicyEngineConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXkuR2F0ZXdheVBvbGljeUVuZ2luZUNvbmZpZ3VyYXRpb25Qcm9wZXJ0eSJ9XX19")), "policyEngineConfiguration") unless value.nil?
  jsii_set_property("policyEngineConfiguration", value)
end

#protocol_configuration ⇒ AWSCDK::IResolvable, ...

The protocol configuration for the gateway target.

Returns:



376
377
378
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 376

def protocol_configuration()
  jsii_get_property("protocolConfiguration")
end

#protocol_configuration=(value) ⇒ Object 



380
381
382
383
384
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 380

def protocol_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGateway::GatewayProtocolConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXkuR2F0ZXdheVByb3RvY29sQ29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "protocolConfiguration") unless value.nil?
  jsii_set_property("protocolConfiguration", value)
end

#protocol_type ⇒ String?

The protocol type for the gateway target.

Returns:

  • (String, nil) 


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

def protocol_type()
  jsii_get_property("protocolType")
end

#protocol_type=(value) ⇒ Object 



393
394
395
396
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 393

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

#ref ⇒ String

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) 


147
148
149
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 147

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:



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

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


662
663
664
665
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 662

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:



672
673
674
675
676
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 672

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

#role_arn ⇒ String

Returns:

  • (String) 


294
295
296
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 294

def role_arn()
  jsii_get_property("roleArn")
end

#role_arn=(value) ⇒ Object 



298
299
300
301
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 298

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

#should_synthesize ⇒ Boolean

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.



681
682
683
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 681

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



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

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Hash{String => String}?

The tags for the gateway.

Returns:

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


401
402
403
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 401

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



405
406
407
408
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 405

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_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



413
414
415
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 413

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

#updated_properites ⇒ Hash{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}) 


184
185
186
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 184

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{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}) 


194
195
196
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 194

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


687
688
689
690
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 687

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) 


426
427
428
429
430
431
 
# File 'bedrock_agent_core/cfn_gateway.rb', line 426

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