@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateClusterRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
CreateClusterRequest() |
Modifier and Type | Method and Description |
---|---|
CreateClusterRequest |
clone() |
boolean |
equals(Object obj) |
List<String> |
getCapacityProviders()
The short name of one or more capacity providers to associate with the cluster.
|
String |
getClusterName()
The name of your cluster.
|
ClusterConfiguration |
getConfiguration()
The execute command configuration for the cluster.
|
List<CapacityProviderStrategyItem> |
getDefaultCapacityProviderStrategy()
The capacity provider strategy to set as the default for the cluster.
|
List<ClusterSetting> |
getSettings()
The setting to use when creating a cluster.
|
List<Tag> |
getTags()
The metadata that you apply to the cluster to help you categorize and organize them.
|
int |
hashCode() |
void |
setCapacityProviders(Collection<String> capacityProviders)
The short name of one or more capacity providers to associate with the cluster.
|
void |
setClusterName(String clusterName)
The name of your cluster.
|
void |
setConfiguration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
|
void |
setDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
void |
setSettings(Collection<ClusterSetting> settings)
The setting to use when creating a cluster.
|
void |
setTags(Collection<Tag> tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
String |
toString()
Returns a string representation of this object.
|
CreateClusterRequest |
withCapacityProviders(Collection<String> capacityProviders)
The short name of one or more capacity providers to associate with the cluster.
|
CreateClusterRequest |
withCapacityProviders(String... capacityProviders)
The short name of one or more capacity providers to associate with the cluster.
|
CreateClusterRequest |
withClusterName(String clusterName)
The name of your cluster.
|
CreateClusterRequest |
withConfiguration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
|
CreateClusterRequest |
withDefaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
CreateClusterRequest |
withDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster.
|
CreateClusterRequest |
withSettings(ClusterSetting... settings)
The setting to use when creating a cluster.
|
CreateClusterRequest |
withSettings(Collection<ClusterSetting> settings)
The setting to use when creating a cluster.
|
CreateClusterRequest |
withTags(Collection<Tag> tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
CreateClusterRequest |
withTags(Tag... tags)
The metadata that you apply to the cluster to help you categorize and organize them.
|
addHandlerContext, copyBaseTo, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeout
public void setClusterName(String clusterName)
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
clusterName
- The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed.public String getClusterName()
The name of your cluster. If you do not specify a name for your cluster, you create a cluster 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 CreateClusterRequest withClusterName(String clusterName)
The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are allowed.
clusterName
- The name of your cluster. If you do not specify a name for your cluster, you create a cluster named
default
. Up to 255 letters (uppercase and lowercase), numbers, underscores, and hyphens are
allowed.public List<Tag> getTags()
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, 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.
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.
public void setTags(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, 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.
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, 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.
public CreateClusterRequest withTags(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, 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.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection)
or withTags(java.util.Collection)
if you want to override the
existing values.
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, 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.
public CreateClusterRequest withTags(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, 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.
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, 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.
public List<ClusterSetting> getSettings()
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 will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
containerInsights
value set with PutAccountSetting or PutAccountSettingDefault.public void setSettings(Collection<ClusterSetting> settings)
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 will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
settings
- 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 will override the containerInsights
value set
with PutAccountSetting or PutAccountSettingDefault.public CreateClusterRequest withSettings(ClusterSetting... settings)
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 will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
NOTE: This method appends the values to the existing list (if any). Use
setSettings(java.util.Collection)
or withSettings(java.util.Collection)
if you want to override
the existing values.
settings
- 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 will override the containerInsights
value set
with PutAccountSetting or PutAccountSettingDefault.public CreateClusterRequest withSettings(Collection<ClusterSetting> settings)
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 will override the containerInsights
value set with
PutAccountSetting or PutAccountSettingDefault.
settings
- 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 will override the containerInsights
value set
with PutAccountSetting or PutAccountSettingDefault.public void setConfiguration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
configuration
- The execute command configuration for the cluster.public ClusterConfiguration getConfiguration()
The execute command configuration for the cluster.
public CreateClusterRequest withConfiguration(ClusterConfiguration configuration)
The execute command configuration for the cluster.
configuration
- The execute command configuration for the cluster.public List<String> getCapacityProviders()
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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS 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.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS 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 void setCapacityProviders(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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS 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.
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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS 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 CreateClusterRequest withCapacityProviders(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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS 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.
NOTE: This method appends the values to the existing list (if any). Use
setCapacityProviders(java.util.Collection)
or withCapacityProviders(java.util.Collection)
if
you want to override the existing values.
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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS 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 CreateClusterRequest withCapacityProviders(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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The AWS 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.
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 already be created and not already associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a AWS Fargate capacity provider, specify either the FARGATE
or
FARGATE_SPOT
capacity providers. The AWS 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 List<CapacityProviderStrategyItem> getDefaultCapacityProviderStrategy()
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
public void setDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
defaultCapacityProviderStrategy
- The capacity provider strategy to set as the default for the cluster. When a default capacity provider
strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no
capacity provider strategy or launch type specified, the default capacity provider strategy for the
cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
public CreateClusterRequest withDefaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
NOTE: This method appends the values to the existing list (if any). Use
setDefaultCapacityProviderStrategy(java.util.Collection)
or
withDefaultCapacityProviderStrategy(java.util.Collection)
if you want to override the existing values.
defaultCapacityProviderStrategy
- The capacity provider strategy to set as the default for the cluster. When a default capacity provider
strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no
capacity provider strategy or launch type specified, the default capacity provider strategy for the
cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
public CreateClusterRequest withDefaultCapacityProviderStrategy(Collection<CapacityProviderStrategyItem> defaultCapacityProviderStrategy)
The capacity provider strategy to set as the default for the cluster. When a default capacity provider strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no capacity provider strategy or launch type specified, the default capacity provider strategy for the cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
defaultCapacityProviderStrategy
- The capacity provider strategy to set as the default for the cluster. When a default capacity provider
strategy is set for a cluster, when calling the RunTask or CreateService APIs wtih no
capacity provider strategy or launch type specified, the default capacity provider strategy for the
cluster is used.
If a default capacity provider strategy is not defined for a cluster during creation, it can be defined later with the PutClusterCapacityProviders API operation.
public String toString()
toString
in class Object
Object.toString()
public CreateClusterRequest clone()
clone
in class AmazonWebServiceRequest
Copyright © 2021. All rights reserved.