Class ApplicationLoadBalancedServiceBaseProps
The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class ApplicationLoadBalancedServiceBaseProps : IApplicationLoadBalancedServiceBasePropsSyntax (vb)
Public Class ApplicationLoadBalancedServiceBaseProps Implements IApplicationLoadBalancedServiceBasePropsRemarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CertificateManager;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.ECS.Patterns;
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Route53;
using Amazon.CDK.AWS.ServiceDiscovery;
ApplicationLoadBalancer applicationLoadBalancer;
Certificate certificate;
Cluster cluster;
ContainerDefinition containerDefinition;
ContainerImage containerImage;
HostedZone hostedZone;
LogDriver logDriver;
INamespace namespace;
Role role;
Secret secret;
Vpc vpc;
var applicationLoadBalancedServiceBaseProps = new ApplicationLoadBalancedServiceBaseProps {
CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
Certificate = certificate,
CircuitBreaker = new DeploymentCircuitBreaker {
Enable = false,
Rollback = false
},
CloudMapOptions = new CloudMapOptions {
CloudMapNamespace = namespace,
Container = containerDefinition,
ContainerPort = 123,
DnsRecordType = DnsRecordType.A,
DnsTtl = Duration.Minutes(30),
FailureThreshold = 123,
Name = "name"
},
Cluster = cluster,
DeploymentController = new DeploymentController {
Type = DeploymentControllerType.ECS
},
DesiredCount = 123,
DomainName = "domainName",
DomainZone = hostedZone,
EnableECSManagedTags = false,
EnableExecuteCommand = false,
HealthCheckGracePeriod = Duration.Minutes(30),
IdleTimeout = Duration.Minutes(30),
IpAddressType = IpAddressType.IPV4,
ListenerPort = 123,
LoadBalancer = applicationLoadBalancer,
LoadBalancerName = "loadBalancerName",
MaxHealthyPercent = 123,
MinHealthyPercent = 123,
OpenListener = false,
PropagateTags = PropagatedTagSource.SERVICE,
Protocol = ApplicationProtocol.HTTP,
ProtocolVersion = ApplicationProtocolVersion.GRPC,
PublicLoadBalancer = false,
RecordType = ApplicationLoadBalancedServiceRecordType.ALIAS,
RedirectHTTP = false,
ServiceName = "serviceName",
SslPolicy = SslPolicy.RECOMMENDED_TLS,
TargetProtocol = ApplicationProtocol.HTTP,
TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions {
Image = containerImage,
// the properties below are optional
Command = new [] { "command" },
ContainerName = "containerName",
ContainerPort = 123,
DockerLabels = new Dictionary<string, string> {
{ "dockerLabelsKey", "dockerLabels" }
},
EnableLogging = false,
EntryPoint = new [] { "entryPoint" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
ExecutionRole = role,
Family = "family",
LogDriver = logDriver,
Secrets = new Dictionary<string, Secret> {
{ "secretsKey", secret }
},
TaskRole = role
},
Vpc = vpc
};Synopsis
Constructors
| ApplicationLoadBalancedServiceBaseProps() | The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service. |
Properties
| CapacityProviderStrategies | A list of Capacity Provider strategies used to place a service. |
| Certificate | Certificate Manager certificate to associate with the load balancer. |
| CircuitBreaker | Whether to enable the deployment circuit breaker. |
| CloudMapOptions | The options for configuring an Amazon ECS service to use service discovery. |
| Cluster | The name of the cluster that hosts the service. |
| DeploymentController | Specifies which deployment controller to use for the service. |
| DesiredCount | The desired number of instantiations of the task definition to keep running on the service. |
| DomainName | The domain name for the service, e.g. "api.example.com.". |
| DomainZone | The Route53 hosted zone for the domain, e.g. "example.com.". |
| EnableECSManagedTags | Specifies whether to enable Amazon ECS managed tags for the tasks within the service. |
| EnableExecuteCommand | Whether ECS Exec should be enabled. |
| HealthCheckGracePeriod | 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. |
| IdleTimeout | The load balancer idle timeout, in seconds. |
| IpAddressType | The type of IP address to use. |
| ListenerPort | Listener port of the application load balancer that will serve traffic to the service. |
| LoadBalancer | The application load balancer that will serve traffic to the service. |
| LoadBalancerName | Name of the load balancer. |
| MaxHealthyPercent | 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. |
| MinHealthyPercent | 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. |
| OpenListener | Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default. |
| PropagateTags | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
| Protocol | The protocol for connections from clients to the load balancer. |
| ProtocolVersion | The protocol version to use. |
| PublicLoadBalancer | Determines whether the Load Balancer will be internet-facing. |
| RecordType | Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all. |
| RedirectHTTP | Specifies whether the load balancer should redirect traffic on port 80 to the {@link listenerPort} to support HTTP->HTTPS redirects. |
| ServiceName | The name of the service. |
| SslPolicy | The security policy that defines which ciphers and protocols are supported by the ALB Listener. |
| TargetProtocol | The protocol for connections from the load balancer to the ECS tasks. |
| TaskImageOptions | The properties required to create a new task definition. |
| Vpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
Constructors
ApplicationLoadBalancedServiceBaseProps()
The properties for the base ApplicationLoadBalancedEc2Service or ApplicationLoadBalancedFargateService service.
public ApplicationLoadBalancedServiceBaseProps()Remarks
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK;
using Amazon.CDK.AWS.CertificateManager;
using Amazon.CDK.AWS.EC2;
using Amazon.CDK.AWS.ECS;
using Amazon.CDK.AWS.ECS.Patterns;
using Amazon.CDK.AWS.ElasticLoadBalancingV2;
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.Route53;
using Amazon.CDK.AWS.ServiceDiscovery;
ApplicationLoadBalancer applicationLoadBalancer;
Certificate certificate;
Cluster cluster;
ContainerDefinition containerDefinition;
ContainerImage containerImage;
HostedZone hostedZone;
LogDriver logDriver;
INamespace namespace;
Role role;
Secret secret;
Vpc vpc;
var applicationLoadBalancedServiceBaseProps = new ApplicationLoadBalancedServiceBaseProps {
CapacityProviderStrategies = new [] { new CapacityProviderStrategy {
CapacityProvider = "capacityProvider",
// the properties below are optional
Base = 123,
Weight = 123
} },
Certificate = certificate,
CircuitBreaker = new DeploymentCircuitBreaker {
Enable = false,
Rollback = false
},
CloudMapOptions = new CloudMapOptions {
CloudMapNamespace = namespace,
Container = containerDefinition,
ContainerPort = 123,
DnsRecordType = DnsRecordType.A,
DnsTtl = Duration.Minutes(30),
FailureThreshold = 123,
Name = "name"
},
Cluster = cluster,
DeploymentController = new DeploymentController {
Type = DeploymentControllerType.ECS
},
DesiredCount = 123,
DomainName = "domainName",
DomainZone = hostedZone,
EnableECSManagedTags = false,
EnableExecuteCommand = false,
HealthCheckGracePeriod = Duration.Minutes(30),
IdleTimeout = Duration.Minutes(30),
IpAddressType = IpAddressType.IPV4,
ListenerPort = 123,
LoadBalancer = applicationLoadBalancer,
LoadBalancerName = "loadBalancerName",
MaxHealthyPercent = 123,
MinHealthyPercent = 123,
OpenListener = false,
PropagateTags = PropagatedTagSource.SERVICE,
Protocol = ApplicationProtocol.HTTP,
ProtocolVersion = ApplicationProtocolVersion.GRPC,
PublicLoadBalancer = false,
RecordType = ApplicationLoadBalancedServiceRecordType.ALIAS,
RedirectHTTP = false,
ServiceName = "serviceName",
SslPolicy = SslPolicy.RECOMMENDED_TLS,
TargetProtocol = ApplicationProtocol.HTTP,
TaskImageOptions = new ApplicationLoadBalancedTaskImageOptions {
Image = containerImage,
// the properties below are optional
Command = new [] { "command" },
ContainerName = "containerName",
ContainerPort = 123,
DockerLabels = new Dictionary<string, string> {
{ "dockerLabelsKey", "dockerLabels" }
},
EnableLogging = false,
EntryPoint = new [] { "entryPoint" },
Environment = new Dictionary<string, string> {
{ "environmentKey", "environment" }
},
ExecutionRole = role,
Family = "family",
LogDriver = logDriver,
Secrets = new Dictionary<string, Secret> {
{ "secretsKey", secret }
},
TaskRole = role
},
Vpc = vpc
};Properties
CapacityProviderStrategies
A list of Capacity Provider strategies used to place a service.
public ICapacityProviderStrategy[]? CapacityProviderStrategies { get; set; }Property Value
Remarks
Default: - undefined
Certificate
Certificate Manager certificate to associate with the load balancer.
public ICertificate? Certificate { get; set; }Property Value
Remarks
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.
CircuitBreaker
Whether to enable the deployment circuit breaker.
public IDeploymentCircuitBreaker? CircuitBreaker { get; set; }Property Value
Remarks
If this property is defined, circuit breaker will be implicitly enabled.
Default: - disabled
CloudMapOptions
The options for configuring an Amazon ECS service to use service discovery.
public ICloudMapOptions? CloudMapOptions { get; set; }Property Value
Remarks
Default: - AWS Cloud Map service discovery is not enabled.
Cluster
The name of the cluster that hosts the service.
public ICluster? Cluster { get; set; }Property Value
Remarks
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.
DeploymentController
Specifies which deployment controller to use for the service.
public IDeploymentController? DeploymentController { get; set; }Property Value
Remarks
For more information, see Amazon ECS Deployment Types
Default: - Rolling update (ECS)
DesiredCount
The desired number of instantiations of the task definition to keep running on the service.
public double? DesiredCount { get; set; }Property Value
Remarks
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.
DomainName
The domain name for the service, e.g. "api.example.com.".
public string? DomainName { get; set; }Property Value
Remarks
Default: - No domain name.
DomainZone
The Route53 hosted zone for the domain, e.g. "example.com.".
public IHostedZone? DomainZone { get; set; }Property Value
Remarks
Default: - No Route53 hosted domain zone.
EnableECSManagedTags
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
public bool? EnableECSManagedTags { get; set; }Property Value
bool?
Remarks
For more information, see Tagging Your Amazon ECS Resources
Default: false
EnableExecuteCommand
Whether ECS Exec should be enabled.
public bool? EnableExecuteCommand { get; set; }Property Value
bool?
Remarks
Default: - false
HealthCheckGracePeriod
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.
public Duration? HealthCheckGracePeriod { get; set; }Property Value
Remarks
Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
IdleTimeout
The load balancer idle timeout, in seconds.
public Duration? IdleTimeout { get; set; }Property Value
Remarks
Can be between 1 and 4000 seconds
Default: - CloudFormation sets idle timeout to 60 seconds
IpAddressType
The type of IP address to use.
public IpAddressType? IpAddressType { get; set; }Property Value
Remarks
Default: - IpAddressType.IPV4
ListenerPort
Listener port of the application load balancer that will serve traffic to the service.
public double? ListenerPort { get; set; }Property Value
Remarks
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.
LoadBalancer
The application load balancer that will serve traffic to the service.
public IApplicationLoadBalancer? LoadBalancer { get; set; }Property Value
Remarks
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.
LoadBalancerName
Name of the load balancer.
public string? LoadBalancerName { get; set; }Property Value
Remarks
Default: - Automatically generated name.
MaxHealthyPercent
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.
public double? MaxHealthyPercent { get; set; }Property Value
Remarks
Default: - 100 if daemon, otherwise 200
MinHealthyPercent
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.
public double? MinHealthyPercent { get; set; }Property Value
Remarks
Default: - 0 if daemon, otherwise 50
OpenListener
Determines whether or not the Security Group for the Load Balancer's Listener will be open to all traffic by default.
public bool? OpenListener { get; set; }Property Value
bool?
Remarks
Default: true -- The security group allows ingress from all IP addresses.
PropagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
public PropagatedTagSource? PropagateTags { get; set; }Property Value
Remarks
Tags can only be propagated to the tasks within the service during service creation.
Default: - none
Protocol
The protocol for connections from clients to the load balancer.
public ApplicationProtocol? Protocol { get; set; }Property Value
Remarks
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.
ProtocolVersion
The protocol version to use.
public ApplicationProtocolVersion? ProtocolVersion { get; set; }Property Value
Remarks
Default: ApplicationProtocolVersion.HTTP1
PublicLoadBalancer
Determines whether the Load Balancer will be internet-facing.
public bool? PublicLoadBalancer { get; set; }Property Value
bool?
Remarks
Default: true
RecordType
Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
public ApplicationLoadBalancedServiceRecordType? RecordType { get; set; }Property Value
ApplicationLoadBalancedServiceRecordType?
Remarks
This is useful if you need to work with DNS systems that do not support alias records.
Default: ApplicationLoadBalancedServiceRecordType.ALIAS
RedirectHTTP
Specifies whether the load balancer should redirect traffic on port 80 to the {@link listenerPort} to support HTTP->HTTPS redirects.
public bool? RedirectHTTP { get; set; }Property Value
bool?
Remarks
This is only valid if the protocol of the ALB is HTTPS.
Default: false
ServiceName
The name of the service.
public string? ServiceName { get; set; }Property Value
Remarks
Default: - CloudFormation-generated name.
SslPolicy
The security policy that defines which ciphers and protocols are supported by the ALB Listener.
public SslPolicy? SslPolicy { get; set; }Property Value
Remarks
Default: - The recommended elastic load balancing security policy
TargetProtocol
The protocol for connections from the load balancer to the ECS tasks.
public ApplicationProtocol? TargetProtocol { get; set; }Property Value
Remarks
The default target port is determined from the protocol (port 80 for HTTP, port 443 for HTTPS).
Default: HTTP.
TaskImageOptions
The properties required to create a new task definition.
public IApplicationLoadBalancedTaskImageOptions? TaskImageOptions { get; set; }Property Value
IApplicationLoadBalancedTaskImageOptions
Remarks
TaskDefinition or TaskImageOptions must be specified, but not both.
Default: none
Vpc
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
public IVpc? Vpc { get; set; }Property Value
Remarks
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.