Class: AWSCDK::ECSPatterns::NetworkMultipleTargetGroupsServiceBase

Inherits:
Constructs::Construct
  • Object
show all
Defined in:
ecs_patterns/network_multiple_target_groups_service_base.rb

Overview

The base class for NetworkMultipleTargetGroupsEc2Service and NetworkMultipleTargetGroupsFargateService classes.

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

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

Constructs a new instance of the NetworkMultipleTargetGroupsServiceBase class.

Parameters:



13
14
15
16
17
18
19
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 13

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

Class Method Details

.jsii_overridable_methods ⇒ Object 



21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 21

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :cluster => { kind: :property, name: "cluster", is_optional: false },
    :listener => { kind: :property, name: "listener", is_optional: false },
    :listeners => { kind: :property, name: "listeners", is_optional: false },
    :load_balancer => { kind: :property, name: "loadBalancer", is_optional: false },
    :load_balancers => { kind: :property, name: "loadBalancers", is_optional: false },
    :target_groups => { kind: :property, name: "targetGroups", is_optional: false },
    :internal_desired_count => { kind: :property, name: "internalDesiredCount", is_optional: true },
    :log_driver => { kind: :property, name: "logDriver", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :add_port_mapping_for_targets => { kind: :method, name: "addPortMappingForTargets", is_optional: false },
    :create_aws_log_driver => { kind: :method, name: "createAWSLogDriver", is_optional: false },
    :find_listener => { kind: :method, name: "findListener", is_optional: false },
    :get_default_cluster => { kind: :method, name: "getDefaultCluster", is_optional: false },
    :register_ecs_targets => { kind: :method, name: "registerECSTargets", is_optional: false },
  }
end

Instance Method Details

#add_port_mapping_for_targets(container, targets) ⇒ void

This method returns an undefined value.

Parameters:



139
140
141
142
143
144
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 139

def add_port_mapping_for_targets(container, targets)
  Jsii::Type.check_type(container, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNvbnRhaW5lckRlZmluaXRpb24ifQ==")), "container")
  targets = targets.is_a?(Array) ? targets.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::ECSPatterns::NetworkTargetProps.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : targets
  Jsii::Type.check_type(targets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3NfcGF0dGVybnMuTmV0d29ya1RhcmdldFByb3BzIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "targets")
  jsii_call_method("addPortMappingForTargets", [container, targets])
end

#cluster ⇒ AWSCDK::ECS::ICluster

The cluster that hosts the service.

Returns:



52
53
54
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 52

def cluster()
  jsii_get_property("cluster")
end

#create_aws_log_driver(prefix) ⇒ AWSCDK::ECS::AWSLogDriver

Parameters:

  • prefix (String)

Returns:



148
149
150
151
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 148

def create_aws_log_driver(prefix)
  Jsii::Type.check_type(prefix, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "prefix")
  jsii_call_method("createAWSLogDriver", [prefix])
end

#find_listener(name = nil) ⇒ AWSCDK::ElasticLoadBalancingv2::NetworkListener

Parameters:

  • name (String, nil) (defaults to: nil)

Returns:



155
156
157
158
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 155

def find_listener(name = nil)
  Jsii::Type.check_type(name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name") unless name.nil?
  jsii_call_method("findListener", [name])
end

#get_default_cluster(scope, vpc = nil) ⇒ AWSCDK::ECS::Cluster

Returns the default cluster.

Parameters:

Returns:



165
166
167
168
169
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 165

def get_default_cluster(scope, vpc = nil)
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless vpc.nil?
  jsii_call_method("getDefaultCluster", [scope, vpc])
end

#internal_desired_count ⇒ Numeric?

The desired number of instantiations of the task definition to keep running on the service.

The default is 1 for all new services and uses the existing services desired count when updating an existing service, if one is not provided.

Returns:

  • (Numeric, nil) 


99
100
101
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 99

def internal_desired_count()
  jsii_get_property("internalDesiredCount")
end

#listener ⇒ AWSCDK::ElasticLoadBalancingv2::NetworkListener

Deprecated.
  • Use listeners instead.

The listener for the service.

Returns:



60
61
62
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 60

def listener()
  jsii_get_property("listener")
end

#listeners ⇒ Array<AWSCDK::ElasticLoadBalancingv2::NetworkListener>

The listeners of the service.

Returns:



67
68
69
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 67

def listeners()
  jsii_get_property("listeners")
end

#load_balancer ⇒ AWSCDK::ElasticLoadBalancingv2::NetworkLoadBalancer

Deprecated.
  • Use loadBalancers instead.

The Network Load Balancer for the service.

Returns:



75
76
77
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 75

def load_balancer()
  jsii_get_property("loadBalancer")
end

#load_balancers ⇒ Array<AWSCDK::ElasticLoadBalancingv2::NetworkLoadBalancer>

The load balancers of the service.

Returns:



82
83
84
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 82

def load_balancers()
  jsii_get_property("loadBalancers")
end

#log_driver ⇒ AWSCDK::ECS::LogDriver?

Returns:



104
105
106
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 104

def log_driver()
  jsii_get_property("logDriver")
end

#log_driver=(value) ⇒ Object 



108
109
110
111
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 108

def log_driver=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkxvZ0RyaXZlciJ9")), "logDriver") unless value.nil?
  jsii_set_property("logDriver", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


45
46
47
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 45

def node()
  jsii_get_property("node")
end

#register_ecs_targets(service, container, targets) ⇒ AWSCDK::ElasticLoadBalancingv2::NetworkTargetGroup

Parameters:

Returns:



175
176
177
178
179
180
181
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 175

def register_ecs_targets(service, container, targets)
  Jsii::Type.check_type(service, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkJhc2VTZXJ2aWNlIn0=")), "service")
  Jsii::Type.check_type(container, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNvbnRhaW5lckRlZmluaXRpb24ifQ==")), "container")
  targets = targets.is_a?(Array) ? targets.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::ECSPatterns::NetworkTargetProps.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : targets
  Jsii::Type.check_type(targets, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3NfcGF0dGVybnMuTmV0d29ya1RhcmdldFByb3BzIn0sImtpbmQiOiJhcnJheSJ9fQ==")), "targets")
  jsii_call_method("registerECSTargets", [service, container, targets])
end

#target_groups ⇒ Array<AWSCDK::ElasticLoadBalancingv2::NetworkTargetGroup>

The target groups of the service.

Returns:



89
90
91
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 89

def target_groups()
  jsii_get_property("targetGroups")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) 


116
117
118
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 116

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>) —

    The mixins to apply.

Returns:

  • (Constructs::IConstruct) —

    This construct for chaining



129
130
131
132
133
134
 
# File 'ecs_patterns/network_multiple_target_groups_service_base.rb', line 129

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