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 for a capacity provider.

Inheritance Hierarchy

System.Object
  Amazon.ECS.Model.CapacityProvider

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

Syntax

C#
public class CapacityProvider

The CapacityProvider type exposes the following members

Constructors

NameDescription
Public Method CapacityProvider()

Properties

NameTypeDescription
Public Property AutoScalingGroupProvider Amazon.ECS.Model.AutoScalingGroupProvider

Gets and sets the property AutoScalingGroupProvider.

The Auto Scaling group settings for the capacity provider.

Public Property CapacityProviderArn System.String

Gets and sets the property CapacityProviderArn.

The Amazon Resource Name (ARN) that identifies the capacity provider.

Public Property Name System.String

Gets and sets the property Name.

The name of the capacity provider.

Public Property Status Amazon.ECS.CapacityProviderStatus

Gets and sets the property Status.

The current status of the capacity provider. Only capacity providers in an ACTIVE state can be used in a cluster. When a capacity provider is successfully deleted, it has an INACTIVE status.

Public Property Tags System.Collections.Generic.List<Amazon.ECS.Model.Tag>

Gets and sets the property Tags.

The metadata that you apply to the capacity provider to help you categorize and organize it. Each tag consists of a key and an optional value. You define both.

The following basic restrictions apply to tags:

  • Maximum number of tags per resource - 50

  • For each resource, each tag key must be unique, and each tag key can have only one value.

  • Maximum key length - 128 Unicode characters in UTF-8

  • Maximum value length - 256 Unicode characters in UTF-8

  • If your tagging schema is used across multiple services and resources, remember that other services may have restrictions on allowed characters. Generally allowed characters are: letters, numbers, and spaces representable in UTF-8, and the following characters: + - = . _ : / @.

  • Tag keys and values are case-sensitive.

  • Do not use aws:, AWS:, or any upper or lowercase combination of such as a prefix for either keys or values as it is reserved for Amazon Web Services use. You cannot edit or delete tag keys or values with this prefix. Tags with this prefix do not count against your tags per resource limit.

Public Property UpdateStatus Amazon.ECS.CapacityProviderUpdateStatus

Gets and sets the property UpdateStatus.

The update status of the capacity provider. The following are the possible states that is returned.

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider was successfully deleted and has an INACTIVE status.

DELETE_FAILED

The capacity provider can't be deleted. The update status reason provides further details about why the delete failed.

Public Property UpdateStatusReason System.String

Gets and sets the property UpdateStatusReason.

The update status reason. This provides further details about the update status for the capacity provider.

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