-
Notifications
You must be signed in to change notification settings - Fork 17
/
ApplicationLoadBalancedEc2ServiceProps.go
260 lines (257 loc) · 12.8 KB
/
ApplicationLoadBalancedEc2ServiceProps.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
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
package awsecspatterns
import (
"github.com/aws/aws-cdk-go/awscdk/v2"
"github.com/aws/aws-cdk-go/awscdk/v2/awscertificatemanager"
"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 ApplicationLoadBalancedEc2Service service.
//
// Example:
// var cluster cluster
//
// loadBalancedEcsService := ecsPatterns.NewApplicationLoadBalancedEc2Service(this, jsii.String("Service"), &ApplicationLoadBalancedEc2ServiceProps{
// Cluster: Cluster,
// MemoryLimitMiB: jsii.Number(1024),
// TaskImageOptions: &ApplicationLoadBalancedTaskImageOptions{
// Image: ecs.ContainerImage_FromRegistry(jsii.String("test")),
// Environment: map[string]*string{
// "TEST_ENVIRONMENT_VARIABLE1": jsii.String("test environment variable 1 value"),
// "TEST_ENVIRONMENT_VARIABLE2": jsii.String("test environment variable 2 value"),
// },
// Command: []*string{
// jsii.String("command"),
// },
// EntryPoint: []*string{
// jsii.String("entry"),
// jsii.String("point"),
// },
// },
// DesiredCount: jsii.Number(2),
// })
//
type ApplicationLoadBalancedEc2ServiceProps struct {
// A list of Capacity Provider strategies used to place a service.
// Default: - undefined.
//
CapacityProviderStrategies *[]*awsecs.CapacityProviderStrategy `field:"optional" json:"capacityProviderStrategies" yaml:"capacityProviderStrategies"`
// Certificate Manager certificate to associate with the load balancer.
//
// Setting this option will set the load balancer protocol to HTTPS.
// Default: - No certificate associated with the load balancer, if using
// the HTTP protocol. For HTTPS, a DNS-validated certificate will be
// created for the load balancer's specified domain name if a domain name
// and domain zone are specified.
//
Certificate awscertificatemanager.ICertificate `field:"optional" json:"certificate" yaml:"certificate"`
// 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"`
// The load balancer idle timeout, in seconds.
//
// Can be between 1 and 4000 seconds.
// Default: - CloudFormation sets idle timeout to 60 seconds.
//
IdleTimeout awscdk.Duration `field:"optional" json:"idleTimeout" yaml:"idleTimeout"`
// Listener port of the application load balancer that will serve traffic to the service.
// Default: - The default listener port is determined from the protocol (port 80 for HTTP,
// port 443 for HTTPS). A domain name and zone must be also be specified if using HTTPS.
//
ListenerPort *float64 `field:"optional" json:"listenerPort" yaml:"listenerPort"`
// The application load balancer that will serve traffic to the service.
//
// The VPC attribute of a load balancer must be specified for it to be used
// to create a new service with this pattern.
//
// [disable-awslint:ref-via-interface].
// Default: - a new load balancer will be created.
//
LoadBalancer awselasticloadbalancingv2.IApplicationLoadBalancer `field:"optional" json:"loadBalancer" yaml:"loadBalancer"`
// Name of the load balancer.
// Default: - Automatically generated name.
//
LoadBalancerName *string `field:"optional" json:"loadBalancerName" yaml:"loadBalancerName"`
// 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"`
// Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
// Default: true -- The security group allows ingress from all IP addresses.
//
OpenListener *bool `field:"optional" json:"openListener" yaml:"openListener"`
// 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"`
// The protocol for connections from clients to the load balancer.
//
// The load balancer port is determined from the protocol (port 80 for
// HTTP, port 443 for HTTPS). If HTTPS, either a certificate or domain
// name and domain zone must also be specified.
// Default: HTTP. If a certificate is specified, the protocol will be
// set by default to HTTPS.
//
Protocol awselasticloadbalancingv2.ApplicationProtocol `field:"optional" json:"protocol" yaml:"protocol"`
// The protocol version to use.
// Default: ApplicationProtocolVersion.HTTP1
//
ProtocolVersion awselasticloadbalancingv2.ApplicationProtocolVersion `field:"optional" json:"protocolVersion" yaml:"protocolVersion"`
// 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: ApplicationLoadBalancedServiceRecordType.ALIAS
//
RecordType ApplicationLoadBalancedServiceRecordType `field:"optional" json:"recordType" yaml:"recordType"`
// Specifies whether the load balancer should redirect traffic on port 80 to port 443 to support HTTP->HTTPS redirects This is only valid if the protocol of the ALB is HTTPS.
// Default: false.
//
RedirectHTTP *bool `field:"optional" json:"redirectHTTP" yaml:"redirectHTTP"`
// The name of the service.
// Default: - CloudFormation-generated name.
//
ServiceName *string `field:"optional" json:"serviceName" yaml:"serviceName"`
// The security policy that defines which ciphers and protocols are supported by the ALB Listener.
// Default: - The recommended elastic load balancing security policy.
//
SslPolicy awselasticloadbalancingv2.SslPolicy `field:"optional" json:"sslPolicy" yaml:"sslPolicy"`
// The protocol for connections from the load balancer to the ECS tasks.
//
// The default target port is determined from the protocol (port 80 for
// HTTP, port 443 for HTTPS).
// Default: HTTP.
//
TargetProtocol awselasticloadbalancingv2.ApplicationProtocol `field:"optional" json:"targetProtocol" yaml:"targetProtocol"`
// The properties required to create a new task definition.
//
// TaskDefinition or TaskImageOptions must be specified, but not both.
// Default: none.
//
TaskImageOptions *ApplicationLoadBalancedTaskImageOptions `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
//
// This default is set in the underlying FargateTaskDefinition construct.
// Default: none.
//
Cpu *float64 `field:"optional" json:"cpu" yaml:"cpu"`
// The hard limit (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.
// Default: - No memory limit.
//
MemoryLimitMiB *float64 `field:"optional" json:"memoryLimitMiB" yaml:"memoryLimitMiB"`
// The soft limit (in MiB) of memory to reserve for the container.
//
// When system memory is under contention, Docker attempts to keep the
// container memory within the limit. If the container requires more memory,
// it can consume up to the value specified by the Memory property or all of
// the available memory on the container instance—whichever comes first.
//
// At least one of memoryLimitMiB and memoryReservationMiB is required.
// Default: - No memory reserved.
//
MemoryReservationMiB *float64 `field:"optional" json:"memoryReservationMiB" yaml:"memoryReservationMiB"`
// The placement constraints to use for tasks in the service.
//
// For more information, see
// [Amazon ECS Task Placement Constraints](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-constraints.html).
// Default: - No constraints.
//
PlacementConstraints *[]awsecs.PlacementConstraint `field:"optional" json:"placementConstraints" yaml:"placementConstraints"`
// The placement strategies to use for tasks in the service.
//
// For more information, see
// [Amazon ECS Task Placement Strategies](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-placement-strategies.html).
// Default: - No strategies.
//
PlacementStrategies *[]awsecs.PlacementStrategy `field:"optional" json:"placementStrategies" yaml:"placementStrategies"`
// 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.Ec2TaskDefinition `field:"optional" json:"taskDefinition" yaml:"taskDefinition"`
}