-
Notifications
You must be signed in to change notification settings - Fork 17
/
NetworkLoadBalancedFargateServiceProps.go
226 lines (223 loc) · 11.1 KB
/
NetworkLoadBalancedFargateServiceProps.go
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
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
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
package awsecspatterns
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsec2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsecs"
"github.com/aws/aws-cdk-go/awscdk/v2/awselasticloadbalancingv2"
"github.com/aws/aws-cdk-go/awscdk/v2/awsroute53"
)
// The properties for the NetworkLoadBalancedFargateService service.
//
// Example:
// var vpc vpc
// var securityGroup securityGroup
//
// queueProcessingFargateService := ecsPatterns.NewNetworkLoadBalancedFargateService(this, jsii.String("Service"), &NetworkLoadBalancedFargateServiceProps{
// Vpc: Vpc,
// MemoryLimitMiB: jsii.Number(512),
// TaskImageOptions: &NetworkLoadBalancedTaskImageOptions{
// Image: ecs.ContainerImage_FromRegistry(jsii.String("amazon/amazon-ecs-sample")),
// },
// SecurityGroups: []iSecurityGroup{
// securityGroup,
// },
// })
//
type NetworkLoadBalancedFargateServiceProps struct {
// A list of Capacity Provider strategies used to place a service.
// Default: - undefined.
//
CapacityProviderStrategies *[]*awsecs.CapacityProviderStrategy `field:"optional" json:"capacityProviderStrategies" yaml:"capacityProviderStrategies"`
// Whether to enable the deployment circuit breaker.
//
// If this property is defined, circuit breaker will be implicitly
// enabled.
// Default: - disabled.
//
CircuitBreaker *awsecs.DeploymentCircuitBreaker `field:"optional" json:"circuitBreaker" yaml:"circuitBreaker"`
// The options for configuring an Amazon ECS service to use service discovery.
// Default: - AWS Cloud Map service discovery is not enabled.
//
CloudMapOptions *awsecs.CloudMapOptions `field:"optional" json:"cloudMapOptions" yaml:"cloudMapOptions"`
// 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.
// Default: - create a new cluster; if both cluster and vpc are omitted, a new VPC will be created for you.
//
Cluster awsecs.ICluster `field:"optional" json:"cluster" yaml:"cluster"`
// Specifies which deployment controller to use for the service.
//
// For more information, see
// [Amazon ECS Deployment Types](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/deployment-types.html)
// Default: - Rolling update (ECS).
//
DeploymentController *awsecs.DeploymentController `field:"optional" json:"deploymentController" yaml:"deploymentController"`
// The desired number of instantiations of the task definition to keep running on the service.
//
// The minimum value is 1.
// Default: - The default is 1 for all new services and uses the existing service's desired count
// when updating an existing service.
//
DesiredCount *float64 `field:"optional" json:"desiredCount" yaml:"desiredCount"`
// The domain name for the service, e.g. "api.example.com.".
// Default: - No domain name.
//
DomainName *string `field:"optional" json:"domainName" yaml:"domainName"`
// The Route53 hosted zone for the domain, e.g. "example.com.".
// Default: - No Route53 hosted domain zone.
//
DomainZone awsroute53.IHostedZone `field:"optional" json:"domainZone" yaml:"domainZone"`
// Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
//
// For more information, see
// [Tagging Your Amazon ECS Resources](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/ecs-using-tags.html)
// Default: false.
//
EnableECSManagedTags *bool `field:"optional" json:"enableECSManagedTags" yaml:"enableECSManagedTags"`
// Whether ECS Exec should be enabled.
// Default: - false.
//
EnableExecuteCommand *bool `field:"optional" json:"enableExecuteCommand" yaml:"enableExecuteCommand"`
// 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.
// Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set.
//
HealthCheckGracePeriod awscdk.Duration `field:"optional" json:"healthCheckGracePeriod" yaml:"healthCheckGracePeriod"`
// Listener port of the network load balancer that will serve traffic to the service.
// Default: 80.
//
ListenerPort *float64 `field:"optional" json:"listenerPort" yaml:"listenerPort"`
// The network load balancer that will serve traffic to the service.
//
// If the load balancer has been imported, the vpc attribute must be specified
// in the call to fromNetworkLoadBalancerAttributes().
//
// [disable-awslint:ref-via-interface].
// Default: - a new load balancer will be created.
//
LoadBalancer awselasticloadbalancingv2.INetworkLoadBalancer `field:"optional" json:"loadBalancer" yaml:"loadBalancer"`
// The maximum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that can run in a service during a deployment.
// Default: - 100 if daemon, otherwise 200.
//
MaxHealthyPercent *float64 `field:"optional" json:"maxHealthyPercent" yaml:"maxHealthyPercent"`
// The minimum number of tasks, specified as a percentage of the Amazon ECS service's DesiredCount value, that must continue to run and remain healthy during a deployment.
// Default: - 0 if daemon, otherwise 50.
//
MinHealthyPercent *float64 `field:"optional" json:"minHealthyPercent" yaml:"minHealthyPercent"`
// 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.
// Default: - none.
//
PropagateTags awsecs.PropagatedTagSource `field:"optional" json:"propagateTags" yaml:"propagateTags"`
// Determines whether the Load Balancer will be internet-facing.
// Default: true.
//
PublicLoadBalancer *bool `field:"optional" json:"publicLoadBalancer" yaml:"publicLoadBalancer"`
// Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
//
// This is useful if you need to work with DNS systems that do not support alias records.
// Default: NetworkLoadBalancedServiceRecordType.ALIAS
//
RecordType NetworkLoadBalancedServiceRecordType `field:"optional" json:"recordType" yaml:"recordType"`
// The name of the service.
// Default: - CloudFormation-generated name.
//
ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
// The properties required to create a new task definition.
//
// One of taskImageOptions or taskDefinition must be specified.
// Default: - none.
//
TaskImageOptions *NetworkLoadBalancedTaskImageOptions `field:"optional" json:"taskImageOptions" yaml:"taskImageOptions"`
// 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.
// Default: - uses the VPC defined in the cluster or creates a new VPC.
//
Vpc awsec2.IVpc `field:"optional" json:"vpc" yaml:"vpc"`
// The number of cpu units used by the task.
//
// Valid values, which determines your range of valid values for the memory parameter:
//
// 256 (.25 vCPU) - Available memory values: 0.5GB, 1GB, 2GB
//
// 512 (.5 vCPU) - Available memory values: 1GB, 2GB, 3GB, 4GB
//
// 1024 (1 vCPU) - Available memory values: 2GB, 3GB, 4GB, 5GB, 6GB, 7GB, 8GB
//
// 2048 (2 vCPU) - Available memory values: Between 4GB and 16GB in 1GB increments
//
// 4096 (4 vCPU) - Available memory values: Between 8GB and 30GB in 1GB increments
//
// 8192 (8 vCPU) - Available memory values: Between 16GB and 60GB in 4GB increments
//
// 16384 (16 vCPU) - Available memory values: Between 32GB and 120GB in 8GB increments
//
// This default is set in the underlying FargateTaskDefinition construct.
// Default: 256.
//
Cpu *float64 `field:"optional" json:"cpu" yaml:"cpu"`
// The amount (in GiB) of ephemeral storage to be allocated to the task.
//
// The minimum supported value is `21` GiB and the maximum supported value is `200` GiB.
//
// Only supported in Fargate platform version 1.4.0 or later.
// Default: Undefined, in which case, the task will receive 20GiB ephemeral storage.
//
EphemeralStorageGiB *float64 `field:"optional" json:"ephemeralStorageGiB" yaml:"ephemeralStorageGiB"`
// The amount (in MiB) of memory used by the task.
//
// This field is required and you must use one of the following values, which determines your range of valid values
// for the cpu parameter:
//
// 512 (0.5 GB), 1024 (1 GB), 2048 (2 GB) - Available cpu values: 256 (.25 vCPU)
//
// 1024 (1 GB), 2048 (2 GB), 3072 (3 GB), 4096 (4 GB) - Available cpu values: 512 (.5 vCPU)
//
// 2048 (2 GB), 3072 (3 GB), 4096 (4 GB), 5120 (5 GB), 6144 (6 GB), 7168 (7 GB), 8192 (8 GB) - Available cpu values: 1024 (1 vCPU)
//
// Between 4096 (4 GB) and 16384 (16 GB) in increments of 1024 (1 GB) - Available cpu values: 2048 (2 vCPU)
//
// Between 8192 (8 GB) and 30720 (30 GB) in increments of 1024 (1 GB) - Available cpu values: 4096 (4 vCPU)
//
// Between 16384 (16 GB) and 61440 (60 GB) in increments of 4096 (4 GB) - Available cpu values: 8192 (8 vCPU)
//
// Between 32768 (32 GB) and 122880 (120 GB) in increments of 8192 (8 GB) - Available cpu values: 16384 (16 vCPU)
//
// This default is set in the underlying FargateTaskDefinition construct.
// Default: 512.
//
MemoryLimitMiB *float64 `field:"optional" json:"memoryLimitMiB" yaml:"memoryLimitMiB"`
// The platform version on which to run your service.
//
// If one is not specified, the LATEST platform version is used by default. For more information, see
// [AWS Fargate Platform Versions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html)
// in the Amazon Elastic Container Service Developer Guide.
// Default: Latest.
//
PlatformVersion awsecs.FargatePlatformVersion `field:"optional" json:"platformVersion" yaml:"platformVersion"`
// The runtime platform of the task definition.
// Default: - If the property is undefined, `operatingSystemFamily` is LINUX and `cpuArchitecture` is X86_64.
//
RuntimePlatform *awsecs.RuntimePlatform `field:"optional" json:"runtimePlatform" yaml:"runtimePlatform"`
// The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
//
// [disable-awslint:ref-via-interface].
// Default: - none.
//
TaskDefinition awsecs.FargateTaskDefinition `field:"optional" json:"taskDefinition" yaml:"taskDefinition"`
// Determines whether the service will be assigned a public IP address.
// Default: false.
//
AssignPublicIp *bool `field:"optional" json:"assignPublicIp" yaml:"assignPublicIp"`
// The security groups to associate with the service.
//
// If you do not specify a security group, a new security group is created.
// Default: - A new security group is created.
//
SecurityGroups *[]awsec2.ISecurityGroup `field:"optional" json:"securityGroups" yaml:"securityGroups"`
// The subnets to associate with the service.
// Default: - Public subnets if `assignPublicIp` is set, otherwise the first available one of Private, Isolated, Public, in that order.
//
TaskSubnets *awsec2.SubnetSelection `field:"optional" json:"taskSubnets" yaml:"taskSubnets"`
}