Package software.amazon.awscdk.services.ecs.patterns

Interface NetworkMultipleTargetGroupsServiceBaseProps

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Subinterfaces:
NetworkMultipleTargetGroupsEc2ServiceProps, NetworkMultipleTargetGroupsFargateServiceProps
All Known Implementing Classes:
NetworkMultipleTargetGroupsEc2ServiceProps.Jsii$Proxy, NetworkMultipleTargetGroupsFargateServiceProps.Jsii$Proxy, NetworkMultipleTargetGroupsServiceBaseProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.104.0 (build e79254c)", date="2024-11-15T10:24:58.975Z") @Stability(Stable) public interface NetworkMultipleTargetGroupsServiceBaseProps extends software.amazon.jsii.JsiiSerializable
The properties for the base NetworkMultipleTargetGroupsEc2Service or NetworkMultipleTargetGroupsFargateService service.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.*;
 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.*;
 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)
         .enableExecuteCommand(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();

  • Method Details

    • getCloudMapOptions

      @Stability(Stable) @Nullable default CloudMapOptions getCloudMapOptions()
      The options for configuring an Amazon ECS service to use service discovery.

      Default: - AWS Cloud Map service discovery is not enabled.

    • getCluster

      @Stability(Stable) @Nullable default ICluster getCluster()
      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.

    • getDesiredCount

      @Stability(Stable) @Nullable default Number getDesiredCount()
      The desired number of instantiations of the task definition to keep running on the service.

      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.

    • getEnableECSManagedTags

      @Stability(Stable) @Nullable default Boolean getEnableECSManagedTags()
      Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

      For more information, see Tagging Your Amazon ECS Resources

      Default: false

    • getEnableExecuteCommand

      @Stability(Stable) @Nullable default Boolean getEnableExecuteCommand()
      Whether ECS Exec should be enabled.

      Default: - false

    • getHealthCheckGracePeriod

      @Stability(Stable) @Nullable 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: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

    • getLoadBalancers

      @Stability(Stable) @Nullable default List<NetworkLoadBalancerProps> getLoadBalancers()
      The network load balancer that will serve traffic to the service.

      Default: - a new load balancer with a listener will be created.

    • getPropagateTags

      @Stability(Stable) @Nullable default PropagatedTagSource getPropagateTags()
      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

    • getServiceName

      @Stability(Stable) @Nullable default String getServiceName()
      Name of the service.

      Default: - CloudFormation-generated name.

    • getTargetGroups

      @Stability(Stable) @Nullable default List<NetworkTargetProps> getTargetGroups()
      Properties to specify NLB target groups.

      Default: - default portMapping registered as target group and attached to the first defined listener

    • getTaskImageOptions

      @Stability(Stable) @Nullable default NetworkLoadBalancedTaskImageProps getTaskImageOptions()
      The properties required to create a new task definition.

      Only one of TaskDefinition or TaskImageOptions must be specified.

      Default: - none

    • getVpc

      @Stability(Stable) @Nullable default IVpc getVpc()
      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.

    • builder

      @Stability(Stable) static NetworkMultipleTargetGroupsServiceBaseProps.Builder builder()
      Returns:
      a NetworkMultipleTargetGroupsServiceBaseProps.Builder of NetworkMultipleTargetGroupsServiceBaseProps