Class: AWSCDK::BedrockAgentCore::GatewayTargetBase

Inherits:
Resource
  • Object
show all
Includes:
IGatewayTarget
Defined in:
bedrock_agent_core/gateway_target_base.rb

Overview

Base class for gateway target implementations.

Provides common functionality for all gateway target types including permission management and property definitions.

Direct Known Subclasses

GatewayTarget

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of GatewayTargetBase.

Parameters:



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

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 23

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :physical_name => { kind: :property, name: "physicalName", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :gateway => { kind: :property, name: "gateway", is_optional: false },
    :gateway_target_name => { kind: :property, name: "gatewayTargetName", is_optional: false },
    :gateway_target_ref => { kind: :property, name: "gatewayTargetRef", is_optional: false },
    :target_arn => { kind: :property, name: "targetArn", is_optional: false },
    :target_id => { kind: :property, name: "targetId", is_optional: false },
    :target_protocol_type => { kind: :property, name: "targetProtocolType", is_optional: false },
    :created_at => { kind: :property, name: "createdAt", is_optional: true },
    :credential_provider_configurations => { kind: :property, name: "credentialProviderConfigurations", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :status => { kind: :property, name: "status", is_optional: true },
    :status_reasons => { kind: :property, name: "statusReasons", is_optional: true },
    :updated_at => { kind: :property, name: "updatedAt", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :generate_physical_name => { kind: :method, name: "generatePhysicalName", is_optional: false },
    :get_resource_arn_attribute => { kind: :method, name: "getResourceArnAttribute", is_optional: false },
    :get_resource_name_attribute => { kind: :method, name: "getResourceNameAttribute", is_optional: false },
    :grant => { kind: :method, name: "grant", is_optional: false },
    :grant_manage => { kind: :method, name: "grantManage", is_optional: false },
    :grant_read => { kind: :method, name: "grantRead", is_optional: false },
  }
end

Instance Method Details

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Override the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified mechanism instead of the global default determined by the @aws-cdk/core:defaultCrossStackReferences context key. This is useful for selectively weakening specific references to avoid the "deadly embrace" problem without changing the app-wide default.

Parameters:



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

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

#apply_removal_policy(policy) ⇒ void

This method returns an undefined value.

Apply the given removal policy to this resource.

The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.

The resource can be deleted (RemovalPolicy.DESTROY), or left in your AWS account for data recovery and cleanup later (RemovalPolicy.RETAIN).

Parameters:



231
232
233
234
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 231

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

#created_at ⇒ String?

Timestamp when the gateway target was created.

Returns:

  • (String, nil) 


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

def created_at()
  jsii_get_property("createdAt")
end

#credential_provider_configurations ⇒ Array<AWSCDK::BedrockAgentCore::ICredentialProviderConfig>?

The credential provider configuration for the target.

Returns:



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

def credential_provider_configurations()
  jsii_get_property("credentialProviderConfigurations")
end

#description ⇒ String?

The description of the gateway target.

Returns:

  • (String, nil) 


156
157
158
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 156

def description()
  jsii_get_property("description")
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

The environment this resource belongs to.

For resources that are created and managed in a Stack (those created by creating new class instances like new Role(), new Bucket(), etc.), this is always the same as the environment of the stack they belong to.

For referenced resources (those obtained from referencing methods like Role.fromRoleArn(), Bucket.fromBucketName(), etc.), they might be different than the stack they were imported into.

Returns:



72
73
74
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 72

def env()
  jsii_get_property("env")
end

#gateway ⇒ AWSCDK::BedrockAgentCore::IGateway

The gateway that this target belongs to.

Returns:



100
101
102
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 100

def gateway()
  jsii_get_property("gateway")
end

#gateway_target_name ⇒ String

The name of the gateway target.

Returns:

  • (String) 


107
108
109
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 107

def gateway_target_name()
  jsii_get_property("gatewayTargetName")
end

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

A reference to a GatewayTarget resource.

Returns:



114
115
116
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 114

def gateway_target_ref()
  jsii_get_property("gatewayTargetRef")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


237
238
239
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 237

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

#get_resource_arn_attribute(arn_attr, arn_components) ⇒ String

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

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

Parameters:

  • arn_attr (String) —

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

  • arn_components (AWSCDK::ARNComponents) —

    The format of the ARN of this resource.

Returns:

  • (String) 


251
252
253
254
255
256
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 251

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

#get_resource_name_attribute(name_attr) ⇒ String

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

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

Parameters:

  • name_attr (String) —

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

Returns:

  • (String) 


266
267
268
269
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 266

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

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

Grants IAM actions to the IAM Principal.

[disable-awslint:no-grants]

Parameters:

  • grantee (AWSCDK::IAM::IGrantable) —

    The principal to grant permissions to.

  • actions (Array<String>) —

    The IAM actions to grant.

Returns:



278
279
280
281
282
283
284
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 278

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

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

Grants Create, Update, and Delete actions on the Gateway Target.

[disable-awslint:no-grants]

Parameters:

Returns:



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

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

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

Grants Get and List actions on the Gateway Target.

[disable-awslint:no-grants]

Parameters:

Returns:



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

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

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


57
58
59
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 57

def node()
  jsii_get_property("node")
end

#physical_name ⇒ String

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

This value will resolve to one of the following:

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

Returns:

  • (String) 


86
87
88
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 86

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



93
94
95
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 93

def stack()
  jsii_get_property("stack")
end

#status ⇒ String?

The status of the gateway target.

Returns:

  • (String, nil) 


163
164
165
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 163

def status()
  jsii_get_property("status")
end

#status_reasons ⇒ Array<String>?

The status reasons for the gateway target.

Returns:

  • (Array<String>, nil) 


170
171
172
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 170

def status_reasons()
  jsii_get_property("statusReasons")
end

#target_arn ⇒ String

The ARN of the gateway target resource.

Returns:

  • (String) 


121
122
123
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 121

def target_arn()
  jsii_get_property("targetArn")
end

#target_id ⇒ String

The id of the gateway target.

Returns:

  • (String) 


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

def target_id()
  jsii_get_property("targetId")
end

#target_protocol_type ⇒ AWSCDK::BedrockAgentCore::GatewayTargetProtocolType

The target protocol.

Returns:



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

def target_protocol_type()
  jsii_get_property("targetProtocolType")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


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

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

#updated_at ⇒ String?

Timestamp when the gateway target was last updated.

Returns:

  • (String, nil) 


177
178
179
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 177

def updated_at()
  jsii_get_property("updatedAt")
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) 


197
198
199
200
201
202
 
# File 'bedrock_agent_core/gateway_target_base.rb', line 197

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