|
export interface NetworkLoadBalancedServiceBaseProps { |
|
/** |
|
* 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. |
|
*/ |
|
readonly cluster?: ICluster; |
|
|
|
/** |
|
* 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. |
|
*/ |
|
readonly vpc?: IVpc; |
|
|
|
/** |
|
* The properties required to create a new task definition. One of taskImageOptions or taskDefinition must be specified. |
|
* |
|
* @default - none |
|
*/ |
|
readonly taskImageOptions?: NetworkLoadBalancedTaskImageOptions; |
|
|
|
/** |
|
* Determines whether the Load Balancer will be internet-facing. |
|
* |
|
* @default true |
|
*/ |
|
readonly publicLoadBalancer?: boolean; |
|
|
|
/** |
|
* The desired number of instantiations of the task definition to keep running on the service. |
|
* |
|
* @default 1 |
|
*/ |
|
readonly desiredCount?: number; |
|
|
|
/** |
|
* The domain name for the service, e.g. "api.example.com." |
|
* |
|
* @default - No domain name. |
|
*/ |
|
readonly domainName?: string; |
|
|
|
/** |
|
* The Route53 hosted zone for the domain, e.g. "example.com." |
|
* |
|
* @default - No Route53 hosted domain zone. |
|
*/ |
|
readonly domainZone?: IHostedZone; |
|
|
|
/** |
|
* The name of the service. |
|
* |
|
* @default - CloudFormation-generated name. |
|
*/ |
|
readonly serviceName?: string; |
|
|
|
/** |
|
* 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 |
|
*/ |
|
readonly healthCheckGracePeriod?: cdk.Duration; |
|
|
|
/** |
|
* The network load balancer that will serve traffic to the service. |
|
* |
|
* [disable-awslint:ref-via-interface] |
|
* |
|
* @default - a new load balancer will be created. |
|
*/ |
|
readonly loadBalancer?: NetworkLoadBalancer; |
|
|
|
/** |
|
* 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 |
|
*/ |
|
readonly propagateTags?: PropagatedTagSource; |
|
|
|
/** |
|
* 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 |
|
*/ |
|
readonly enableECSManagedTags?: boolean; |
|
|
|
/** |
|
* The options for configuring an Amazon ECS service to use service discovery. |
|
* |
|
* @default - AWS Cloud Map service discovery is not enabled. |
|
*/ |
|
readonly cloudMapOptions?: CloudMapOptions; |
|
} |