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.

Class: Aws::ECS::Types::CapacityProvider

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

The details of a capacity provider.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_providerTypes::AutoScalingGroupProvider

The Auto Scaling group settings for the capacity provider.



412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#capacity_provider_arnString

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

Returns:

  • (String)


412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the capacity provider.

Returns:

  • (String)


412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#statusString

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 will have an INACTIVE status.

Returns:

  • (String)


412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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, both of which you define.

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

Returns:



412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#update_statusString

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

DELETE_IN_PROGRESS

The capacity provider is in the process of being deleted.

DELETE_COMPLETE

The capacity provider has been successfully deleted and will have an INACTIVE status.

DELETE_FAILED

The capacity provider was unable to be deleted. The update status reason will provide further details about why the delete failed.

Returns:

  • (String)


412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#update_status_reasonString

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

Returns:

  • (String)


412
413
414
415
416
417
418
419
420
421
422
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 412

class CapacityProvider < Struct.new(
  :capacity_provider_arn,
  :name,
  :status,
  :auto_scaling_group_provider,
  :update_status,
  :update_status_reason,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end