Class: Aws::ECS::Types::PutClusterCapacityProvidersRequest

Inherits:

Struct

• Object
• Struct
• Aws::ECS::Types::PutClusterCapacityProvidersRequest

Includes:

Structure

Defined in:

lib/aws-sdk-ecs/types.rb

Overview

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #capacity_providers ⇒ Array<String>

  The name of one or more capacity providers to associate with the cluster.

• #cluster ⇒ String

  The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for.

• #default_capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

  The capacity provider strategy to use by default for the cluster.

Instance Attribute Details

#capacity_providers ⇒ Array<String>

The name of one or more capacity providers to associate with the cluster.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the [CreateCapacityProvider] API operation.

To use a Fargate capacity provider, specify either the ‘FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html

Returns:

• (Array<String>)

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

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#cluster ⇒ String

The short name or full Amazon Resource Name (ARN) of the cluster to modify the capacity provider settings for. If you don’t specify a cluster, the default cluster is assumed.

Returns:

• (String)

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

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#default_capacity_provider_strategy ⇒ Array<Types::CapacityProviderStrategyItem>

The capacity provider strategy to use by default for the cluster.

When creating a service or running a task on a cluster, if no capacity provider or launch type is specified then the default capacity provider strategy for the cluster is used.

A capacity provider strategy consists of one or more capacity providers along with the ‘base` and `weight` to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The [PutClusterCapacityProviders] API is used to associate a capacity provider with a cluster. Only capacity providers with an `ACTIVE` or `UPDATING` status can be used.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the [CreateCapacityProvider] API operation.

To use a Fargate capacity provider, specify either the ‘FARGATE` or `FARGATE_SPOT` capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.

[1]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_PutClusterCapacityProviders.html [2]: docs.aws.amazon.com/AmazonECS/latest/APIReference/API_CreateCapacityProvider.html

Returns:

• (Array<Types::CapacityProviderStrategyItem>)

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

class PutClusterCapacityProvidersRequest < Struct.new(
  :cluster,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end