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::CreateCapacityProviderRequest

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

Overview

Note:

When making an API call, you may pass CreateCapacityProviderRequest data as a hash:

{
  name: "String", # required
  auto_scaling_group_provider: { # required
    auto_scaling_group_arn: "String", # required
    managed_scaling: {
      status: "ENABLED", # accepts ENABLED, DISABLED
      target_capacity: 1,
      minimum_scaling_step_size: 1,
      maximum_scaling_step_size: 1,
      instance_warmup_period: 1,
    },
    managed_termination_protection: "ENABLED", # accepts ENABLED, DISABLED
  },
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#auto_scaling_group_providerTypes::AutoScalingGroupProvider

The details of the Auto Scaling group for the capacity provider.



2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2410

class CreateCapacityProviderRequest < Struct.new(
  :name,
  :auto_scaling_group_provider,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the capacity provider. Up to 255 characters are allowed, including letters (upper and lowercase), numbers, underscores, and hyphens. The name cannot be prefixed with "aws", "ecs", or "fargate".

Returns:

  • (String)


2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2410

class CreateCapacityProviderRequest < Struct.new(
  :name,
  :auto_scaling_group_provider,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

The metadata that you apply to the capacity provider to help you categorize and organize them. 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:



2410
2411
2412
2413
2414
2415
2416
# File 'gems/aws-sdk-ecs/lib/aws-sdk-ecs/types.rb', line 2410

class CreateCapacityProviderRequest < Struct.new(
  :name,
  :auto_scaling_group_provider,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end