Class: AWSCDK::ECSPatterns::ApplicationMultipleTargetGroupsEC2ServiceProps

Inherits:
ApplicationMultipleTargetGroupsServiceBaseProps
  • Object
show all
Defined in:
ecs_patterns/application_multiple_target_groups_ec2_service_props.rb

Overview

The properties for the ApplicationMultipleTargetGroupsEc2Service service.

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(cloud_map_options: nil, cluster: nil, desired_count: nil, enable_ecs_managed_tags: nil, enable_execute_command: nil, health_check_grace_period: nil, load_balancers: nil, propagate_tags: nil, service_name: nil, target_groups: nil, task_image_options: nil, vpc: nil, cpu: nil, memory_limit_mib: nil, memory_reservation_mib: nil, placement_constraints: nil, placement_strategies: nil, task_definition: nil) ⇒ ApplicationMultipleTargetGroupsEC2ServiceProps

Returns a new instance of ApplicationMultipleTargetGroupsEC2ServiceProps.

Parameters:

  • cloud_map_options (AWSCDK::ECS::CloudMapOptions, nil) (defaults to: nil) —

    The options for configuring an Amazon ECS service to use service discovery.

  • cluster (AWSCDK::ECS::ICluster, nil) (defaults to: nil) —

    The name of the cluster that hosts the service.

  • desired_count (Numeric, nil) (defaults to: nil) —

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

  • enable_ecs_managed_tags (Boolean, nil) (defaults to: nil) —

    Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

  • enable_execute_command (Boolean, nil) (defaults to: nil) —

    Whether ECS Exec should be enabled.

  • health_check_grace_period (AWSCDK::Duration, nil) (defaults to: nil) —

    The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

  • load_balancers (Array<AWSCDK::ECSPatterns::ApplicationLoadBalancerProps>, nil) (defaults to: nil) —

    The application load balancer that will serve traffic to the service.

  • propagate_tags (AWSCDK::ECS::PropagatedTagSource, nil) (defaults to: nil) —

    Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

  • service_name (String, nil) (defaults to: nil) —

    The name of the service.

  • target_groups (Array<AWSCDK::ECSPatterns::ApplicationTargetProps>, nil) (defaults to: nil) —

    Properties to specify ALB target groups.

  • task_image_options (AWSCDK::ECSPatterns::ApplicationLoadBalancedTaskImageProps, nil) (defaults to: nil) —

    The properties required to create a new task definition.

  • vpc (AWSCDK::EC2::IVPC, nil) (defaults to: nil) —

    The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

  • cpu (Numeric, nil) (defaults to: nil) —

    The minimum number of CPU units to reserve for the container.

  • memory_limit_mib (Numeric, nil) (defaults to: nil) —

    The amount (in MiB) of memory to present to the container.

  • memory_reservation_mib (Numeric, nil) (defaults to: nil) —

    The soft limit (in MiB) of memory to reserve for the container.

  • placement_constraints (Array<AWSCDK::ECS::PlacementConstraint>, nil) (defaults to: nil) —

    The placement constraints to use for tasks in the service.

  • placement_strategies (Array<AWSCDK::ECS::PlacementStrategy>, nil) (defaults to: nil) —

    The placement strategies to use for tasks in the service.

  • task_definition (AWSCDK::ECS::EC2TaskDefinition, nil) (defaults to: nil) —

    The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.



25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 25

