Class NetworkLoadBalancedFargateServiceProps
The properties for the NetworkLoadBalancedFargateService service.
Inheritance
Namespace: Amazon.CDK.AWS.ECS.Patterns
Assembly: Amazon.CDK.AWS.ECS.Patterns.dll
Syntax (csharp)
public class NetworkLoadBalancedFargateServiceProps : Object, INetworkLoadBalancedFargateServiceProps, INetworkLoadBalancedServiceBaseProps
Syntax (vb)
Public Class NetworkLoadBalancedFargateServiceProps
Inherits Object
Implements INetworkLoadBalancedFargateServiceProps, INetworkLoadBalancedServiceBaseProps
Remarks
ExampleMetadata: infused
Examples
Cluster cluster;
var loadBalancedFargateService = new NetworkLoadBalancedFargateService(this, "Service", new NetworkLoadBalancedFargateServiceProps {
Cluster = cluster,
MemoryLimitMiB = 1024,
Cpu = 512,
TaskImageOptions = new NetworkLoadBalancedTaskImageOptions {
Image = ContainerImage.FromRegistry("amazon/amazon-ecs-sample")
}
});
Synopsis
Constructors
NetworkLoadBalancedFargateServiceProps() |
Properties
AssignPublicIp | Determines whether the service will be assigned a public IP address. |
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. |
Cpu | The number of cpu units used by the task. |
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. |
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. |
ListenerPort | Listener port of the network load balancer that will serve traffic to the service. |
LoadBalancer | The network load balancer that will serve traffic to the service. |
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. |
MemoryLimitMiB | The amount (in MiB) of memory used by the task. |
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. |
PlatformVersion | The platform version on which to run your service. |
PropagateTags | Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. |
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. |
ServiceName | The name of the service. |
TaskDefinition | The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both. |
TaskImageOptions | The properties required to create a new task definition. |
TaskSubnets | The subnets to associate with the service. |
Vpc | The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. |
Constructors
NetworkLoadBalancedFargateServiceProps()
public NetworkLoadBalancedFargateServiceProps()
Properties
AssignPublicIp
Determines whether the service will be assigned a public IP address.
public Nullable<bool> AssignPublicIp { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
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.
Cpu
The number of cpu units used by the task.
public Nullable<double> Cpu { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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: 256
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 Nullable<double> DesiredCount { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
The minimum value is 1
Default: - If the feature flag, ECS_REMOVE_DEFAULT_DESIRED_COUNT is false, the default is 1; if true, the default is 1 for all new services and uses the existing services 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
System.String
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 Nullable<bool> EnableECSManagedTags { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
For more information, see Tagging Your Amazon ECS Resources
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
ListenerPort
Listener port of the network load balancer that will serve traffic to the service.
public Nullable<double> ListenerPort { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: 80
LoadBalancer
The network load balancer that will serve traffic to the service.
public INetworkLoadBalancer LoadBalancer { get; set; }
Property Value
Remarks
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.
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 Nullable<double> MaxHealthyPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 100 if daemon, otherwise 200
MemoryLimitMiB
The amount (in MiB) of memory used by the task.
public Nullable<double> MemoryLimitMiB { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
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)
This default is set in the underlying FargateTaskDefinition construct.
Default: 512
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 Nullable<double> MinHealthyPercent { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Default: - 0 if daemon, otherwise 50
PlatformVersion
The platform version on which to run your service.
public Nullable<FargatePlatformVersion> PlatformVersion { get; set; }
Property Value
System.Nullable<FargatePlatformVersion>
Remarks
If one is not specified, the LATEST platform version is used by default. For more information, see AWS Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.
Default: Latest
PropagateTags
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
public Nullable<PropagatedTagSource> PropagateTags { get; set; }
Property Value
System.Nullable<PropagatedTagSource>
Remarks
Tags can only be propagated to the tasks within the service during service creation.
Default: - none
PublicLoadBalancer
Determines whether the Load Balancer will be internet-facing.
public Nullable<bool> PublicLoadBalancer { get; set; }
Property Value
System.Nullable<System.Boolean>
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 Nullable<NetworkLoadBalancedServiceRecordType> RecordType { get; set; }
Property Value
System.Nullable<NetworkLoadBalancedServiceRecordType>
Remarks
This is useful if you need to work with DNS systems that do not support alias records.
Default: NetworkLoadBalancedServiceRecordType.ALIAS
ServiceName
The name of the service.
public string ServiceName { get; set; }
Property Value
System.String
Remarks
Default: - CloudFormation-generated name.
TaskDefinition
The task definition to use for tasks in the service. TaskDefinition or TaskImageOptions must be specified, but not both.
public FargateTaskDefinition TaskDefinition { get; set; }
Property Value
Remarks
[disable-awslint:ref-via-interface]
Default: - none
TaskImageOptions
The properties required to create a new task definition.
public INetworkLoadBalancedTaskImageOptions TaskImageOptions { get; set; }
Property Value
INetworkLoadBalancedTaskImageOptions
Remarks
One of taskImageOptions or taskDefinition must be specified.
Default: - none
TaskSubnets
The subnets to associate with the service.
public ISubnetSelection TaskSubnets { get; set; }
Property Value
Remarks
Default: - Public subnets if assignPublicIp
is set, otherwise the first available one of Private, Isolated, Public, in that order.
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.