Class: AWSCDK::AppMesh::VirtualGateway

Inherits:
Resource
  • Object
show all
Includes:
IVirtualGateway
Defined in:
app_mesh/virtual_gateway.rb

Overview

VirtualGateway represents a newly defined App Mesh Virtual Gateway.

A virtual gateway allows resources that are outside of your mesh to communicate to resources that are inside of your mesh.

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ VirtualGateway

Returns a new instance of VirtualGateway.

Parameters:



17
18
19
20
21
22
23
 
# File 'app_mesh/virtual_gateway.rb', line 17

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

Class Method Details

.from_virtual_gateway_arn(scope, id, virtual_gateway_arn) ⇒ AWSCDK::AppMesh::IVirtualGateway

Import an existing VirtualGateway given an ARN.

Parameters:

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

Returns:



55
56
57
58
59
60
 
# File 'app_mesh/virtual_gateway.rb', line 55

def self.from_virtual_gateway_arn(scope, id, virtual_gateway_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_gateway_arn, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "virtualGatewayArn")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.VirtualGateway", "fromVirtualGatewayArn", [scope, id, virtual_gateway_arn])
end

.from_virtual_gateway_attributes(scope, id, attrs) ⇒ AWSCDK::AppMesh::IVirtualGateway

Import an existing VirtualGateway given its attributes.

Parameters:

Returns:



68
69
70
71
72
73
74
 
# File 'app_mesh/virtual_gateway.rb', line 68

def self.from_virtual_gateway_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::VirtualGatewayAttributes.new(**attrs.transform_keys(&:to_sym)) : attrs
  Jsii::Type.check_type(attrs, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5WaXJ0dWFsR2F0ZXdheUF0dHJpYnV0ZXMifQ==")), "attrs")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_appmesh.VirtualGateway", "fromVirtualGatewayAttributes", [scope, id, attrs])
end

.jsii_overridable_methods ⇒ Object 



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

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 },
    :listeners => { kind: :property, name: "listeners", is_optional: false },
    :mesh => { kind: :property, name: "mesh", is_optional: false },
    :virtual_gateway_arn => { kind: :property, name: "virtualGatewayArn", is_optional: false },
    :virtual_gateway_name => { kind: :property, name: "virtualGatewayName", is_optional: false },
    :virtual_gateway_ref => { kind: :property, name: "virtualGatewayRef", 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_gateway_route => { kind: :method, name: "addGatewayRoute", 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) 


122
123
124
 
# File 'app_mesh/virtual_gateway.rb', line 122

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

Instance Method Details

#add_gateway_route(id, props) ⇒ AWSCDK::AppMesh::GatewayRoute

Utility method to add a new GatewayRoute to the VirtualGateway.

Parameters:

Returns:



261
262
263
264
265
266
 
# File 'app_mesh/virtual_gateway.rb', line 261

def add_gateway_route(id, props)
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  props = props.is_a?(Hash) ? ::AWSCDK::AppMesh::GatewayRouteBaseProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfYXBwbWVzaC5HYXRld2F5Um91dGVCYXNlUHJvcHMifQ==")), "props")
  jsii_call_method("addGatewayRoute", [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:



199
200
201
202
 
# File 'app_mesh/virtual_gateway.rb', line 199

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:



216
217
218
219
 
# File 'app_mesh/virtual_gateway.rb', line 216

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:



94
95
96
 
# File 'app_mesh/virtual_gateway.rb', line 94

def env()
  jsii_get_property("env")
end

#generate_physical_name ⇒ String

Returns:

  • (String) 


222
223
224
 
# File 'app_mesh/virtual_gateway.rb', line 222

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) 


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

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) 


251
252
253
254
 
# File 'app_mesh/virtual_gateway.rb', line 251

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

Grants the given entity appmesh:StreamAggregatedResources.

[disable-awslint:no-grants]

Parameters:

Returns:



274
275
276
277
 
# File 'app_mesh/virtual_gateway.rb', line 274

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

Collection of grant methods for a VirtualGateway.

Returns:



129
130
131
 
# File 'app_mesh/virtual_gateway.rb', line 129

def grants()
  jsii_get_property("grants")
end

#listeners ⇒ Array<AWSCDK::AppMesh::VirtualGatewayListenerConfig>

Returns:



134
135
136
 
# File 'app_mesh/virtual_gateway.rb', line 134

def listeners()
  jsii_get_property("listeners")
end

#mesh ⇒ AWSCDK::AppMesh::IMesh

The Mesh that the VirtualGateway belongs to.

Returns:



141
142
143
 
# File 'app_mesh/virtual_gateway.rb', line 141

def mesh()
  jsii_get_property("mesh")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


79
80
81
 
# File 'app_mesh/virtual_gateway.rb', line 79

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) 


108
109
110
 
# File 'app_mesh/virtual_gateway.rb', line 108

def physical_name()
  jsii_get_property("physicalName")
end

#stack ⇒ AWSCDK::Stack

The stack in which this resource is defined.

Returns:



115
116
117
 
# File 'app_mesh/virtual_gateway.rb', line 115

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


169
170
171
 
# File 'app_mesh/virtual_gateway.rb', line 169

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

#virtual_gateway_arn ⇒ String

The Amazon Resource Name (ARN) for the VirtualGateway.

Returns:

  • (String) 


148
149
150
 
# File 'app_mesh/virtual_gateway.rb', line 148

def virtual_gateway_arn()
  jsii_get_property("virtualGatewayArn")
end

#virtual_gateway_name ⇒ String

The name of the VirtualGateway.

Returns:

  • (String) 


155
156
157
 
# File 'app_mesh/virtual_gateway.rb', line 155

def virtual_gateway_name()
  jsii_get_property("virtualGatewayName")
end

#virtual_gateway_ref ⇒ AWSCDK::Interfaces::AWSAppmesh::VirtualGatewayReference

A reference to a VirtualGateway resource.

Returns:



162
163
164
 
# File 'app_mesh/virtual_gateway.rb', line 162

def virtual_gateway_ref()
  jsii_get_property("virtualGatewayRef")
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) 


182
183
184
185
186
187
 
# File 'app_mesh/virtual_gateway.rb', line 182

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