Class: AWSCDK::BedrockAgentCore::CfnGatewayTarget

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSBedrockagentcore::IGatewayTargetRef
Defined in:
bedrock_agent_core/cfn_gateway_target.rb

Overview

After creating a gateway, you can add targets, which define the tools that your gateway will host.

For more information about adding gateway targets, see Add targets to an existing 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) ⇒ CfnGatewayTarget

Create a new AWS::BedrockAgentCore::GatewayTarget.

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

    Resource properties.



21
22
23
24
25
26
27
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 21

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

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


189
190
191
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 189

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

.is_cfn_gateway_target(x) ⇒ Boolean

Checks whether the given object is a CfnGatewayTarget.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


91
92
93
94
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 91

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

.jsii_overridable_methods ⇒ Object 



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

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_authorization_data => { kind: :property, name: "attrAuthorizationData", is_optional: false },
    :attr_created_at => { kind: :property, name: "attrCreatedAt", is_optional: false },
    :attr_gateway_arn => { kind: :property, name: "attrGatewayArn", is_optional: false },
    :attr_last_synchronized_at => { kind: :property, name: "attrLastSynchronizedAt", is_optional: false },
    :attr_private_endpoint_managed_resources => { kind: :property, name: "attrPrivateEndpointManagedResources", is_optional: false },
    :attr_protocol_type => { kind: :property, name: "attrProtocolType", is_optional: false },
    :attr_status => { kind: :property, name: "attrStatus", is_optional: false },
    :attr_status_reasons => { kind: :property, name: "attrStatusReasons", is_optional: false },
    :attr_target_id => { kind: :property, name: "attrTargetId", is_optional: false },
    :attr_updated_at => { kind: :property, name: "attrUpdatedAt", is_optional: false },
    :gateway_target_ref => { kind: :property, name: "gatewayTargetRef", is_optional: false },
    :target_configuration => { kind: :property, name: "targetConfiguration", is_optional: false },
    :credential_provider_configurations => { kind: :property, name: "credentialProviderConfigurations", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :gateway_identifier => { kind: :property, name: "gatewayIdentifier", is_optional: true },
    :metadata_configuration => { kind: :property, name: "metadataConfiguration", is_optional: true },
    :name => { kind: :property, name: "name", is_optional: true },
    :private_endpoint => { kind: :property, name: "privateEndpoint", 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.



379
380
381
382
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 379

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:



391
392
393
394
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 391

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:



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

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:



412
413
414
415
416
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 412

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.


469
470
471
472
473
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 469

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.



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

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.



491
492
493
494
495
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 491

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:



504
505
506
507
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 504

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:



526
527
528
529
530
531
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 526

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_authorization_data ⇒ AWSCDK::IResolvable

Returns:



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

def attr_authorization_data()
  jsii_get_property("attrAuthorizationData")
end

#attr_created_at ⇒ String

The date and time at which the gateway target was created.

Returns:

  • (String) 


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

def attr_created_at()
  jsii_get_property("attrCreatedAt")
end

#attr_gateway_arn ⇒ String

Returns:

  • (String) 


206
207
208
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 206

def attr_gateway_arn()
  jsii_get_property("attrGatewayArn")
end

#attr_last_synchronized_at ⇒ String

Returns:

  • (String) 


211
212
213
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 211

def attr_last_synchronized_at()
  jsii_get_property("attrLastSynchronizedAt")
end

#attr_private_endpoint_managed_resources ⇒ AWSCDK::IResolvable

Returns:



216
217
218
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 216

def attr_private_endpoint_managed_resources()
  jsii_get_property("attrPrivateEndpointManagedResources")
end

#attr_protocol_type ⇒ String

Returns:

  • (String) 


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

def attr_protocol_type()
  jsii_get_property("attrProtocolType")
end

#attr_status ⇒ String

The status for the gateway target.

Returns:

  • (String) 


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

def attr_status()
  jsii_get_property("attrStatus")
end

#attr_status_reasons ⇒ Array<String>

The status reasons for the gateway target.

Returns:

  • (Array<String>) 


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

def attr_status_reasons()
  jsii_get_property("attrStatusReasons")
end

#attr_target_id ⇒ String

The target ID for the gateway target.

Returns:

  • (String) 


242
243
244
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 242

def attr_target_id()
  jsii_get_property("attrTargetId")
end

#attr_updated_at ⇒ String

The time at which the resource was updated.

Returns:

  • (String) 


249
250
251
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 249

def attr_updated_at()
  jsii_get_property("attrUpdatedAt")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



142
143
144
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 142

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


535
536
537
538
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 535

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


152
153
154
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 152

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


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

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


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

def creation_stack()
  jsii_get_property("creationStack")
end

#credential_provider_configurations ⇒ AWSCDK::IResolvable, ...

The OAuth credential provider configuration.

Returns:



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

def credential_provider_configurations()
  jsii_get_property("credentialProviderConfigurations")
end

#credential_provider_configurations=(value) ⇒ Object 



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

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

#description ⇒ String?

The description for the gateway target.

Returns:

  • (String, nil) 


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

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



292
293
294
295
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 292

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:



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

def env()
  jsii_get_property("env")
end

#gateway_identifier ⇒ String?

The gateway ID for the gateway target.

Returns:

  • (String, nil) 


300
301
302
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 300

def gateway_identifier()
  jsii_get_property("gatewayIdentifier")
end

#gateway_identifier=(value) ⇒ Object 



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

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

#gateway_target_ref ⇒ AWSCDK::Interfaces::AWSBedrockagentcore::GatewayTargetReference

A reference to a GatewayTarget resource.

Returns:



256
257
258
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 256

def gateway_target_ref()
  jsii_get_property("gatewayTargetRef")
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:



548
549
550
551
552
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 548

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:



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

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:



629
630
631
632
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 629

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
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) 


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

def logical_id()
  jsii_get_property("logicalId")
end

#metadata_configuration ⇒ AWSCDK::IResolvable, ...

Returns:



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

def metadata_configuration()
  jsii_get_property("metadataConfiguration")
end

#metadata_configuration=(value) ⇒ Object 



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

def metadata_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGatewayTarget::MetadataConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXlUYXJnZXQuTWV0YWRhdGFDb25maWd1cmF0aW9uUHJvcGVydHkifV19fQ==")), "metadataConfiguration") unless value.nil?
  jsii_set_property("metadataConfiguration", value)
end

#name ⇒ String?

The name for the gateway target.

Returns:

  • (String, nil) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


99
100
101
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 99

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:



570
571
572
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 570

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:



577
578
579
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 577

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.



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

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

#private_endpoint ⇒ AWSCDK::IResolvable, ...

Returns:



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

def private_endpoint()
  jsii_get_property("privateEndpoint")
end

#private_endpoint=(value) ⇒ Object 



337
338
339
340
341
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 337

def private_endpoint=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGatewayTarget::PrivateEndpointProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXlUYXJnZXQuUHJpdmF0ZUVuZHBvaW50UHJvcGVydHkifV19fQ==")), "privateEndpoint") unless value.nil?
  jsii_set_property("privateEndpoint", 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) 


135
136
137
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 135

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:



588
589
590
591
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 588

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


595
596
597
598
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 595

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:



605
606
607
608
609
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 605

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



614
615
616
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 614

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:



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

def stack()
  jsii_get_property("stack")
end

#target_configuration ⇒ AWSCDK::IResolvable, AWSCDK::BedrockAgentCore::CfnGatewayTarget::TargetConfigurationProperty

The target configuration for the Smithy model target.

Returns:



263
264
265
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 263

def target_configuration()
  jsii_get_property("targetConfiguration")
end

#target_configuration=(value) ⇒ Object 



267
268
269
270
271
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 267

def target_configuration=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::BedrockAgentCore::CfnGatewayTarget::TargetConfigurationProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19iZWRyb2NrYWdlbnRjb3JlLkNmbkdhdGV3YXlUYXJnZXQuVGFyZ2V0Q29uZmlndXJhdGlvblByb3BlcnR5In1dfX0=")), "targetConfiguration")
  jsii_set_property("targetConfiguration", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



346
347
348
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 346

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


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

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


182
183
184
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 182

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


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

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) 


359
360
361
362
363
364
 
# File 'bedrock_agent_core/cfn_gateway_target.rb', line 359

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