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

Class NetworkMultipleTargetGroupsEc2Service.Builder

java.lang.Object
software.amazon.awscdk.services.ecs.patterns.NetworkMultipleTargetGroupsEc2Service.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<NetworkMultipleTargetGroupsEc2Service>
Enclosing class:
NetworkMultipleTargetGroupsEc2Service
@Stability(Stable) public static final class NetworkMultipleTargetGroupsEc2Service.Builder extends Object implements software.amazon.jsii.Builder<NetworkMultipleTargetGroupsEc2Service>
A fluent builder for NetworkMultipleTargetGroupsEc2Service.

  • Method Details

    • create

      @Stability(Stable) public static NetworkMultipleTargetGroupsEc2Service.Builder create(software.constructs.Construct scope, String id)
      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      Returns:
      a new instance of NetworkMultipleTargetGroupsEc2Service.Builder.

    • cloudMapOptions

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder cloudMapOptions(CloudMapOptions cloudMapOptions)
      The options for configuring an Amazon ECS service to use service discovery.

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

      Parameters:
      cloudMapOptions - The options for configuring an Amazon ECS service to use service discovery. This parameter is required.
      Returns:
      this

    • cluster

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder cluster(ICluster cluster)
      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.

      Parameters:
      cluster - The name of the cluster that hosts the service. This parameter is required.
      Returns:
      this

    • desiredCount

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder desiredCount(Number desiredCount)
      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.

      Parameters:
      desiredCount - The desired number of instantiations of the task definition to keep running on the service. This parameter is required.
      Returns:
      this

    • enableEcsManagedTags

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder enableEcsManagedTags(Boolean enableEcsManagedTags)
      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

      Parameters:
      enableEcsManagedTags - Specifies whether to enable Amazon ECS managed tags for the tasks within the service. This parameter is required.
      Returns:
      this

    • enableExecuteCommand

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder enableExecuteCommand(Boolean enableExecuteCommand)
      Whether ECS Exec should be enabled.

      Default: - false

      Parameters:
      enableExecuteCommand - Whether ECS Exec should be enabled. This parameter is required.
      Returns:
      this

    • healthCheckGracePeriod

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder healthCheckGracePeriod(Duration 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.

      Default: - defaults to 60 seconds if at least one load balancer is in-use and it is not already set

      Parameters:
      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. This parameter is required.
      Returns:
      this

    • loadBalancers

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder loadBalancers(List<? extends NetworkLoadBalancerProps> loadBalancers)
      The network load balancer that will serve traffic to the service.

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

      Parameters:
      loadBalancers - The network load balancer that will serve traffic to the service. This parameter is required.
      Returns:
      this

    • propagateTags

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder propagateTags(PropagatedTagSource propagateTags)
      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

      Parameters:
      propagateTags - Specifies whether to propagate the tags from the task definition or the service to the tasks in the service. This parameter is required.
      Returns:
      this

    • serviceName

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder serviceName(String serviceName)
      Name of the service.

      Default: - CloudFormation-generated name.

      Parameters:
      serviceName - Name of the service. This parameter is required.
      Returns:
      this

    • targetGroups

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder targetGroups(List<? extends NetworkTargetProps> targetGroups)
      Properties to specify NLB target groups.

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

      Parameters:
      targetGroups - Properties to specify NLB target groups. This parameter is required.
      Returns:
      this

    • taskImageOptions

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder taskImageOptions(NetworkLoadBalancedTaskImageProps taskImageOptions)
      The properties required to create a new task definition.

      Only one of TaskDefinition or TaskImageOptions must be specified.

      Default: - none

      Parameters:
      taskImageOptions - The properties required to create a new task definition. This parameter is required.
      Returns:
      this

    • vpc

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder vpc(IVpc 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.

      Default: - uses the VPC defined in the cluster or creates a new VPC.

      Parameters:
      vpc - The VPC where the container instances will be launched or the elastic network interfaces (ENIs) will be deployed. This parameter is required.
      Returns:
      this

    • cpu

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder cpu(Number cpu)
      The minimum number of CPU units to reserve for the container.

      Valid values, which determines your range of valid values for the memory parameter:

      Default: - No minimum CPU units reserved.

      Parameters:
      cpu - The minimum number of CPU units to reserve for the container. This parameter is required.
      Returns:
      this

    • memoryLimitMiB

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder memoryLimitMiB(Number memoryLimitMiB)
      The amount (in MiB) of memory to present to the container.

      If your container attempts to exceed the allocated memory, the container is terminated.

      At least one of memoryLimitMiB and memoryReservationMiB is required.

      Default: - No memory limit.

      Parameters:
      memoryLimitMiB - The amount (in MiB) of memory to present to the container. This parameter is required.
      Returns:
      this

    • memoryReservationMiB

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder memoryReservationMiB(Number memoryReservationMiB)
      The soft limit (in MiB) of memory to reserve for the container.

      When system memory is under heavy contention, Docker attempts to keep the container memory to this soft limit. However, your container can consume more memory when it needs to, up to either the hard limit specified with the memory parameter (if applicable), or all of the available memory on the container instance, whichever comes first.

      At least one of memoryLimitMiB and memoryReservationMiB is required.

      Note that this setting will be ignored if TaskImagesOptions is specified.

      Default: - No memory reserved.

      Parameters:
      memoryReservationMiB - The soft limit (in MiB) of memory to reserve for the container. This parameter is required.
      Returns:
      this

    • placementConstraints

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder placementConstraints(List<? extends PlacementConstraint> placementConstraints)
      The placement constraints to use for tasks in the service.

      For more information, see Amazon ECS Task Placement Constraints.

      Default: - No constraints.

      Parameters:
      placementConstraints - The placement constraints to use for tasks in the service. This parameter is required.
      Returns:
      this

    • placementStrategies

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder placementStrategies(List<? extends PlacementStrategy> placementStrategies)
      The placement strategies to use for tasks in the service.

      For more information, see Amazon ECS Task Placement Strategies.

      Default: - No strategies.

      Parameters:
      placementStrategies - The placement strategies to use for tasks in the service. This parameter is required.
      Returns:
      this

    • taskDefinition

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service.Builder taskDefinition(Ec2TaskDefinition taskDefinition)
      The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified.

      [disable-awslint:ref-via-interface]

      Default: - none

      Parameters:
      taskDefinition - The task definition to use for tasks in the service. Only one of TaskDefinition or TaskImageOptions must be specified. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public NetworkMultipleTargetGroupsEc2Service build()
      Specified by:
      build in interface software.amazon.jsii.Builder<NetworkMultipleTargetGroupsEc2Service>
      Returns:
      a newly built instance of NetworkMultipleTargetGroupsEc2Service.