Package com.pulumi.aws.ecs

Class ServiceArgs

  • public final class ServiceArgs
extends com.pulumi.resources.ResourceArgs

    • Method Detail

      • alarms

        public java.util.Optional<com.pulumi.core.Output<ServiceAlarmsArgs>> alarms()
        Returns:
        Information about the CloudWatch alarms. See below.

      • availabilityZoneRebalancing

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> availabilityZoneRebalancing()
        Returns:
        ECS automatically redistributes tasks within a service across Availability Zones (AZs) to mitigate the risk of impaired application availability due to underlying infrastructure failures and task lifecycle activities. The valid values are `ENABLED` and `DISABLED`. When creating a new service, if no value is specified, it defaults to `ENABLED` if the service is compatible with AvailabilityZoneRebalancing. When updating an existing service, if no value is specified it defaults to the existing service's AvailabilityZoneRebalancing value. If the service never had an AvailabilityZoneRebalancing value set, Amazon ECS treats this as `DISABLED`.

      • capacityProviderStrategies

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ServiceCapacityProviderStrategyArgs>>> capacityProviderStrategies()
        Returns:
        Capacity provider strategies to use for the service. Can be one or more. Updating this argument requires `forceNewDeployment = true`. See below. Conflicts with `launchType`.

      • cluster

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> cluster()
        Returns:
        ARN of an ECS cluster.

      • deploymentCircuitBreaker

        public java.util.Optional<com.pulumi.core.Output<ServiceDeploymentCircuitBreakerArgs>> deploymentCircuitBreaker()
        Returns:
        Configuration block for deployment circuit breaker. See below.

      • deploymentConfiguration

        public java.util.Optional<com.pulumi.core.Output<ServiceDeploymentConfigurationArgs>> deploymentConfiguration()
        Returns:
        Configuration block for deployment settings. See below.

      • deploymentController

        public java.util.Optional<com.pulumi.core.Output<ServiceDeploymentControllerArgs>> deploymentController()
        Returns:
        Configuration block for deployment controller configuration. See below.

      • deploymentMaximumPercent

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deploymentMaximumPercent()
        Returns:
        Upper limit (as a percentage of the service's desiredCount) of the number of running tasks that can be running in a service during a deployment. Not valid when using the `DAEMON` scheduling strategy.

      • deploymentMinimumHealthyPercent

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> deploymentMinimumHealthyPercent()
        Returns:
        Lower limit (as a percentage of the service's desiredCount) of the number of running tasks that must remain running and healthy in a service during a deployment.

      • desiredCount

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> desiredCount()
        Returns:
        Number of instances of the task definition to place and keep running. Defaults to 0. Do not specify if using the `DAEMON` scheduling strategy.

      • enableEcsManagedTags

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableEcsManagedTags()
        Returns:
        Whether to enable Amazon ECS managed tags for the tasks within the service.

      • enableExecuteCommand

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> enableExecuteCommand()
        Returns:
        Whether to enable Amazon ECS Exec for the tasks within the service.

      • forceDelete

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceDelete()
        Returns:
        Enable to delete a service even if it wasn't scaled down to zero tasks. It's only necessary to use this if the service uses the `REPLICA` scheduling strategy.

      • forceNewDeployment

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> forceNewDeployment()
        Returns:
        Enable to force a new task deployment of the service. This can be used to update tasks to use a newer Docker image with same image/tag combination (e.g., `myimage:latest`), roll Fargate tasks onto a newer platform version, or immediately deploy `orderedPlacementStrategy` and `placementConstraints` updates. When using the forceNewDeployment property you also need to configure the triggers property.

      • healthCheckGracePeriodSeconds

        public java.util.Optional<com.pulumi.core.Output<java.lang.Integer>> healthCheckGracePeriodSeconds()
        Returns:
        Seconds to ignore failing load balancer health checks on newly instantiated tasks to prevent premature shutdown, up to 2147483647. Only valid for services configured to use load balancers.

      • iamRole

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> iamRole()
        Returns:
        ARN of the IAM role that allows Amazon ECS to make calls to your load balancer on your behalf. This parameter is required if you are using a load balancer with your service, but only if your task definition does not use the `awsvpc` network mode. If using `awsvpc` network mode, do not specify this role. If your account has already created the Amazon ECS service-linked role, that role is used by default for your service unless you specify a role here.

      • launchType

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> launchType()
        Returns:
        Launch type on which to run your service. The valid values are `EC2`, `FARGATE`, and `EXTERNAL`. Defaults to `EC2`. Conflicts with `capacityProviderStrategy`.

      • loadBalancers

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ServiceLoadBalancerArgs>>> loadBalancers()
        Returns:
        Configuration block for load balancers. See below.

      • name

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> name()
        Returns:
        Name of the service (up to 255 letters, numbers, hyphens, and underscores) The following arguments are optional:

      • networkConfiguration

        public java.util.Optional<com.pulumi.core.Output<ServiceNetworkConfigurationArgs>> networkConfiguration()
        Returns:
        Network configuration for the service. This parameter is required for task definitions that use the `awsvpc` network mode to receive their own Elastic Network Interface, and it is not supported for other network modes. See below.

      • orderedPlacementStrategies

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ServiceOrderedPlacementStrategyArgs>>> orderedPlacementStrategies()
        Returns:
        Service level strategy rules that are taken into consideration during task placement. List from top to bottom in order of precedence. Updates to this configuration will take effect next task deployment unless `forceNewDeployment` is enabled. The maximum number of `orderedPlacementStrategy` blocks is `5`. See below.

      • placementConstraints

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ServicePlacementConstraintArgs>>> placementConstraints()
        Returns:
        Rules that are taken into consideration during task placement. Updates to this configuration will take effect next task deployment unless `forceNewDeployment` is enabled. Maximum number of `placementConstraints` is `10`. See below.

      • platformVersion

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> platformVersion()
        Returns:
        Platform version on which to run your service. Only applicable for `launchType` set to `FARGATE`. Defaults to `LATEST`. More information about Fargate platform versions can be found in the [AWS ECS User Guide](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/platform_versions.html).

      • propagateTags

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> propagateTags()
        Returns:
        Whether to propagate the tags from the task definition or the service to the tasks. The valid values are `SERVICE` and `TASK_DEFINITION`.

      • region

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • schedulingStrategy

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> schedulingStrategy()
        Returns:
        Scheduling strategy to use for the service. The valid values are `REPLICA` and `DAEMON`. Defaults to `REPLICA`. Note that [*Tasks using the Fargate launch type or the `CODE_DEPLOY` or `EXTERNAL` deployment controller types don't support the `DAEMON` scheduling strategy*](https://docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateService.html).

      • serviceConnectConfiguration

        public java.util.Optional<com.pulumi.core.Output<ServiceServiceConnectConfigurationArgs>> serviceConnectConfiguration()
        Returns:
        ECS Service Connect configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace. See below.

      • serviceRegistries

        public java.util.Optional<com.pulumi.core.Output<ServiceServiceRegistriesArgs>> serviceRegistries()
        Returns:
        Service discovery registries for the service. The maximum number of `serviceRegistries` blocks is `1`. See below.

      • sigintRollback

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> sigintRollback()
        Returns:
        Whether to enable graceful termination of deployments using SIGINT signals. When enabled, allows customers to safely cancel an in-progress deployment and automatically trigger a rollback to the previous stable state. Defaults to `false`. Only applicable when using `ECS` deployment controller and requires `waitForSteadyState = true`.

      • tags

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • taskDefinition

        public java.util.Optional<com.pulumi.core.Output<java.lang.String>> taskDefinition()
        Returns:
        Family and revision (`family:revision`) or full ARN of the task definition that you want to run in your service. Required unless using the `EXTERNAL` deployment controller. If a revision is not specified, the latest `ACTIVE` revision is used.

      • triggers

        public java.util.Optional<com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>>> triggers()
        Returns:
        Map of arbitrary keys and values that, when changed, will trigger an in-place update (redeployment). Useful with `"plantimestamp()"`. When using the triggers property you also need to set the forceNewDeployment property to True.

      • volumeConfiguration

        public java.util.Optional<com.pulumi.core.Output<ServiceVolumeConfigurationArgs>> volumeConfiguration()
        Returns:
        Configuration for a volume specified in the task definition as a volume that is configured at launch time. Currently, the only supported volume type is an Amazon EBS volume. See below.

      • vpcLatticeConfigurations

        public java.util.Optional<com.pulumi.core.Output<java.util.List<ServiceVpcLatticeConfigurationArgs>>> vpcLatticeConfigurations()
        Returns:
        VPC Lattice configuration for your service that allows Lattice to connect, secure, and monitor your service across multiple accounts and VPCs. See below.

      • waitForSteadyState

        public java.util.Optional<com.pulumi.core.Output<java.lang.Boolean>> waitForSteadyState()
        Returns:
        If `true`, this provider will wait for the service to reach a steady state (like [`aws ecs wait services-stable`](https://docs.aws.amazon.com/cli/latest/reference/ecs/wait/services-stable.html)) before continuing. Default `false`.