AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

The details of an Amazon ECS service deployment. This is used only when a service uses the ECS deployment controller type.

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.Deployment

Namespace: Amazon.ECS.Model
Assembly: AWSSDK.ECS.dll
Version: 3.x.y.z

Syntax

C#
public class Deployment

The Deployment type exposes the following members

Constructors

NameDescription
Public Method Deployment()

Properties

NameTypeDescription
Public Property CapacityProviderStrategy System.Collections.Generic.List<Amazon.ECS.Model.CapacityProviderStrategyItem>

Gets and sets the property CapacityProviderStrategy.

The capacity provider strategy that the deployment is using.

Public Property CreatedAt System.DateTime

Gets and sets the property CreatedAt.

The Unix timestamp for the time when the service deployment was created.

Public Property DesiredCount System.Int32

Gets and sets the property DesiredCount.

The most recent desired count of tasks that was specified for the service to deploy or maintain.

Public Property FailedTasks System.Int32

Gets and sets the property FailedTasks.

The number of consecutively failed tasks in the deployment. A task is considered a failure if the service scheduler can't launch the task, the task doesn't transition to a RUNNING state, or if it fails any of its defined health checks and is stopped.

Once a service deployment has one or more successfully running tasks, the failed task count resets to zero and stops being evaluated.

Public Property FargateEphemeralStorage Amazon.ECS.Model.DeploymentEphemeralStorage

Gets and sets the property FargateEphemeralStorage.

The Fargate ephemeral storage settings for the deployment.

Public Property Id System.String

Gets and sets the property Id.

The ID of the deployment.

Public Property LaunchType Amazon.ECS.LaunchType

Gets and sets the property LaunchType.

The launch type the tasks in the service are using. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.

Public Property NetworkConfiguration Amazon.ECS.Model.NetworkConfiguration

Gets and sets the property NetworkConfiguration.

The VPC subnet and security group configuration for tasks that receive their own elastic network interface by using the awsvpc networking mode.

Public Property PendingCount System.Int32

Gets and sets the property PendingCount.

The number of tasks in the deployment that are in the PENDING status.

Public Property PlatformFamily System.String

Gets and sets the property PlatformFamily.

The operating system that your tasks in the service, or tasks are running on. A platform family is specified only for tasks using the Fargate launch type.

All tasks that run as part of this service must use the same platformFamily value as the service, for example, LINUX..

Public Property PlatformVersion System.String

Gets and sets the property PlatformVersion.

The platform version that your tasks in the service run on. A platform version is only specified for tasks using the Fargate launch type. If one isn't specified, the LATEST platform version is used. For more information, see Fargate Platform Versions in the Amazon Elastic Container Service Developer Guide.

Public Property RolloutState Amazon.ECS.DeploymentRolloutState

Gets and sets the property RolloutState.

The rolloutState of a service is only returned for services that use the rolling update (ECS) deployment type that aren't behind a Classic Load Balancer.

The rollout state of the deployment. When a service deployment is started, it begins in an IN_PROGRESS state. When the service reaches a steady state, the deployment transitions to a COMPLETED state. If the service fails to reach a steady state and circuit breaker is turned on, the deployment transitions to a FAILED state. A deployment in FAILED state doesn't launch any new tasks. For more information, see DeploymentCircuitBreaker.

Public Property RolloutStateReason System.String

Gets and sets the property RolloutStateReason.

A description of the rollout state of a deployment.

Public Property RunningCount System.Int32

Gets and sets the property RunningCount.

The number of tasks in the deployment that are in the RUNNING status.

Public Property ServiceConnectConfiguration Amazon.ECS.Model.ServiceConnectConfiguration

Gets and sets the property ServiceConnectConfiguration.

The details of the Service Connect configuration that's used by this deployment. Compare the configuration between multiple deployments when troubleshooting issues with new deployments.

The configuration for this service to discover and connect to services, and be discovered by, and connected from, other services within a namespace.

Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.

Public Property ServiceConnectResources System.Collections.Generic.List<Amazon.ECS.Model.ServiceConnectServiceResource>

Gets and sets the property ServiceConnectResources.

The list of Service Connect resources that are associated with this deployment. Each list entry maps a discovery name to a Cloud Map service name.

Public Property Status System.String

Gets and sets the property Status.

The status of the deployment. The following describes each state.

PRIMARY

The most recent deployment of a service.

ACTIVE

A service deployment that still has running tasks, but are in the process of being replaced with a new PRIMARY deployment.

INACTIVE

A deployment that has been completely replaced.

Public Property TaskDefinition System.String

Gets and sets the property TaskDefinition.

The most recent task definition that was specified for the tasks in the service to use.

Public Property UpdatedAt System.DateTime

Gets and sets the property UpdatedAt.

The Unix timestamp for the time when the service deployment was last updated.

Public Property VolumeConfigurations System.Collections.Generic.List<Amazon.ECS.Model.ServiceVolumeConfiguration>

Gets and sets the property VolumeConfigurations.

The details of the volume that was configuredAtLaunch. You can configure different settings like the size, throughput, volumeType, and ecryption in ServiceManagedEBSVolumeConfiguration. The name of the volume must match the name from the task definition.

Public Property VpcLatticeConfigurations System.Collections.Generic.List<Amazon.ECS.Model.VpcLatticeConfiguration>

Gets and sets the property VpcLatticeConfigurations.

The VPC Lattice configuration for the service deployment.

Version Information

.NET:
Supported in: 8.0 and newer, Core 3.1

.NET Standard:
Supported in: 2.0

.NET Framework:
Supported in: 4.5 and newer, 3.5