Module: AWSCDK::AppMesh::IVirtualNode

Includes:
IResource, Interfaces::AWSAppmesh::IVirtualNodeRef
Included in:
VirtualNode
Defined in:
app_mesh/i_virtual_node.rb

Overview

Interface which all VirtualNode based classes must implement.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'app_mesh/i_virtual_node.rb', line 110

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :virtual_node_ref => { kind: :property, name: "virtualNodeRef", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :grant_stream_aggregated_resources => { kind: :method, name: "grantStreamAggregatedResources", is_optional: false },
  }
end

Instance Method Details

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



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

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:



27
28
29
 
# File 'app_mesh/i_virtual_node.rb', line 27

def env()
  jsii_get_property("env")
end

#grant_stream_aggregated_resources(identity) ⇒ AWSCDK::IAM::Grant

Grants the given entity appmesh:StreamAggregatedResources.

Parameters:

Returns:



105
106
107
108
 
# File 'app_mesh/i_virtual_node.rb', line 105

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

#mesh ⇒ AWSCDK::AppMesh::IMesh

The Mesh which the VirtualNode belongs to.

Returns:



48
49
50
 
# File 'app_mesh/i_virtual_node.rb', line 48

def mesh()
  jsii_get_property("mesh")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'app_mesh/i_virtual_node.rb', line 12

def node()
  jsii_get_property("node")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



34
35
36
 
# File 'app_mesh/i_virtual_node.rb', line 34

def stack()
  jsii_get_property("stack")
end

#virtual_node_arn ⇒ String

The Amazon Resource Name belonging to the VirtualNode.

Set this value as the APPMESH_VIRTUAL_NODE_NAME environment variable for your task group's Envoy proxy container in your task definition or pod spec.

Returns:

  • (String) 


59
60
61
 
# File 'app_mesh/i_virtual_node.rb', line 59

def virtual_node_arn()
  jsii_get_property("virtualNodeArn")
end

#virtual_node_name ⇒ String

The name of the VirtualNode.

Returns:

  • (String) 


66
67
68
 
# File 'app_mesh/i_virtual_node.rb', line 66

def virtual_node_name()
  jsii_get_property("virtualNodeName")
end

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

A reference to a VirtualNode resource.

Returns:



41
42
43
 
# File 'app_mesh/i_virtual_node.rb', line 41

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.

Parameters:

  • mixins (Array<Constructs::IMixin>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



77
78
79
80
81
82
 
# File 'app_mesh/i_virtual_node.rb', line 77

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