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

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::CapacityProvider

Defined in:

gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb

Overview

The details for a capacity provider.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #auto_scaling_group_provider ⇒ Types::AutoScalingGroupProvider

  The Auto Scaling group settings for the capacity provider.

• #capacity_provider_arn ⇒ String

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

• #cluster ⇒ String

  The cluster that this capacity provider is associated with.

• #managed_instances_provider ⇒ Types::ManagedInstancesProvider

  The configuration for the Amazon ECS Managed Instances provider.

• #name ⇒ String

  The name of the capacity provider.

• #status ⇒ String

  The current status of the capacity provider.

• #tags ⇒ Array<Types::Tag>

  The metadata that you apply to the capacity provider to help you categorize and organize it.

• #type ⇒ String

  The type of capacity provider.

• #update_status ⇒ String

  The update status of the capacity provider.

• #update_status_reason ⇒ String

  The update status reason.

Instance Attribute Details

#auto_scaling_group_provider ⇒ Types::AutoScalingGroupProvider

The Auto Scaling group settings for the capacity provider.

Returns:

• (Types::AutoScalingGroupProvider)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#capacity_provider_arn ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#cluster ⇒ String

The cluster that this capacity provider is associated with. Managed instances capacity providers are cluster-scoped, meaning they can only be used within their associated cluster.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#managed_instances_provider ⇒ Types::ManagedInstancesProvider

The configuration for the Amazon ECS Managed Instances provider. This includes the infrastructure role, the launch template configuration, and tag propagation settings.

Returns:

• (Types::ManagedInstancesProvider)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#name ⇒ String

The name of the capacity provider.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#status ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#tags ⇒ Array<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. 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.

Returns:

• (Array<Types::Tag>)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#type ⇒ String

The type of capacity provider. For Amazon ECS Managed Instances, this value is MANAGED_INSTANCES, indicating that Amazon ECS manages the underlying Amazon EC2 instances on your behalf.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#update_status ⇒ String

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.

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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

#update_status_reason ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 512

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