Module: AWSCDK::ElasticLoadBalancingv2::INetworkTargetGroup

Includes:
INetworkTargetGroupRef, ITargetGroup
Included in:
NetworkTargetGroup
Defined in:
elastic_load_balancingv2/i_network_target_group.rb

Overview

A network target group.

Class Method Summary collapse

Instance Method Summary collapse

Class Method Details

.jsii_overridable_methods ⇒ Object 



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

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :target_group_ref => { kind: :property, name: "targetGroupRef", is_optional: false },
    :load_balancer_arns => { kind: :property, name: "loadBalancerArns", is_optional: false },
    :load_balancer_attached => { kind: :property, name: "loadBalancerAttached", is_optional: false },
    :target_group_arn => { kind: :property, name: "targetGroupArn", is_optional: false },
    :target_group_name => { kind: :property, name: "targetGroupName", is_optional: false },
    :is_network_target_group => { kind: :property, name: "isNetworkTargetGroup", is_optional: false },
    :metrics => { kind: :property, name: "metrics", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_target => { kind: :method, name: "addTarget", is_optional: false },
    :register_listener => { kind: :method, name: "registerListener", is_optional: false },
  }
end

Instance Method Details

#add_target(*targets) ⇒ void

This method returns an undefined value.

Add a load balancing target to this target group.

Parameters:



101
102
103
104
105
106
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 101

def add_target(*targets)
  targets.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5JTmV0d29ya0xvYWRCYWxhbmNlclRhcmdldCJ9")), "targets[#{index}]")
  end
  jsii_call_method("addTarget", [*targets])
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 'elastic_load_balancingv2/i_network_target_group.rb', line 27

def env()
  jsii_get_property("env")
end

#is_network_target_group ⇒ Boolean

Indicates that this is a Network Target Group.

Will always return true, but is necessary to prevent accidental structural equality in TypeScript.

Returns:

  • (Boolean) 


72
73
74
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 72

def is_network_target_group()
  jsii_get_property("isNetworkTargetGroup")
end

#load_balancer_arns ⇒ String

A token representing a list of ARNs of the load balancers that route traffic to this target group.

Returns:

  • (String) 


41
42
43
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 41

def load_balancer_arns()
  jsii_get_property("loadBalancerArns")
end

#load_balancer_attached ⇒ Constructs::IDependable

Return an object to depend on the listeners added to this target group.

Returns:

  • (Constructs::IDependable) 


48
49
50
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 48

def load_balancer_attached()
  jsii_get_property("loadBalancerAttached")
end

#metrics ⇒ AWSCDK::ElasticLoadBalancingv2::INetworkTargetGroupMetrics

All metrics available for this target group.

Returns:



79
80
81
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 79

def metrics()
  jsii_get_property("metrics")
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


12
13
14
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 12

def node()
  jsii_get_property("node")
end

#register_listener(listener) ⇒ void

This method returns an undefined value.

Register a listener that is load balancing to this target group.

Don't call this directly. It will be called by listeners.

Parameters:



114
115
116
117
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 114

def register_listener(listener)
  Jsii::Type.check_type(listener, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWxhc3RpY2xvYWRiYWxhbmNpbmd2Mi5JTmV0d29ya0xpc3RlbmVyUmVmIn0=")), "listener")
  jsii_call_method("registerListener", [listener])
end

#target_group_arn ⇒ String

ARN of the target group.

Returns:

  • (String) 


55
56
57
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 55

def target_group_arn()
  jsii_get_property("targetGroupArn")
end

#target_group_name ⇒ String

The name of the target group.

Returns:

  • (String) 


62
63
64
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 62

def target_group_name()
  jsii_get_property("targetGroupName")
end

#target_group_ref ⇒ AWSCDK::Interfaces::AWSElasticloadbalancingv2::TargetGroupReference

A reference to a TargetGroup resource.

Returns:



34
35
36
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 34

def target_group_ref()
  jsii_get_property("targetGroupRef")
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



90
91
92
93
94
95
 
# File 'elastic_load_balancingv2/i_network_target_group.rb', line 90

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