interface NetworkLoadBalancedServiceBaseProps

Language	Type name
.NET	`Amazon.CDK.AWS.ECS.Patterns.NetworkLoadBalancedServiceBaseProps`
Go	`github.com/aws/aws-cdk-go/awscdk/v2/awsecspatterns#NetworkLoadBalancedServiceBaseProps`
Java	`software.amazon.awscdk.services.ecs.patterns.NetworkLoadBalancedServiceBaseProps`
Python	`aws_cdk.aws_ecs_patterns.NetworkLoadBalancedServiceBaseProps`
TypeScript (source)	`aws-cdk-lib` » `aws_ecs_patterns` » `NetworkLoadBalancedServiceBaseProps`

The properties for the base NetworkLoadBalancedEc2Service or NetworkLoadBalancedFargateService service.

Example

// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import * as cdk from 'aws-cdk-lib';
import { aws_ec2 as ec2 } from 'aws-cdk-lib';
import { aws_ecs as ecs } from 'aws-cdk-lib';
import { aws_ecs_patterns as ecs_patterns } from 'aws-cdk-lib';
import { aws_elasticloadbalancingv2 as elbv2 } from 'aws-cdk-lib';
import { aws_iam as iam } from 'aws-cdk-lib';
import { aws_route53 as route53 } from 'aws-cdk-lib';
import { aws_servicediscovery as servicediscovery } from 'aws-cdk-lib';

declare const cluster: ecs.Cluster;
declare const containerDefinition: ecs.ContainerDefinition;
declare const containerImage: ecs.ContainerImage;
declare const hostedZone: route53.HostedZone;
declare const listenerCertificate: elbv2.ListenerCertificate;
declare const logDriver: ecs.LogDriver;
declare const namespace: servicediscovery.INamespace;
declare const networkLoadBalancer: elbv2.NetworkLoadBalancer;
declare const role: iam.Role;
declare const secret: ecs.Secret;
declare const vpc: ec2.Vpc;
const networkLoadBalancedServiceBaseProps: ecs_patterns.NetworkLoadBalancedServiceBaseProps = {
  capacityProviderStrategies: [{
    capacityProvider: 'capacityProvider',

    // the properties below are optional
    base: 123,
    weight: 123,
  }],
  circuitBreaker: {
    enable: false,
    rollback: false,
  },
  cloudMapOptions: {
    cloudMapNamespace: namespace,
    container: containerDefinition,
    containerPort: 123,
    dnsRecordType: servicediscovery.DnsRecordType.A,
    dnsTtl: cdk.Duration.minutes(30),
    failureThreshold: 123,
    name: 'name',
  },
  cluster: cluster,
  deploymentController: {
    type: ecs.DeploymentControllerType.ECS,
  },
  desiredCount: 123,
  domainName: 'domainName',
  domainZone: hostedZone,
  enableECSManagedTags: false,
  enableExecuteCommand: false,
  healthCheckGracePeriod: cdk.Duration.minutes(30),
  ipAddressType: elbv2.IpAddressType.IPV4,
  listenerCertificate: listenerCertificate,
  listenerPort: 123,
  loadBalancer: networkLoadBalancer,
  maxHealthyPercent: 123,
  minHealthyPercent: 123,
  propagateTags: ecs.PropagatedTagSource.SERVICE,
  publicLoadBalancer: false,
  recordType: ecs_patterns.NetworkLoadBalancedServiceRecordType.ALIAS,
  serviceName: 'serviceName',
  taskImageOptions: {
    image: containerImage,

    // the properties below are optional
    containerName: 'containerName',
    containerPort: 123,
    dockerLabels: {
      dockerLabelsKey: 'dockerLabels',
    },
    enableLogging: false,
    environment: {
      environmentKey: 'environment',
    },
    executionRole: role,
    family: 'family',
    logDriver: logDriver,
    secrets: {
      secretsKey: secret,
    },
    taskRole: role,
  },
  vpc: vpc,
};

Properties

