software.amazon.awssdk.services.ecs.model.CreateClusterRequest Maven / Gradle / Ivy
Show all versions of ecs Show documentation
/*
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
*
* Licensed under the Apache License, Version 2.0 (the "License"). You may not use this file except in compliance with
* the License. A copy of the License is located at
*
* http://aws.amazon.com/apache2.0
*
* or in the "license" file accompanying this file. This file is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR
* CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions
* and limitations under the License.
*/
package software.amazon.awssdk.services.ecs.model;
import java.beans.Transient;
import java.util.Arrays;
import java.util.Collection;
import java.util.Collections;
import java.util.List;
import java.util.Objects;
import java.util.Optional;
import java.util.function.BiConsumer;
import java.util.function.Consumer;
import java.util.function.Function;
import java.util.stream.Collectors;
import java.util.stream.Stream;
import software.amazon.awssdk.annotations.Generated;
import software.amazon.awssdk.awscore.AwsRequestOverrideConfiguration;
import software.amazon.awssdk.core.SdkField;
import software.amazon.awssdk.core.SdkPojo;
import software.amazon.awssdk.core.protocol.MarshallLocation;
import software.amazon.awssdk.core.protocol.MarshallingType;
import software.amazon.awssdk.core.traits.ListTrait;
import software.amazon.awssdk.core.traits.LocationTrait;
import software.amazon.awssdk.core.util.DefaultSdkAutoConstructList;
import software.amazon.awssdk.core.util.SdkAutoConstructList;
import software.amazon.awssdk.utils.ToString;
import software.amazon.awssdk.utils.builder.CopyableBuilder;
import software.amazon.awssdk.utils.builder.ToCopyableBuilder;
/**
*/
@Generated("software.amazon.awssdk:codegen")
public final class CreateClusterRequest extends EcsRequest implements
ToCopyableBuilder {
private static final SdkField CLUSTER_NAME_FIELD = SdkField. builder(MarshallingType.STRING)
.memberName("clusterName").getter(getter(CreateClusterRequest::clusterName)).setter(setter(Builder::clusterName))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("clusterName").build()).build();
private static final SdkField> TAGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("tags")
.getter(getter(CreateClusterRequest::tags))
.setter(setter(Builder::tags))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("tags").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(Tag::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> SETTINGS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("settings")
.getter(getter(CreateClusterRequest::settings))
.setter(setter(Builder::settings))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("settings").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(ClusterSetting::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField CONFIGURATION_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("configuration")
.getter(getter(CreateClusterRequest::configuration)).setter(setter(Builder::configuration))
.constructor(ClusterConfiguration::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("configuration").build()).build();
private static final SdkField> CAPACITY_PROVIDERS_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("capacityProviders")
.getter(getter(CreateClusterRequest::capacityProviders))
.setter(setter(Builder::capacityProviders))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("capacityProviders").build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.STRING)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField> DEFAULT_CAPACITY_PROVIDER_STRATEGY_FIELD = SdkField
.> builder(MarshallingType.LIST)
.memberName("defaultCapacityProviderStrategy")
.getter(getter(CreateClusterRequest::defaultCapacityProviderStrategy))
.setter(setter(Builder::defaultCapacityProviderStrategy))
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("defaultCapacityProviderStrategy")
.build(),
ListTrait
.builder()
.memberLocationName(null)
.memberFieldInfo(
SdkField. builder(MarshallingType.SDK_POJO)
.constructor(CapacityProviderStrategyItem::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD)
.locationName("member").build()).build()).build()).build();
private static final SdkField SERVICE_CONNECT_DEFAULTS_FIELD = SdkField
. builder(MarshallingType.SDK_POJO).memberName("serviceConnectDefaults")
.getter(getter(CreateClusterRequest::serviceConnectDefaults)).setter(setter(Builder::serviceConnectDefaults))
.constructor(ClusterServiceConnectDefaultsRequest::builder)
.traits(LocationTrait.builder().location(MarshallLocation.PAYLOAD).locationName("serviceConnectDefaults").build())
.build();
private static final List> SDK_FIELDS = Collections.unmodifiableList(Arrays.asList(CLUSTER_NAME_FIELD,
TAGS_FIELD, SETTINGS_FIELD, CONFIGURATION_FIELD, CAPACITY_PROVIDERS_FIELD, DEFAULT_CAPACITY_PROVIDER_STRATEGY_FIELD,
SERVICE_CONNECT_DEFAULTS_FIELD));
private final String clusterName;
private final List tags;
private final List settings;
private final ClusterConfiguration configuration;
private final List capacityProviders;
private final List defaultCapacityProviderStrategy;
private final ClusterServiceConnectDefaultsRequest serviceConnectDefaults;
private CreateClusterRequest(BuilderImpl builder) {
super(builder);
this.clusterName = builder.clusterName;
this.tags = builder.tags;
this.settings = builder.settings;
this.configuration = builder.configuration;
this.capacityProviders = builder.capacityProviders;
this.defaultCapacityProviderStrategy = builder.defaultCapacityProviderStrategy;
this.serviceConnectDefaults = builder.serviceConnectDefaults;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final String clusterName() {
return clusterName;
}
/**
* For responses, this returns true if the service returned a value for the Tags property. This DOES NOT check that
* the value is non-empty (for which, you should check the {@code 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 boolean hasTags() {
return tags != null && !(tags instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasTags} method.
*
*
* @return 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.
*
*
*/
public final List tags() {
return tags;
}
/**
* For responses, this returns true if the service returned a value for the Settings property. This DOES NOT check
* that the value is non-empty (for which, you should check the {@code 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 boolean hasSettings() {
return settings != null && !(settings instanceof SdkAutoConstructList);
}
/**
*
* 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 {@link #hasSettings} method.
*
*
* @return 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.
*/
public final List settings() {
return settings;
}
/**
*
* The execute command configuration for the cluster.
*
*
* @return The execute command configuration for the cluster.
*/
public final ClusterConfiguration configuration() {
return configuration;
}
/**
* For responses, this returns true if the service returned a value for the CapacityProviders property. This DOES
* NOT check that the value is non-empty (for which, you should check the {@code 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 boolean hasCapacityProviders() {
return capacityProviders != null && !(capacityProviders instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
* 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 {@link #hasCapacityProviders} method.
*
*
* @return 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.
*/
public final List capacityProviders() {
return capacityProviders;
}
/**
* For responses, this returns true if the service returned a value for the DefaultCapacityProviderStrategy
* property. This DOES NOT check that the value is non-empty (for which, you should check the {@code 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 boolean hasDefaultCapacityProviderStrategy() {
return defaultCapacityProviderStrategy != null && !(defaultCapacityProviderStrategy instanceof SdkAutoConstructList);
}
/**
*
* 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.
*
*
* 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 {@link #hasDefaultCapacityProviderStrategy}
* method.
*
*
* @return 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.
*/
public final List defaultCapacityProviderStrategy() {
return defaultCapacityProviderStrategy;
}
/**
*
* 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.
*
*
* @return 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.
*/
public final ClusterServiceConnectDefaultsRequest serviceConnectDefaults() {
return serviceConnectDefaults;
}
@Override
public Builder toBuilder() {
return new BuilderImpl(this);
}
public static Builder builder() {
return new BuilderImpl();
}
public static Class serializableBuilderClass() {
return BuilderImpl.class;
}
@Override
public final int hashCode() {
int hashCode = 1;
hashCode = 31 * hashCode + super.hashCode();
hashCode = 31 * hashCode + Objects.hashCode(clusterName());
hashCode = 31 * hashCode + Objects.hashCode(hasTags() ? tags() : null);
hashCode = 31 * hashCode + Objects.hashCode(hasSettings() ? settings() : null);
hashCode = 31 * hashCode + Objects.hashCode(configuration());
hashCode = 31 * hashCode + Objects.hashCode(hasCapacityProviders() ? capacityProviders() : null);
hashCode = 31 * hashCode
+ Objects.hashCode(hasDefaultCapacityProviderStrategy() ? defaultCapacityProviderStrategy() : null);
hashCode = 31 * hashCode + Objects.hashCode(serviceConnectDefaults());
return hashCode;
}
@Override
public final boolean equals(Object obj) {
return super.equals(obj) && equalsBySdkFields(obj);
}
@Override
public final boolean equalsBySdkFields(Object obj) {
if (this == obj) {
return true;
}
if (obj == null) {
return false;
}
if (!(obj instanceof CreateClusterRequest)) {
return false;
}
CreateClusterRequest other = (CreateClusterRequest) obj;
return Objects.equals(clusterName(), other.clusterName()) && hasTags() == other.hasTags()
&& Objects.equals(tags(), other.tags()) && hasSettings() == other.hasSettings()
&& Objects.equals(settings(), other.settings()) && Objects.equals(configuration(), other.configuration())
&& hasCapacityProviders() == other.hasCapacityProviders()
&& Objects.equals(capacityProviders(), other.capacityProviders())
&& hasDefaultCapacityProviderStrategy() == other.hasDefaultCapacityProviderStrategy()
&& Objects.equals(defaultCapacityProviderStrategy(), other.defaultCapacityProviderStrategy())
&& Objects.equals(serviceConnectDefaults(), other.serviceConnectDefaults());
}
/**
* Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be
* redacted from this string using a placeholder value.
*/
@Override
public final String toString() {
return ToString
.builder("CreateClusterRequest")
.add("ClusterName", clusterName())
.add("Tags", hasTags() ? tags() : null)
.add("Settings", hasSettings() ? settings() : null)
.add("Configuration", configuration())
.add("CapacityProviders", hasCapacityProviders() ? capacityProviders() : null)
.add("DefaultCapacityProviderStrategy",
hasDefaultCapacityProviderStrategy() ? defaultCapacityProviderStrategy() : null)
.add("ServiceConnectDefaults", serviceConnectDefaults()).build();
}
public final Optional getValueForField(String fieldName, Class clazz) {
switch (fieldName) {
case "clusterName":
return Optional.ofNullable(clazz.cast(clusterName()));
case "tags":
return Optional.ofNullable(clazz.cast(tags()));
case "settings":
return Optional.ofNullable(clazz.cast(settings()));
case "configuration":
return Optional.ofNullable(clazz.cast(configuration()));
case "capacityProviders":
return Optional.ofNullable(clazz.cast(capacityProviders()));
case "defaultCapacityProviderStrategy":
return Optional.ofNullable(clazz.cast(defaultCapacityProviderStrategy()));
case "serviceConnectDefaults":
return Optional.ofNullable(clazz.cast(serviceConnectDefaults()));
default:
return Optional.empty();
}
}
@Override
public final List> sdkFields() {
return SDK_FIELDS;
}
private static Function getter(Function g) {
return obj -> g.apply((CreateClusterRequest) obj);
}
private static BiConsumer setter(BiConsumer s) {
return (obj, val) -> s.accept((Builder) obj, val);
}
public interface Builder extends EcsRequest.Builder, SdkPojo, CopyableBuilder {
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder clusterName(String clusterName);
/**
*
* 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder tags(Collection 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.
*
*
*
*
* @param 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.
*
*
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
*
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.Tag.Builder} avoiding the need to create one manually via
* {@link software.amazon.awssdk.services.ecs.model.Tag#builder()}.
*
*
* When the {@link Consumer} completes, {@link software.amazon.awssdk.services.ecs.model.Tag.Builder#build()} is
* called immediately and its result is passed to {@link #tags(List)}.
*
* @param tags
* a consumer that will call methods on {@link software.amazon.awssdk.services.ecs.model.Tag.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #tags(java.util.Collection)
*/
Builder tags(Consumer... tags);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder settings(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.ClusterSetting.Builder} avoiding the need to create one
* manually via {@link software.amazon.awssdk.services.ecs.model.ClusterSetting#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.ClusterSetting.Builder#build()} is called immediately and
* its result is passed to {@link #settings(List)}.
*
* @param settings
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ecs.model.ClusterSetting.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #settings(java.util.Collection)
*/
Builder settings(Consumer... settings);
/**
*
* The execute command configuration for the cluster.
*
*
* @param configuration
* The execute command configuration for the cluster.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder configuration(ClusterConfiguration configuration);
/**
*
* The execute command configuration for the cluster.
*
* This is a convenience method that creates an instance of the {@link ClusterConfiguration.Builder} avoiding
* the need to create one manually via {@link ClusterConfiguration#builder()}.
*
*
* When the {@link Consumer} completes, {@link ClusterConfiguration.Builder#build()} is called immediately and
* its result is passed to {@link #configuration(ClusterConfiguration)}.
*
* @param configuration
* a consumer that will call methods on {@link ClusterConfiguration.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #configuration(ClusterConfiguration)
*/
default Builder configuration(Consumer configuration) {
return configuration(ClusterConfiguration.builder().applyMutation(configuration).build());
}
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capacityProviders(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder capacityProviders(String... capacityProviders);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
Builder defaultCapacityProviderStrategy(Collection 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
* This is a convenience method that creates an instance of the
* {@link software.amazon.awssdk.services.ecs.model.CapacityProviderStrategyItem.Builder} avoiding the need to
* create one manually via
* {@link software.amazon.awssdk.services.ecs.model.CapacityProviderStrategyItem#builder()}.
*
*
* When the {@link Consumer} completes,
* {@link software.amazon.awssdk.services.ecs.model.CapacityProviderStrategyItem.Builder#build()} is called
* immediately and its result is passed to {@link
* #defaultCapacityProviderStrategy(List)}.
*
* @param defaultCapacityProviderStrategy
* a consumer that will call methods on
* {@link software.amazon.awssdk.services.ecs.model.CapacityProviderStrategyItem.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #defaultCapacityProviderStrategy(java.util.Collection)
*/
Builder defaultCapacityProviderStrategy(Consumer... defaultCapacityProviderStrategy);
/**
*
* 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.
*
*
* @param 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.
* @return Returns a reference to this object so that method calls can be chained together.
*/
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.
*
* This is a convenience method that creates an instance of the
* {@link ClusterServiceConnectDefaultsRequest.Builder} avoiding the need to create one manually via
* {@link ClusterServiceConnectDefaultsRequest#builder()}.
*
*
* When the {@link Consumer} completes, {@link ClusterServiceConnectDefaultsRequest.Builder#build()} is called
* immediately and its result is passed to {@link #serviceConnectDefaults(ClusterServiceConnectDefaultsRequest)}.
*
* @param serviceConnectDefaults
* a consumer that will call methods on {@link ClusterServiceConnectDefaultsRequest.Builder}
* @return Returns a reference to this object so that method calls can be chained together.
* @see #serviceConnectDefaults(ClusterServiceConnectDefaultsRequest)
*/
default Builder serviceConnectDefaults(Consumer serviceConnectDefaults) {
return serviceConnectDefaults(ClusterServiceConnectDefaultsRequest.builder().applyMutation(serviceConnectDefaults)
.build());
}
@Override
Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration);
@Override
Builder overrideConfiguration(Consumer builderConsumer);
}
static final class BuilderImpl extends EcsRequest.BuilderImpl implements Builder {
private String clusterName;
private List tags = DefaultSdkAutoConstructList.getInstance();
private List settings = DefaultSdkAutoConstructList.getInstance();
private ClusterConfiguration configuration;
private List capacityProviders = DefaultSdkAutoConstructList.getInstance();
private List defaultCapacityProviderStrategy = DefaultSdkAutoConstructList.getInstance();
private ClusterServiceConnectDefaultsRequest serviceConnectDefaults;
private BuilderImpl() {
}
private BuilderImpl(CreateClusterRequest model) {
super(model);
clusterName(model.clusterName);
tags(model.tags);
settings(model.settings);
configuration(model.configuration);
capacityProviders(model.capacityProviders);
defaultCapacityProviderStrategy(model.defaultCapacityProviderStrategy);
serviceConnectDefaults(model.serviceConnectDefaults);
}
public final String getClusterName() {
return clusterName;
}
public final void setClusterName(String clusterName) {
this.clusterName = clusterName;
}
@Override
public final Builder clusterName(String clusterName) {
this.clusterName = clusterName;
return this;
}
public final List getTags() {
List result = TagsCopier.copyToBuilder(this.tags);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setTags(Collection tags) {
this.tags = TagsCopier.copyFromBuilder(tags);
}
@Override
public final Builder tags(Collection tags) {
this.tags = TagsCopier.copy(tags);
return this;
}
@Override
@SafeVarargs
public final Builder tags(Tag... tags) {
tags(Arrays.asList(tags));
return this;
}
@Override
@SafeVarargs
public final Builder tags(Consumer... tags) {
tags(Stream.of(tags).map(c -> Tag.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final List getSettings() {
List result = ClusterSettingsCopier.copyToBuilder(this.settings);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setSettings(Collection settings) {
this.settings = ClusterSettingsCopier.copyFromBuilder(settings);
}
@Override
@Transient
public final Builder settings(Collection settings) {
this.settings = ClusterSettingsCopier.copy(settings);
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder settings(ClusterSetting... settings) {
settings(Arrays.asList(settings));
return this;
}
@Override
@Transient
@SafeVarargs
public final Builder settings(Consumer... settings) {
settings(Stream.of(settings).map(c -> ClusterSetting.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final ClusterConfiguration.Builder getConfiguration() {
return configuration != null ? configuration.toBuilder() : null;
}
public final void setConfiguration(ClusterConfiguration.BuilderImpl configuration) {
this.configuration = configuration != null ? configuration.build() : null;
}
@Override
public final Builder configuration(ClusterConfiguration configuration) {
this.configuration = configuration;
return this;
}
public final Collection getCapacityProviders() {
if (capacityProviders instanceof SdkAutoConstructList) {
return null;
}
return capacityProviders;
}
public final void setCapacityProviders(Collection capacityProviders) {
this.capacityProviders = StringListCopier.copy(capacityProviders);
}
@Override
public final Builder capacityProviders(Collection capacityProviders) {
this.capacityProviders = StringListCopier.copy(capacityProviders);
return this;
}
@Override
@SafeVarargs
public final Builder capacityProviders(String... capacityProviders) {
capacityProviders(Arrays.asList(capacityProviders));
return this;
}
public final List getDefaultCapacityProviderStrategy() {
List result = CapacityProviderStrategyCopier
.copyToBuilder(this.defaultCapacityProviderStrategy);
if (result instanceof SdkAutoConstructList) {
return null;
}
return result;
}
public final void setDefaultCapacityProviderStrategy(
Collection defaultCapacityProviderStrategy) {
this.defaultCapacityProviderStrategy = CapacityProviderStrategyCopier
.copyFromBuilder(defaultCapacityProviderStrategy);
}
@Override
public final Builder defaultCapacityProviderStrategy(
Collection defaultCapacityProviderStrategy) {
this.defaultCapacityProviderStrategy = CapacityProviderStrategyCopier.copy(defaultCapacityProviderStrategy);
return this;
}
@Override
@SafeVarargs
public final Builder defaultCapacityProviderStrategy(CapacityProviderStrategyItem... defaultCapacityProviderStrategy) {
defaultCapacityProviderStrategy(Arrays.asList(defaultCapacityProviderStrategy));
return this;
}
@Override
@SafeVarargs
public final Builder defaultCapacityProviderStrategy(
Consumer... defaultCapacityProviderStrategy) {
defaultCapacityProviderStrategy(Stream.of(defaultCapacityProviderStrategy)
.map(c -> CapacityProviderStrategyItem.builder().applyMutation(c).build()).collect(Collectors.toList()));
return this;
}
public final ClusterServiceConnectDefaultsRequest.Builder getServiceConnectDefaults() {
return serviceConnectDefaults != null ? serviceConnectDefaults.toBuilder() : null;
}
public final void setServiceConnectDefaults(ClusterServiceConnectDefaultsRequest.BuilderImpl serviceConnectDefaults) {
this.serviceConnectDefaults = serviceConnectDefaults != null ? serviceConnectDefaults.build() : null;
}
@Override
public final Builder serviceConnectDefaults(ClusterServiceConnectDefaultsRequest serviceConnectDefaults) {
this.serviceConnectDefaults = serviceConnectDefaults;
return this;
}
@Override
public Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) {
super.overrideConfiguration(overrideConfiguration);
return this;
}
@Override
public Builder overrideConfiguration(Consumer builderConsumer) {
super.overrideConfiguration(builderConsumer);
return this;
}
@Override
public CreateClusterRequest build() {
return new CreateClusterRequest(this);
}
@Override
public List> sdkFields() {
return SDK_FIELDS;
}
}
}