Class: Aws::ECS::Types::CreateClusterRequest

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

Overview

Note:

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

{
  cluster_name: "String",
  tags: [
    {
      key: "TagKey",
      value: "TagValue",
    },
  ],
  settings: [
    {
      name: "containerInsights", # accepts containerInsights
      value: "String",
    },
  ],
  configuration: {
    execute_command_configuration: {
      kms_key_id: "String",
      logging: "NONE", # accepts NONE, DEFAULT, OVERRIDE
      log_configuration: {
        cloud_watch_log_group_name: "String",
        cloud_watch_encryption_enabled: false,
        s3_bucket_name: "String",
        s3_encryption_enabled: false,
        s3_key_prefix: "String",
      },
    },
  },
  capacity_providers: ["String"],
  default_capacity_provider_strategy: [
    {
      capacity_provider: "String", # required
      weight: 1,
      base: 1,
    },
  ],
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#capacity_providersArray<String>

The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.

If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group 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.

The PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.

Returns:

  • (Array<String>)

2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#cluster_nameString

The name of your cluster. If you don't specify a name for your cluster, you create a cluster that's named `default`. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.

Returns:

  • (String)

2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#configurationTypes::ClusterConfiguration

The execute command configuration for the cluster.


2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#default_capacity_provider_strategyArray<Types::CapacityProviderStrategyItem>

The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the RunTask or CreateService APIs with no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.

If a default capacity provider strategy isn't defined for a cluster when it was created, it can be defined later with the PutClusterCapacityProviders API operation.


2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#settingsArray<Types::ClusterSetting>

The setting to use when creating a cluster. This parameter is used to enable CloudWatch Container Insights for a cluster. If this value is specified, it overrides the `containerInsights` value set with PutAccountSetting or PutAccountSettingDefault.

Returns:


2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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


2666
2667
2668
2669
2670
2671
2672
2673
2674
2675
# File 'lib/aws-sdk-ecs/types.rb', line 2666

class CreateClusterRequest < Struct.new(
  :cluster_name,
  :tags,
  :settings,
  :configuration,
  :capacity_providers,
  :default_capacity_provider_strategy)
  SENSITIVE = []
  include Aws::Structure
end