Class: AWSCDK::AppMesh::Mesh

Inherits:
Resource
  • Object
show all
Includes:
IMesh
Defined in:
app_mesh/mesh.rb

Overview

Define a new AppMesh mesh.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Returns a new instance of Mesh.

Parameters:



14
15
16
17
18
19
20
 
# File 'app_mesh/mesh.rb', line 14

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

Class Method Details

.from_mesh_arn(scope, id, mesh_arn) ⇒ AWSCDK::AppMesh::IMesh

Import an existing mesh by arn.

Parameters:

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

Returns:



50
51
52
53
54
55
 
# File 'app_mesh/mesh.rb', line 50

def self.from_mesh_arn(scope, id, mesh_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(mesh_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "meshArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.Mesh", "fromMeshArn", [scope, id, mesh_arn])
end

.from_mesh_name(scope, id, mesh_name) ⇒ AWSCDK::AppMesh::IMesh

Import an existing mesh by name.

Parameters:

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

Returns:



63
64
65
66
67
68
 
# File 'app_mesh/mesh.rb', line 63

def self.from_mesh_name(scope, id, mesh_name)
  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(mesh_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "meshName")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.Mesh", "fromMeshName", [scope, id, mesh_name])
end

.jsii_overridable_methods ⇒ Object 



22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
 
# File 'app_mesh/mesh.rb', line 22

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 },
    :mesh_arn => { kind: :property, name: "meshArn", is_optional: false },
    :mesh_name => { kind: :property, name: "meshName", is_optional: false },
    :mesh_ref => { kind: :property, name: "meshRef", 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_virtual_gateway => { kind: :method, name: "addVirtualGateway", is_optional: false },
    :add_virtual_node => { kind: :method, name: "addVirtualNode", is_optional: false },
    :add_virtual_router => { kind: :method, name: "addVirtualRouter", is_optional: false },
  }
end

.PROPERTY_INJECTION_ID ⇒ String

Uniquely identifies this class.

Returns:

  • (String) 


116
117
118
 
# File 'app_mesh/mesh.rb', line 116

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

Instance Method Details

#add_virtual_gateway(id, props = nil) ⇒ AWSCDK::AppMesh::VirtualGateway

Adds a VirtualGateway to the Mesh.

Parameters:

Returns:



236
237
238
239
240
241
 
# File 'app_mesh/mesh.rb', line 236

def add_virtual_gateway(id, props = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::AppMesh::VirtualGatewayBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsR2F0ZXdheUJhc2VQcm9wcyJ9")), "props") unless props.nil?
  jsii_call_method("addVirtualGateway", [id, props])
end

#add_virtual_node(id, props = nil) ⇒ AWSCDK::AppMesh::VirtualNode

Adds a VirtualNode to the Mesh.

Parameters:

Returns:



248
249
250
251
252
253
 
# File 'app_mesh/mesh.rb', line 248

def add_virtual_node(id, props = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::AppMesh::VirtualNodeBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsTm9kZUJhc2VQcm9wcyJ9")), "props") unless props.nil?
  jsii_call_method("addVirtualNode", [id, props])
end

#add_virtual_router(id, props = nil) ⇒ AWSCDK::AppMesh::VirtualRouter

Adds a VirtualRouter to the Mesh with the given id and props.

Parameters:

Returns:



260
261
262
263
264
265
 
# File 'app_mesh/mesh.rb', line 260

def add_virtual_router(id, props = nil)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::AppMesh::VirtualRouterBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsUm91dGVyQmFzZVByb3BzIn0=")), "props") unless props.nil?
  jsii_call_method("addVirtualRouter", [id, props])
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:



174
175
176
177
 
# File 'app_mesh/mesh.rb', line 174

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:



191
192
193
194
 
# File 'app_mesh/mesh.rb', line 191

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:



88
89
90
 
# File 'app_mesh/mesh.rb', line 88

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


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

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) 


211
212
213
214
215
216
 
# File 'app_mesh/mesh.rb', line 211

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) 


226
227
228
229
 
# File 'app_mesh/mesh.rb', line 226

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

#mesh_arn ⇒ String

The Amazon Resource Name (ARN) of the AppMesh mesh.

Returns:

  • (String) 


123
124
125
 
# File 'app_mesh/mesh.rb', line 123

def mesh_arn()
  jsii_get_property("meshArn")
end

#mesh_name ⇒ String

The name of the AppMesh mesh.

Returns:

  • (String) 


130
131
132
 
# File 'app_mesh/mesh.rb', line 130

def mesh_name()
  jsii_get_property("meshName")
end

#mesh_ref ⇒ AWSCDK::Interfaces::AWSAppmesh::MeshReference

A reference to a Mesh resource.

Returns:



137
138
139
 
# File 'app_mesh/mesh.rb', line 137

def mesh_ref()
  jsii_get_property("meshRef")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


73
74
75
 
# File 'app_mesh/mesh.rb', line 73

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) 


102
103
104
 
# File 'app_mesh/mesh.rb', line 102

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



109
110
111
 
# File 'app_mesh/mesh.rb', line 109

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


144
145
146
 
# File 'app_mesh/mesh.rb', line 144

def to_string()
  jsii_call_method("toString", [])
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) 


157
158
159
160
161
162
 
# File 'app_mesh/mesh.rb', line 157

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