public static interface CreateClusterRequest.Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
| Modifier and Type | Method and Description |
|---|---|
CreateClusterRequest.Builder |
capacityProviders(Collection<String> capacityProviders)
The short name of one or more capacity providers to associate with the cluster.
|
CreateClusterRequest.Builder |
capacityProviders(String... capacityProviders)
The short name of one or more capacity providers to associate with the cluster.
|
CreateClusterRequest.Builder |
clusterName(String clusterName)
The name of your cluster.
|
CreateClusterRequest.Builder |
configuration(ClusterConfiguration configuration)
The
execute command configuration for the cluster. |
default CreateClusterRequest.Builder |
configuration(Consumer<ClusterConfiguration.Builder> configuration)
The
execute command configuration for the cluster. |
CreateClusterRequest.Builder |
defaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
CreateClusterRequest.Builder |
defaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
CreateClusterRequest.Builder |
defaultCapacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
CreateClusterRequest.Builder |
overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) |
CreateClusterRequest.Builder |
overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) |
CreateClusterRequest.Builder |
serviceConnectDefaults(ClusterServiceConnectDefaultsRequest serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace.
|
default CreateClusterRequest.Builder |
serviceConnectDefaults(Consumer<ClusterServiceConnectDefaultsRequest.Builder> serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace.
|
CreateClusterRequest.Builder |
settings(ClusterSetting... settings)
The setting to use when creating a cluster.
|
CreateClusterRequest.Builder |
settings(Collection<ClusterSetting> settings)
The setting to use when creating a cluster.
|
CreateClusterRequest.Builder |
settings(Consumer<ClusterSetting.Builder>... settings)
The setting to use when creating a cluster.
|
CreateClusterRequest.Builder |
tags(Collection<Tag> tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
CreateClusterRequest.Builder |
tags(Consumer<Tag.Builder>... tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
CreateClusterRequest.Builder |
tags(Tag... tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
buildoverrideConfigurationequalsBySdkFields, sdkFieldscopyapplyMutation, buildCreateClusterRequest.Builder clusterName(String clusterName)
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.
clusterName - 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.CreateClusterRequest.Builder tags(Collection<Tag> tags)
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.
tags - 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.
CreateClusterRequest.Builder tags(Tag... tags)
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.
tags - 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.
CreateClusterRequest.Builder tags(Consumer<Tag.Builder>... tags)
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.
Tag.Builder avoiding the need to create one manually via
Tag.builder().
When the Consumer completes, SdkBuilder.build() is
called immediately and its result is passed to #tags(List.
tags - a consumer that will call methods on Tag.Builder#tags(java.util.Collection) CreateClusterRequest.Builder settings(Collection<ClusterSetting> settings)
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights
for a cluster. If this value is specified, it overrides the containerInsights value set with
PutAccountSetting or PutAccountSettingDefault.
settings - The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container
Insights for a cluster. If this value is specified, it overrides the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.CreateClusterRequest.Builder settings(ClusterSetting... settings)
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights
for a cluster. If this value is specified, it overrides the containerInsights value set with
PutAccountSetting or PutAccountSettingDefault.
settings - The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container
Insights for a cluster. If this value is specified, it overrides the containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.CreateClusterRequest.Builder settings(Consumer<ClusterSetting.Builder>... settings)
The setting to use when creating a cluster. This parameter is used to turn on CloudWatch Container Insights
for a cluster. If this value is specified, it overrides the containerInsights value set with
PutAccountSetting or PutAccountSettingDefault.
ClusterSetting.Builder avoiding the need to create one
manually via ClusterSetting.builder().
When the Consumer completes,
SdkBuilder.build() is called immediately and
its result is passed to #settings(List.
settings - a consumer that will call methods on
ClusterSetting.Builder#settings(java.util.Collection) CreateClusterRequest.Builder configuration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
configuration - The execute command configuration for the cluster.default CreateClusterRequest.Builder configuration(Consumer<ClusterConfiguration.Builder> configuration)
The execute command configuration for the cluster.
ClusterConfiguration.Builder avoiding
the need to create one manually via ClusterConfiguration.builder().
When the Consumer completes, SdkBuilder.build() is called immediately and
its result is passed to configuration(ClusterConfiguration).
configuration - a consumer that will call methods on ClusterConfiguration.Builderconfiguration(ClusterConfiguration)CreateClusterRequest.Builder capacityProviders(Collection<String> capacityProviders)
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 PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
capacityProviders - 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 PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
CreateClusterRequest.Builder capacityProviders(String... capacityProviders)
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 PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
capacityProviders - 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 PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
CreateClusterRequest.Builder defaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
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 CreateService or RunTask 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.
defaultCapacityProviderStrategy - 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 CreateService or RunTask 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.
CreateClusterRequest.Builder defaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
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 CreateService or RunTask 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.
defaultCapacityProviderStrategy - 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 CreateService or RunTask 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.
CreateClusterRequest.Builder defaultCapacityProviderStrategy(Consumer<CapacityProviderStrategyItem.Builder>... defaultCapacityProviderStrategy)
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 CreateService or RunTask 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.
This is a convenience method that creates an instance of theCapacityProviderStrategyItem.Builder avoiding the need to
create one manually via
CapacityProviderStrategyItem.builder().
When the Consumer completes,
SdkBuilder.build() is called
immediately and its result is passed to #defaultCapacityProviderStrategy(List.
defaultCapacityProviderStrategy - a consumer that will call methods on
CapacityProviderStrategyItem.Builder#defaultCapacityProviderStrategy(java.util.Collection) CreateClusterRequest.Builder serviceConnectDefaults(ClusterServiceConnectDefaultsRequest serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added as
client services in the namespace. This setting only applies to new services that set the enabled
parameter to true in the ServiceConnectConfiguration. You can set the namespace of
each service individually in the ServiceConnectConfiguration to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
serviceConnectDefaults - Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added
as client services in the namespace. This setting only applies to new services that set the
enabled parameter to true in the ServiceConnectConfiguration.
You can set the namespace of each service individually in the ServiceConnectConfiguration
to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
default CreateClusterRequest.Builder serviceConnectDefaults(Consumer<ClusterServiceConnectDefaultsRequest.Builder> serviceConnectDefaults)
Use this parameter to set a default Service Connect namespace. After you set a default Service Connect
namespace, any new services with Service Connect turned on that are created in the cluster are added as
client services in the namespace. This setting only applies to new services that set the enabled
parameter to true in the ServiceConnectConfiguration. You can set the namespace of
each service individually in the ServiceConnectConfiguration to override this default parameter.
Tasks that run in a namespace can use short names to connect to services in the namespace. Tasks can connect to services across all of the clusters in the namespace. Tasks connect through a managed proxy container that collects logs and metrics for increased visibility. Only the tasks that Amazon ECS services create are supported with Service Connect. For more information, see Service Connect in the Amazon Elastic Container Service Developer Guide.
This is a convenience method that creates an instance of theClusterServiceConnectDefaultsRequest.Builder avoiding the need to create one manually via
ClusterServiceConnectDefaultsRequest.builder().
When the Consumer completes, SdkBuilder.build() is called
immediately and its result is passed to serviceConnectDefaults(ClusterServiceConnectDefaultsRequest).
serviceConnectDefaults - a consumer that will call methods on ClusterServiceConnectDefaultsRequest.BuilderserviceConnectDefaults(ClusterServiceConnectDefaultsRequest)CreateClusterRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
overrideConfiguration in interface AwsRequest.BuilderCreateClusterRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
overrideConfiguration in interface AwsRequest.BuilderCopyright © 2023. All rights reserved.