Class ServiceArgs

Inheritance

System.Object

InputArgs

ResourceArgs

ServiceArgs

Inherited Members

ResourceArgs.Empty

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Aws.Ecs

Assembly: Pulumi.Aws.dll

Syntax

public sealed class ServiceArgs : ResourceArgs

Constructors

View Source

ServiceArgs()

Declaration

public ServiceArgs()

Properties

View Source

CapacityProviderStrategies

The capacity provider strategy to use for the service. Can be one or more. Defined below.

Declaration

public InputList<ServiceCapacityProviderStrategyArgs> CapacityProviderStrategies { get; set; }

Property Value

Type	Description
InputList<ServiceCapacityProviderStrategyArgs>

View Source

Cluster

ARN of an ECS cluster

Declaration

public Input<string> Cluster { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

DeploymentController

Configuration block containing deployment controller configuration. Defined below.

Declaration

public Input<ServiceDeploymentControllerArgs> DeploymentController { get; set; }

Property Value

Type	Description
Input<ServiceDeploymentControllerArgs>

View Source

DeploymentMaximumPercent

The 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.

Declaration

public Input<int> DeploymentMaximumPercent { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

DeploymentMinimumHealthyPercent

The 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.

Declaration

public Input<int> DeploymentMinimumHealthyPercent { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

DesiredCount

The number of instances of the task definition to place and keep running. Defaults to 0. Do not specify if using the DAEMON scheduling strategy.

Declaration

public Input<int> DesiredCount { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

EnableEcsManagedTags

Specifies whether to enable Amazon ECS managed tags for the tasks within the service.

Declaration

public Input<bool> EnableEcsManagedTags { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

ForceNewDeployment

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 ordered_placement_strategy and placement_constraints updates.

Declaration

public Input<bool> ForceNewDeployment { get; set; }

Property Value

Type	Description
Input<System.Boolean>

View Source

HealthCheckGracePeriodSeconds

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.

Declaration

public Input<int> HealthCheckGracePeriodSeconds { get; set; }

Property Value

Type	Description
Input<System.Int32>

View Source

IamRole

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.

Declaration

public Input<string> IamRole { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

LaunchType

The launch type on which to run your service. The valid values are EC2 and FARGATE. Defaults to EC2.

Declaration

public Input<string> LaunchType { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

LoadBalancers

A load balancer block. Load balancers documented below.

Declaration

public InputList<ServiceLoadBalancerArgs> LoadBalancers { get; set; }

Property Value

Type	Description
InputList<ServiceLoadBalancerArgs>

View Source

Name

The name of the service (up to 255 letters, numbers, hyphens, and underscores)

Declaration

public Input<string> Name { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

NetworkConfiguration

The 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.

Declaration

public Input<ServiceNetworkConfigurationArgs> NetworkConfiguration { get; set; }

Property Value

Type	Description
Input<ServiceNetworkConfigurationArgs>

View Source

OrderedPlacementStrategies

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 force_new_deployment is enabled. The maximum number of ordered_placement_strategy blocks is 5. Defined below.

Declaration

public InputList<ServiceOrderedPlacementStrategyArgs> OrderedPlacementStrategies { get; set; }

Property Value

Type	Description
InputList<ServiceOrderedPlacementStrategyArgs>

View Source

PlacementConstraints

rules that are taken into consideration during task placement. Updates to this configuration will take effect next task deployment unless force_new_deployment is enabled. Maximum number of placement_constraints is 10. Defined below.

Declaration

public InputList<ServicePlacementConstraintArgs> PlacementConstraints { get; set; }

Property Value

Type	Description
InputList<ServicePlacementConstraintArgs>

View Source

PlatformVersion

The platform version on which to run your service. Only applicable for launch_type set to FARGATE. Defaults to LATEST. More information about Fargate platform versions can be found in the AWS ECS User Guide.

Declaration

public Input<string> PlatformVersion { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

PropagateTags

Specifies whether to propagate the tags from the task definition or the service to the tasks. The valid values are SERVICE and TASK_DEFINITION.

Declaration

public Input<string> PropagateTags { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

SchedulingStrategy

The scheduling strategy to use for the service. The valid values are REPLICA and DAEMON. Defaults to REPLICA. Note that Fargate tasks do not support the DAEMON scheduling strategy.

Declaration

public Input<string> SchedulingStrategy { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

ServiceRegistries

The service discovery registries for the service. The maximum number of service_registries blocks is 1.

Declaration

public Input<ServiceServiceRegistriesArgs> ServiceRegistries { get; set; }

Property Value

Type	Description
Input<ServiceServiceRegistriesArgs>

View Source

Type	Description
InputMap<System.Object>

TaskDefinition

The family and revision (family:revision) or full ARN of the task definition that you want to run in your service.

Declaration

public Input<string> TaskDefinition { get; set; }

Property Value

Type	Description
Input<System.String>

View Source

WaitForSteadyState

If true, this provider will wait for the service to reach a steady state (like aws ecs wait services-stable) before continuing. Default false.

Declaration

public Input<bool> WaitForSteadyState { get; set; }

Property Value

Type	Description
Input<System.Boolean>