Module: AWSCDK::AppMesh::IVirtualGateway

Includes:
IResource, Interfaces::AWSAppmesh::IVirtualGatewayRef
Included in:
VirtualGateway
Defined in:
app_mesh/i_virtual_gateway.rb

Overview

Interface which all Virtual Gateway based classes must implement.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
 
# File 'app_mesh/i_virtual_gateway.rb', line 120

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_gateway_ref => { kind: :property, name: "virtualGatewayRef", 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 },
    :with => { kind: :method, name: "with", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", 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

Instance Method Details

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

Utility method to add a new GatewayRoute to the VirtualGateway.

Parameters:

Returns:



102
103
104
105
106
107
 
# File 'app_mesh/i_virtual_gateway.rb', line 102

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



92
93
94
95
 
# File 'app_mesh/i_virtual_gateway.rb', line 92

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_gateway.rb', line 27

def env()
  jsii_get_property("env")
end

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

Grants the given entity appmesh:StreamAggregatedResources.

[disable-awslint:no-grants]

Parameters:

Returns:



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

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 VirtualGateway belongs to.

Returns:



48
49
50
 
# File 'app_mesh/i_virtual_gateway.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_gateway.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_gateway.rb', line 34

def stack()
  jsii_get_property("stack")
end

#virtual_gateway_arn ⇒ String

The Amazon Resource Name (ARN) for the VirtualGateway.

Returns:

  • (String) 


55
56
57
 
# File 'app_mesh/i_virtual_gateway.rb', line 55

def virtual_gateway_arn()
  jsii_get_property("virtualGatewayArn")
end

#virtual_gateway_name ⇒ String

Name of the VirtualGateway.

Returns:

  • (String) 


62
63
64
 
# File 'app_mesh/i_virtual_gateway.rb', line 62

def virtual_gateway_name()
  jsii_get_property("virtualGatewayName")
end

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

A reference to a VirtualGateway resource.

Returns:



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

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.

Parameters:

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

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



73
74
75
76
77
78
 
# File 'app_mesh/i_virtual_gateway.rb', line 73

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