Name	Type	Description
capacityProviderStrategies?	`CapacityProviderStrategy[]`	A list of Capacity Provider strategies used to place a service.
circuitBreaker?	`DeploymentCircuitBreaker`	Whether to enable the deployment circuit breaker.
cloudMapOptions?	`CloudMapOptions`	The options for configuring an Amazon ECS service to use service discovery.
cluster?	`ICluster`	The name of the cluster that hosts the service.
deploymentController?	`DeploymentController`	Specifies which deployment controller to use for the service.
desiredCount?	`number`	The desired number of instantiations of the task definition to keep running on the service.
domainName?	`string`	The domain name for the service, e.g. "api.example.com.".
domainZone?	`IHostedZone`	The Route53 hosted zone for the domain, e.g. "example.com.".
enableECSManagedTags?	`boolean`	Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
enableExecuteCommand?	`boolean`	Whether ECS Exec should be enabled.
healthCheckGracePeriod?	`Duration`	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.
ipAddressType?	`IpAddressType`	The type of IP addresses to use.
listenerCertificate?	`IListenerCertificate`	Listener certificate list of ACM cert ARNs.
listenerPort?	`number`	Listener port of the network load balancer that will serve traffic to the service.
loadBalancer?	`INetworkLoadBalancer`	The network load balancer that will serve traffic to the service.
maxHealthyPercent?	`number`	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?	`number`	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.
propagateTags?	`PropagatedTagSource`	Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
publicLoadBalancer?	`boolean`	Determines whether the Load Balancer will be internet-facing.
recordType?	`NetworkLoadBalancedServiceRecordType`	Specifies whether the Route53 record should be a CNAME, an A record using the Alias feature or no record at all.
serviceName?	`string`	The name of the service.
taskImageOptions?	`NetworkLoadBalancedTaskImageOptions`	The properties required to create a new task definition.
vpc?	`IVpc`	The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.

capacityProviderStrategies?

Type: CapacityProviderStrategy[] (optional, default: undefined)

A list of Capacity Provider strategies used to place a service.

circuitBreaker?

Type: DeploymentCircuitBreaker (optional, default: disabled)

Whether to enable the deployment circuit breaker.

If this property is defined, circuit breaker will be implicitly enabled.

cloudMapOptions?

Type: CloudMapOptions (optional, default: AWS Cloud Map service discovery is not enabled.)

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

cluster?

Type: ICluster (optional, 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.

deploymentController?

Type: DeploymentController (optional, default: Rolling update (ECS))

Specifies which deployment controller to use for the service.

For more information, see Amazon ECS Deployment Types

desiredCount?

Type: number (optional, 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.

The minimum value is 1

domainName?

Type: string (optional, default: No domain name.)

The domain name for the service, e.g. "api.example.com.".

domainZone?

Type: IHostedZone (optional, default: No Route53 hosted domain zone.)

The Route53 hosted zone for the domain, e.g. "example.com.".

enableECSManagedTags?

Type: boolean (optional, 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

enableExecuteCommand?

Type: boolean (optional, default: false)

Whether ECS Exec should be enabled.

healthCheckGracePeriod?

Type: Duration (optional, 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.

ipAddressType?

Type: IpAddressType (optional, default: IpAddressType.IPV4)

The type of IP addresses to use.

If you want to add a UDP or TCP_UDP listener to the load balancer, you must choose IPv4.

listenerCertificate?

Type: IListenerCertificate (optional, default: none)

Listener certificate list of ACM cert ARNs.

If you provide a certificate, the listener's protocol will be TLS. If not, the listener's protocol will be TCP.

listenerPort?

Type: number (optional, default: 80 or 443 with listenerCertificate provided)

Listener port of the network load balancer that will serve traffic to the service.

loadBalancer?

Type: INetworkLoadBalancer (optional, default: a new load balancer will be created.)

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]

maxHealthyPercent?

Type: number (optional, default: 100 if daemon, otherwise 200)

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?

Type: number (optional, default: 0 if daemon, otherwise 50)

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.

propagateTags?

Type: PropagatedTagSource (optional, 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.

publicLoadBalancer?

Type: boolean (optional, default: true)

Determines whether the Load Balancer will be internet-facing.

recordType?

Type: NetworkLoadBalancedServiceRecordType (optional, default: NetworkLoadBalancedServiceRecordType.ALIAS)

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.

serviceName?

Type: string (optional, default: CloudFormation-generated name.)

The name of the service.

taskImageOptions?

Type: NetworkLoadBalancedTaskImageOptions (optional, default: none)

The properties required to create a new task definition.

One of taskImageOptions or taskDefinition must be specified.

vpc?

Type: IVpc (optional, 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.