@Generated(value="software.amazon.awssdk:codegen") public final class CreateClusterRequest extends EcsRequest implements ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>
| Modifier and Type | Class and Description |
|---|---|
static interface |
CreateClusterRequest.Builder |
| Modifier and Type | Method and Description |
|---|---|
static CreateClusterRequest.Builder |
builder() |
List<String> |
capacityProviders()
The short name of one or more capacity providers to associate with the cluster.
|
String |
clusterName()
The name of your cluster.
|
ClusterConfiguration |
configuration()
The
execute command configuration for the cluster. |
List<CapacityProviderStrategyItem> |
defaultCapacityProviderStrategy()
The capacity provider strategy to set as the default for the cluster.
|
boolean |
equals(Object obj) |
boolean |
equalsBySdkFields(Object obj) |
<T> Optional<T> |
getValueForField(String fieldName,
Class<T> clazz) |
boolean |
hasCapacityProviders()
For responses, this returns true if the service returned a value for the CapacityProviders property.
|
boolean |
hasDefaultCapacityProviderStrategy()
For responses, this returns true if the service returned a value for the DefaultCapacityProviderStrategy
property.
|
int |
hashCode() |
boolean |
hasSettings()
For responses, this returns true if the service returned a value for the Settings property.
|
boolean |
hasTags()
For responses, this returns true if the service returned a value for the Tags property.
|
List<SdkField<?>> |
sdkFields() |
static Class<? extends CreateClusterRequest.Builder> |
serializableBuilderClass() |
ClusterServiceConnectDefaultsRequest |
serviceConnectDefaults()
Use this parameter to set a default Service Connect namespace.
|
List<ClusterSetting> |
settings()
The setting to use when creating a cluster.
|
List<Tag> |
tags()
The metadata that you apply to the cluster to help you categorize and organize them.
|
CreateClusterRequest.Builder |
toBuilder() |
String |
toString()
Returns a string representation of this object.
|
overrideConfigurationclone, finalize, getClass, notify, notifyAll, wait, wait, waitcopypublic final 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.
default. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed.public final boolean hasTags()
isEmpty() method on the property). This is useful
because the SDK will never return a null collection or map, but you may need to differentiate between the service
returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true
if a value for the property was specified in the request builder, and false if a value was not specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasTags() method.
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.
public final boolean hasSettings()
isEmpty() method on the property). This is
useful because the SDK will never return a null collection or map, but you may need to differentiate between the
service returning nothing (or null) and the service returning an empty collection or map. For requests, this
returns true if a value for the property was specified in the request builder, and false if a value was not
specified.public final List<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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasSettings() method.
containerInsights value
set with PutAccountSetting or PutAccountSettingDefault.public final ClusterConfiguration configuration()
The execute command configuration for the cluster.
execute command configuration for the cluster.public final boolean hasCapacityProviders()
isEmpty() method on the property).
This is useful because the SDK will never return a null collection or map, but you may need to differentiate
between the service returning nothing (or null) and the service returning an empty collection or map. For
requests, this returns true if a value for the property was specified in the request builder, and false if a
value was not specified.public final List<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 PutClusterCapacityProviders API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasCapacityProviders() method.
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.
public final boolean hasDefaultCapacityProviderStrategy()
isEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may
need to differentiate between the service returning nothing (or null) and the service returning an empty
collection or map. For requests, this returns true if a value for the property was specified in the request
builder, and false if a value was not specified.public final List<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 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.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that
you can differentiate between null and empty), you can use the hasDefaultCapacityProviderStrategy()
method.
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.
public final 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.
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.
public CreateClusterRequest.Builder toBuilder()
toBuilder in interface ToCopyableBuilder<CreateClusterRequest.Builder,CreateClusterRequest>toBuilder in class EcsRequestpublic static CreateClusterRequest.Builder builder()
public static Class<? extends CreateClusterRequest.Builder> serializableBuilderClass()
public final int hashCode()
hashCode in class AwsRequestpublic final boolean equals(Object obj)
equals in class AwsRequestpublic final boolean equalsBySdkFields(Object obj)
equalsBySdkFields in interface SdkPojopublic final String toString()
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
getValueForField in class SdkRequestCopyright © 2023. All rights reserved.