Class: AWSCDK::AppMesh::VirtualNode

Inherits:
Resource
  • Object
show all
Includes:
IVirtualNode
Defined in:
app_mesh/virtual_node.rb

Overview

VirtualNode represents a newly defined AppMesh VirtualNode.

Any inbound traffic that your virtual node expects should be specified as a listener. Any outbound traffic that your virtual node expects to reach should be specified as a backend. [disable-awslint:no-grants]

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ VirtualNode

Returns a new instance of VirtualNode.

Parameters:



19
20
21
22
23
24
25
 
# File 'app_mesh/virtual_node.rb', line 19

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

Class Method Details

.from_virtual_node_arn(scope, id, virtual_node_arn) ⇒ AWSCDK::AppMesh::IVirtualNode

Import an existing VirtualNode given an ARN.

Parameters:

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

Returns:



57
58
59
60
61
62
 
# File 'app_mesh/virtual_node.rb', line 57

def self.from_virtual_node_arn(scope, id, virtual_node_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(virtual_node_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualNodeArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.VirtualNode", "fromVirtualNodeArn", [scope, id, virtual_node_arn])
end

.from_virtual_node_attributes(scope, id, attrs) ⇒ AWSCDK::AppMesh::IVirtualNode

Import an existing VirtualNode given its name.

Parameters:

Returns:



70
71
72
73
74
75
76
 
# File 'app_mesh/virtual_node.rb', line 70

def self.from_virtual_node_attributes(scope, id, attrs)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  attrs = attrs.is_a?(Hash) ? ::AWSCDK::AppMesh::VirtualNodeAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsTm9kZUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.VirtualNode", "fromVirtualNodeAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
 
# File 'app_mesh/virtual_node.rb', line 27

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 },
    :grants => { kind: :property, name: "grants", is_optional: false },
    :mesh => { kind: :property, name: "mesh", is_optional: false },
    :virtual_node_arn => { kind: :property, name: "virtualNodeArn", is_optional: false },
    :virtual_node_name => { kind: :property, name: "virtualNodeName", is_optional: false },
    :virtual_node_ref => { kind: :property, name: "virtualNodeRef", is_optional: false },
    :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 },
    :add_backend => { kind: :method, name: "addBackend", is_optional: false },
    :add_listener => { kind: :method, name: "addListener", is_optional: false },
    :grant_stream_aggregated_resources => { kind: :method, name: "grantStreamAggregatedResources", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


124
125
126
 
# File 'app_mesh/virtual_node.rb', line 124

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

Instance Method Details

#add_backend(backend) ⇒ void

This method returns an undefined value.

Add a Virtual Services that this node is expected to send outbound traffic to.

Parameters:



257
258
259
260
 
# File 'app_mesh/virtual_node.rb', line 257

def add_backend(backend)
  Jsii::Type.check_type(backend, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5CYWNrZW5kIn0=")), "backend")
  jsii_call_method("addBackend", [backend])
end

#add_listener(listener) ⇒ void

This method returns an undefined value.

Utility method to add an inbound listener for this VirtualNode.

Note: At this time, Virtual Nodes support at most one listener. Adding more than one will result in a failure to deploy the CloudFormation stack. However, the App Mesh team has plans to add support for multiple listeners on Virtual Nodes and Virtual Routers.

Parameters:

See Also:



272
273
274
275
 
# File 'app_mesh/virtual_node.rb', line 272

def add_listener(listener)
  Jsii::Type.check_type(listener, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsTm9kZUxpc3RlbmVyIn0=")), "listener")
  jsii_call_method("addListener", [listener])
end

#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:



196
197
198
199
 
# File 'app_mesh/virtual_node.rb', line 196

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:



213
214
215
216
 
# File 'app_mesh/virtual_node.rb', line 213

def apply_removal_policy(policy)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy")
  jsii_call_method("applyRemovalPolicy", [policy])
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:



96
97
98
 
# File 'app_mesh/virtual_node.rb', line 96

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


219
220
221
 
# File 'app_mesh/virtual_node.rb', line 219

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) 


233
234
235
236
237
238
 
# File 'app_mesh/virtual_node.rb', line 233

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) 


248
249
250
251
 
# File 'app_mesh/virtual_node.rb', line 248

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_stream_aggregated_resources(identity) ⇒ AWSCDK::IAM::Grant

The use of this method is discouraged. Please use grants.streamAggregatedResources() instead.

[disable-awslint:no-grants]

Parameters:

Returns:



283
284
285
286
 
# File 'app_mesh/virtual_node.rb', line 283

def grant_stream_aggregated_resources(identity)
  Jsii::Type.check_type(identity, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfaWFtLklHcmFudGFibGUifQ==")), "identity")
  jsii_call_method("grantStreamAggregatedResources", [identity])
end

#grants ⇒ AWSCDK::AppMesh::VirtualNodeGrants

Collection of grants for this Virtual Node.

Returns:



131
132
133
 
# File 'app_mesh/virtual_node.rb', line 131

def grants()
  jsii_get_property("grants")
end

#mesh ⇒ AWSCDK::AppMesh::IMesh

The Mesh which the VirtualNode belongs to.

Returns:



138
139
140
 
# File 'app_mesh/virtual_node.rb', line 138

def mesh()
  jsii_get_property("mesh")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


81
82
83
 
# File 'app_mesh/virtual_node.rb', line 81

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) 


110
111
112
 
# File 'app_mesh/virtual_node.rb', line 110

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



117
118
119
 
# File 'app_mesh/virtual_node.rb', line 117

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


166
167
168
 
# File 'app_mesh/virtual_node.rb', line 166

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

#virtual_node_arn ⇒ String

The Amazon Resource Name belonging to the VirtualNode.

Returns:

  • (String) 


145
146
147
 
# File 'app_mesh/virtual_node.rb', line 145

def virtual_node_arn()
  jsii_get_property("virtualNodeArn")
end

#virtual_node_name ⇒ String

The name of the VirtualNode.

Returns:

  • (String) 


152
153
154
 
# File 'app_mesh/virtual_node.rb', line 152

def virtual_node_name()
  jsii_get_property("virtualNodeName")
end

#virtual_node_ref ⇒ AWSCDK::Interfaces::AWSAppmesh::VirtualNodeReference

A reference to a VirtualNode resource.

Returns:



159
160
161
 
# File 'app_mesh/virtual_node.rb', line 159

def virtual_node_ref()
  jsii_get_property("virtualNodeRef")
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) 


179
180
181
182
183
184
 
# File 'app_mesh/virtual_node.rb', line 179

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