def initialize(cloud_map_options: nil, cluster: nil, desired_count: nil, enable_ecs_managed_tags: nil, enable_execute_command: nil, health_check_grace_period: nil, load_balancers: nil, propagate_tags: nil, service_name: nil, target_groups: nil, task_image_options: nil, vpc: nil, cpu: nil, memory_limit_mib: nil, memory_reservation_mib: nil, placement_constraints: nil, placement_strategies: nil, task_definition: nil)
  @cloud_map_options = cloud_map_options.is_a?(Hash) ? ::AWSCDK::ECS::CloudMapOptions.new(**cloud_map_options.transform_keys(&:to_sym)) : cloud_map_options
  Jsii::Type.check_type(@cloud_map_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkNsb3VkTWFwT3B0aW9ucyJ9")), "cloudMapOptions") unless @cloud_map_options.nil?
  @cluster = cluster
  Jsii::Type.check_type(@cluster, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLklDbHVzdGVyIn0=")), "cluster") unless @cluster.nil?
  @desired_count = desired_count
  Jsii::Type.check_type(@desired_count, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "desiredCount") unless @desired_count.nil?
  @enable_ecs_managed_tags = enable_ecs_managed_tags
  Jsii::Type.check_type(@enable_ecs_managed_tags, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enableECSManagedTags") unless @enable_ecs_managed_tags.nil?
  @enable_execute_command = enable_execute_command
  Jsii::Type.check_type(@enable_execute_command, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJib29sZWFuIn0=")), "enableExecuteCommand") unless @enable_execute_command.nil?
  @health_check_grace_period = health_check_grace_period
  Jsii::Type.check_type(@health_check_grace_period, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5EdXJhdGlvbiJ9")), "healthCheckGracePeriod") unless @health_check_grace_period.nil?
  @load_balancers = load_balancers.is_a?(Array) ? load_balancers.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::ECSPatterns::ApplicationLoadBalancerProps.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : load_balancers
  Jsii::Type.check_type(@load_balancers, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3NfcGF0dGVybnMuQXBwbGljYXRpb25Mb2FkQmFsYW5jZXJQcm9wcyJ9LCJraW5kIjoiYXJyYXkifX0=")), "loadBalancers") unless @load_balancers.nil?
  @propagate_tags = propagate_tags
  Jsii::Type.check_type(@propagate_tags, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLlByb3BhZ2F0ZWRUYWdTb3VyY2UifQ==")), "propagateTags") unless @propagate_tags.nil?
  @service_name = service_name
  Jsii::Type.check_type(@service_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "serviceName") unless @service_name.nil?
  @target_groups = target_groups.is_a?(Array) ? target_groups.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::ECSPatterns::ApplicationTargetProps.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : target_groups
  Jsii::Type.check_type(@target_groups, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3NfcGF0dGVybnMuQXBwbGljYXRpb25UYXJnZXRQcm9wcyJ9LCJraW5kIjoiYXJyYXkifX0=")), "targetGroups") unless @target_groups.nil?
  @task_image_options = task_image_options.is_a?(Hash) ? ::AWSCDK::ECSPatterns::ApplicationLoadBalancedTaskImageProps.new(**task_image_options.transform_keys(&:to_sym)) : task_image_options
  Jsii::Type.check_type(@task_image_options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzX3BhdHRlcm5zLkFwcGxpY2F0aW9uTG9hZEJhbGFuY2VkVGFza0ltYWdlUHJvcHMifQ==")), "taskImageOptions") unless @task_image_options.nil?
  @vpc = vpc
  Jsii::Type.check_type(@vpc, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWMyLklWcGMifQ==")), "vpc") unless @vpc.nil?
  @cpu = cpu
  Jsii::Type.check_type(@cpu, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "cpu") unless @cpu.nil?
  @memory_limit_mib = memory_limit_mib
  Jsii::Type.check_type(@memory_limit_mib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "memoryLimitMiB") unless @memory_limit_mib.nil?
  @memory_reservation_mib = memory_reservation_mib
  Jsii::Type.check_type(@memory_reservation_mib, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJudW1iZXIifQ==")), "memoryReservationMiB") unless @memory_reservation_mib.nil?
  @placement_constraints = placement_constraints
  Jsii::Type.check_type(@placement_constraints, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuUGxhY2VtZW50Q29uc3RyYWludCJ9LCJraW5kIjoiYXJyYXkifX0=")), "placementConstraints") unless @placement_constraints.nil?
  @placement_strategies = placement_strategies
  Jsii::Type.check_type(@placement_strategies, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLmF3c19lY3MuUGxhY2VtZW50U3RyYXRlZ3kifSwia2luZCI6ImFycmF5In19")), "placementStrategies") unless @placement_strategies.nil?
  @task_definition = task_definition
  Jsii::Type.check_type(@task_definition, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZWNzLkVjMlRhc2tEZWZpbml0aW9uIn0=")), "taskDefinition") unless @task_definition.nil?
end

Instance Attribute Details

#cloud_map_options ⇒ AWSCDK::ECS::CloudMapOptions? (readonly)

Note:

Default: - AWS Cloud Map service discovery is not enabled.

The options for configuring an Amazon ECS service to use service discovery.

Returns:



68
69
70
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 68

def cloud_map_options
  @cloud_map_options
end

#cluster ⇒ AWSCDK::ECS::ICluster? (readonly)

Note:

Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.

The name of the cluster that hosts the service.

If a cluster is specified, the vpc construct should be omitted. Alternatively, you can omit both cluster and vpc.

Returns:



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

def cluster
  @cluster
end

#cpu ⇒ Numeric? (readonly)

Note:

Default: - No minimum CPU units reserved.

The minimum number of CPU units to reserve for the container.

Valid values, which determines your range of valid values for the memory parameter:

Returns:

  • (Numeric, nil) 


141
142
143
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 141

def cpu
  @cpu
end

#desired_count ⇒ Numeric? (readonly)

Note:

Default: - The default is 1 for all new services and uses the existing service's desired count when updating an existing service.

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

Returns:

  • (Numeric, nil) 


80
81
82
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 80

def desired_count
  @desired_count
end

#enable_ecs_managed_tags ⇒ Boolean? (readonly)

Note:

Default: false

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

For more information, see Tagging Your Amazon ECS Resources

Returns:

  • (Boolean, nil) 


88
89
90
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 88

def enable_ecs_managed_tags
  @enable_ecs_managed_tags
end

#enable_execute_command ⇒ Boolean? (readonly)

Note:

Default: - false

Whether ECS Exec should be enabled.

Returns:

  • (Boolean, nil) 


93
94
95
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 93

def enable_execute_command
  @enable_execute_command
end

#health_check_grace_period ⇒ AWSCDK::Duration? (readonly)

Note:

Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

The period of time, in seconds, that the Amazon ECS service scheduler ignores unhealthy Elastic Load Balancing target health checks after a task has first started.

Returns:



98
99
100
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 98

def health_check_grace_period
  @health_check_grace_period
end

#load_balancers ⇒ Array<AWSCDK::ECSPatterns::ApplicationLoadBalancerProps>? (readonly)

Note:

Default: - a new load balancer with a listener will be created.

The application load balancer that will serve traffic to the service.

Returns:



103
104
105
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 103

def load_balancers
  @load_balancers
end

#memory_limit_mib ⇒ Numeric? (readonly)

Note:

Default: - No memory limit.

The amount (in MiB) of memory to present to the container.

If your container attempts to exceed the allocated memory, the container is terminated.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Returns:

  • (Numeric, nil) 


151
152
153
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 151

def memory_limit_mib
  @memory_limit_mib
end

#memory_reservation_mib ⇒ Numeric? (readonly)

Note:

Default: - No memory reserved.

The soft limit (in MiB) of memory to reserve for the container.

When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

At least one of memoryLimitMiB and memoryReservationMiB is required.

Note that this setting will be ignored if TaskImagesOptions is specified

Returns:

  • (Numeric, nil) 


166
167
168
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 166

def memory_reservation_mib
  @memory_reservation_mib
end

#placement_constraints ⇒ Array<AWSCDK::ECS::PlacementConstraint>? (readonly)

Note:

Default: - No constraints.

The placement constraints to use for tasks in the service.

For more information, see Amazon ECS Task Placement Constraints.

Returns:



174
175
176
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 174

def placement_constraints
  @placement_constraints
end

#placement_strategies ⇒ Array<AWSCDK::ECS::PlacementStrategy>? (readonly)

Note:

Default: - No strategies.

The placement strategies to use for tasks in the service.

For more information, see Amazon ECS Task Placement Strategies.

Returns:



182
183
184
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 182

def placement_strategies
  @placement_strategies
end

#propagate_tags ⇒ AWSCDK::ECS::PropagatedTagSource? (readonly)

Note:

Default: - none

Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.

Tags can only be propagated to the tasks within the service during service creation.

Returns:



110
111
112
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 110

def propagate_tags
  @propagate_tags
end

#service_name ⇒ String? (readonly)

Note:

Default: - CloudFormation-generated name.

The name of the service.

Returns:

  • (String, nil) 


115
116
117
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 115

def service_name
  @service_name
end

#target_groups ⇒ Array<AWSCDK::ECSPatterns::ApplicationTargetProps>? (readonly)

Note:

Default: - default portMapping registered as target group and attached to the first defined listener

Properties to specify ALB target groups.

Returns:



120
121
122
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 120

def target_groups
  @target_groups
end

#task_definition ⇒ AWSCDK::ECS::EC2TaskDefinition? (readonly)

Note:

Default: - none

The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.

[disable-awslint:ref-via-interface]

Returns:



189
190
191
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 189

def task_definition
  @task_definition
end

#task_image_options ⇒ AWSCDK::ECSPatterns::ApplicationLoadBalancedTaskImageProps? (readonly)

Note:

Default: none

The properties required to create a new task definition.

Only one of TaskDefinition or TaskImageOptions must be specified.

Returns:



127
128
129
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 127

def task_image_options
  @task_image_options
end

#vpc ⇒ AWSCDK::EC2::IVPC? (readonly)

Note:

Default: - uses the VPC defined in the cluster or creates a new VPC.

The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

If a vpc is specified, the cluster construct should be omitted. Alternatively, you can omit both vpc and cluster.

Returns:



134
135
136
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 134

def vpc
  @vpc
end

Class Method Details

.jsii_properties ⇒ Object 



191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 191

def self.jsii_properties
  {
    :cloud_map_options => "cloudMapOptions",
    :cluster => "cluster",
    :desired_count => "desiredCount",
    :enable_ecs_managed_tags => "enableECSManagedTags",
    :enable_execute_command => "enableExecuteCommand",
    :health_check_grace_period => "healthCheckGracePeriod",
    :load_balancers => "loadBalancers",
    :propagate_tags => "propagateTags",
    :service_name => "serviceName",
    :target_groups => "targetGroups",
    :task_image_options => "taskImageOptions",
    :vpc => "vpc",
    :cpu => "cpu",
    :memory_limit_mib => "memoryLimitMiB",
    :memory_reservation_mib => "memoryReservationMiB",
    :placement_constraints => "placementConstraints",
    :placement_strategies => "placementStrategies",
    :task_definition => "taskDefinition",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
 
# File 'ecs_patterns/application_multiple_target_groups_ec2_service_props.rb', line 214

def to_jsii
  result = {}
  result.merge!(super)
  result.merge!({
    "cloudMapOptions" => @cloud_map_options,
    "cluster" => @cluster,
    "desiredCount" => @desired_count,
    "enableECSManagedTags" => @enable_ecs_managed_tags,
    "enableExecuteCommand" => @enable_execute_command,
    "healthCheckGracePeriod" => @health_check_grace_period,
    "loadBalancers" => @load_balancers,
    "propagateTags" => @propagate_tags,
    "serviceName" => @service_name,
    "targetGroups" => @target_groups,
    "taskImageOptions" => @task_image_options,
    "vpc" => @vpc,
    "cpu" => @cpu,
    "memoryLimitMiB" => @memory_limit_mib,
    "memoryReservationMiB" => @memory_reservation_mib,
    "placementConstraints" => @placement_constraints,
    "placementStrategies" => @placement_strategies,
    "taskDefinition" => @task_definition,
  })
  result.compact
end