@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
date="2023-03-22T19:35:50.920Z")
public interface NetworkMultipleTargetGroupsServiceBaseProps
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.ec2.*; import software.amazon.awscdk.services.ecs.*; import software.amazon.awscdk.services.ecs.patterns.*; import software.amazon.awscdk.services.iam.*; import software.amazon.awscdk.services.route53.*; import software.amazon.awscdk.services.servicediscovery.*; import software.amazon.awscdk.core.*; Cluster cluster; ContainerDefinition containerDefinition; ContainerImage containerImage; HostedZone hostedZone; LogDriver logDriver; INamespace namespace; Role role; Secret secret; Vpc vpc; NetworkMultipleTargetGroupsServiceBaseProps networkMultipleTargetGroupsServiceBaseProps = NetworkMultipleTargetGroupsServiceBaseProps.builder() .cloudMapOptions(CloudMapOptions.builder() .cloudMapNamespace(namespace) .container(containerDefinition) .containerPort(123) .dnsRecordType(DnsRecordType.A) .dnsTtl(Duration.minutes(30)) .failureThreshold(123) .name("name") .build()) .cluster(cluster) .desiredCount(123) .enableECSManagedTags(false) .healthCheckGracePeriod(Duration.minutes(30)) .loadBalancers(List.of(NetworkLoadBalancerProps.builder() .listeners(List.of(NetworkListenerProps.builder() .name("name") // the properties below are optional .port(123) .build())) .name("name") // the properties below are optional .domainName("domainName") .domainZone(hostedZone) .publicLoadBalancer(false) .build())) .propagateTags(PropagatedTagSource.SERVICE) .serviceName("serviceName") .targetGroups(List.of(NetworkTargetProps.builder() .containerPort(123) // the properties below are optional .listener("listener") .build())) .taskImageOptions(NetworkLoadBalancedTaskImageProps.builder() .image(containerImage) // the properties below are optional .containerName("containerName") .containerPorts(List.of(123)) .dockerLabels(Map.of( "dockerLabelsKey", "dockerLabels")) .enableLogging(false) .environment(Map.of( "environmentKey", "environment")) .executionRole(role) .family("family") .logDriver(logDriver) .secrets(Map.of( "secretsKey", secret)) .taskRole(role) .build()) .vpc(vpc) .build();
Modifier and Type | Interface and Description |
---|---|
static class |
NetworkMultipleTargetGroupsServiceBaseProps.Builder
A builder for
NetworkMultipleTargetGroupsServiceBaseProps |
static class |
NetworkMultipleTargetGroupsServiceBaseProps.Jsii$Proxy
An implementation for
NetworkMultipleTargetGroupsServiceBaseProps |
Modifier and Type | Method and Description |
---|---|
static NetworkMultipleTargetGroupsServiceBaseProps.Builder |
builder() |
default CloudMapOptions |
getCloudMapOptions()
The options for configuring an Amazon ECS service to use service discovery.
|
default ICluster |
getCluster()
The name of the cluster that hosts the service.
|
default java.lang.Number |
getDesiredCount()
The desired number of instantiations of the task definition to keep running on the service.
|
default java.lang.Boolean |
getEnableECSManagedTags()
Specifies whether to enable Amazon ECS managed tags for the tasks within the service.
|
default Duration |
getHealthCheckGracePeriod()
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 java.util.List<NetworkLoadBalancerProps> |
getLoadBalancers()
The network load balancer that will serve traffic to the service.
|
default PropagatedTagSource |
getPropagateTags()
Specifies whether to propagate the tags from the task definition or the service to the tasks in the service.
|
default java.lang.String |
getServiceName()
Name of the service.
|
default java.util.List<NetworkTargetProps> |
getTargetGroups()
Properties to specify NLB target groups.
|
default NetworkLoadBalancedTaskImageProps |
getTaskImageOptions()
The properties required to create a new task definition.
|
default IVpc |
getVpc()
The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed.
|
default CloudMapOptions getCloudMapOptions()
Default: - AWS Cloud Map service discovery is not enabled.
default ICluster getCluster()
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.
default java.lang.Number getDesiredCount()
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.
default java.lang.Boolean getEnableECSManagedTags()
For more information, see Tagging Your Amazon ECS Resources
Default: false
default Duration getHealthCheckGracePeriod()
Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set
default java.util.List<NetworkLoadBalancerProps> getLoadBalancers()
Default: - a new load balancer with a listener will be created.
default PropagatedTagSource getPropagateTags()
Tags can only be propagated to the tasks within the service during service creation.
Default: - none
default java.lang.String getServiceName()
Default: - CloudFormation-generated name.
default java.util.List<NetworkTargetProps> getTargetGroups()
Default: - default portMapping registered as target group and attached to the first defined listener
default NetworkLoadBalancedTaskImageProps getTaskImageOptions()
Only one of TaskDefinition or TaskImageOptions must be specified.
Default: - none
default IVpc getVpc()
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.
static NetworkMultipleTargetGroupsServiceBaseProps.Builder builder()