pub struct CreateClusterFluentBuilder { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateCluster
.
Creates a new Amazon ECS cluster. By default, your account receives a default
cluster when you launch your first container instance. However, you can create your own cluster with a unique name with the CreateCluster
action.
When you call the CreateCluster
API operation, Amazon ECS attempts to create the Amazon ECS service-linked role for your account. This is so that it can manage required resources in other Amazon Web Services services on your behalf. However, if the user that makes the call doesn't have permissions to create the service-linked role, it isn't created. For more information, see Using service-linked roles for Amazon ECS in the Amazon Elastic Container Service Developer Guide.
Implementations§
source§impl CreateClusterFluentBuilder
impl CreateClusterFluentBuilder
sourcepub fn as_input(&self) -> &CreateClusterInputBuilder
pub fn as_input(&self) -> &CreateClusterInputBuilder
Access the CreateCluster as a reference.
sourcepub async fn send(
self
) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
pub async fn send( self ) -> Result<CreateClusterOutput, SdkError<CreateClusterError, HttpResponse>>
Sends the request and returns the response.
If an error occurs, an SdkError
will be returned with additional details that
can be matched against.
By default, any retryable failures will be retried twice. Retry behavior is configurable with the RetryConfig, which can be set when configuring the client.
sourcepub async fn customize(
self
) -> Result<CustomizableOperation<CreateClusterOutput, CreateClusterError>, SdkError<CreateClusterError>>
pub async fn customize( self ) -> Result<CustomizableOperation<CreateClusterOutput, CreateClusterError>, SdkError<CreateClusterError>>
Consumes this builder, creating a customizable operation that can be modified before being sent.
sourcepub fn cluster_name(self, input: impl Into<String>) -> Self
pub fn cluster_name(self, input: impl Into<String>) -> Self
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.
sourcepub fn set_cluster_name(self, input: Option<String>) -> Self
pub fn set_cluster_name(self, input: Option<String>) -> Self
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.
sourcepub fn get_cluster_name(&self) -> &Option<String>
pub fn get_cluster_name(&self) -> &Option<String>
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.
Appends an item to tags
.
To override the contents of this collection use set_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.
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.
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.
sourcepub fn settings(self, input: ClusterSetting) -> Self
pub fn settings(self, input: ClusterSetting) -> Self
Appends an item to settings
.
To override the contents of this collection use set_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
.
sourcepub fn set_settings(self, input: Option<Vec<ClusterSetting>>) -> Self
pub fn set_settings(self, input: Option<Vec<ClusterSetting>>) -> Self
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
.
sourcepub fn get_settings(&self) -> &Option<Vec<ClusterSetting>>
pub fn get_settings(&self) -> &Option<Vec<ClusterSetting>>
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
.
sourcepub fn configuration(self, input: ClusterConfiguration) -> Self
pub fn configuration(self, input: ClusterConfiguration) -> Self
The execute
command configuration for the cluster.
sourcepub fn set_configuration(self, input: Option<ClusterConfiguration>) -> Self
pub fn set_configuration(self, input: Option<ClusterConfiguration>) -> Self
The execute
command configuration for the cluster.
sourcepub fn get_configuration(&self) -> &Option<ClusterConfiguration>
pub fn get_configuration(&self) -> &Option<ClusterConfiguration>
The execute
command configuration for the cluster.
sourcepub fn capacity_providers(self, input: impl Into<String>) -> Self
pub fn capacity_providers(self, input: impl Into<String>) -> Self
Appends an item to capacityProviders
.
To override the contents of this collection use set_capacity_providers
.
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.
sourcepub fn set_capacity_providers(self, input: Option<Vec<String>>) -> Self
pub fn set_capacity_providers(self, input: Option<Vec<String>>) -> Self
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.
sourcepub fn get_capacity_providers(&self) -> &Option<Vec<String>>
pub fn get_capacity_providers(&self) -> &Option<Vec<String>>
The short name of one or more capacity providers to associate with the cluster. A capacity provider must be associated with a cluster before it can be included as part of the default capacity provider strategy of the cluster or used in a capacity provider strategy when calling the CreateService or RunTask actions.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must be created but not associated with another cluster. New Auto Scaling group capacity providers can be created with the CreateCapacityProvider API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutCapacityProvider API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
sourcepub fn default_capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem
) -> Self
pub fn default_capacity_provider_strategy( self, input: CapacityProviderStrategyItem ) -> Self
Appends an item to defaultCapacityProviderStrategy
.
To override the contents of this collection use set_default_capacity_provider_strategy
.
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.
sourcepub fn set_default_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self
pub fn set_default_capacity_provider_strategy( self, input: Option<Vec<CapacityProviderStrategyItem>> ) -> Self
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.
sourcepub fn get_default_capacity_provider_strategy(
&self
) -> &Option<Vec<CapacityProviderStrategyItem>>
pub fn get_default_capacity_provider_strategy( &self ) -> &Option<Vec<CapacityProviderStrategyItem>>
The capacity provider strategy to set as the default for the cluster. After a default capacity provider strategy is set for a cluster, when you call the 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.
sourcepub fn service_connect_defaults(
self,
input: ClusterServiceConnectDefaultsRequest
) -> Self
pub fn service_connect_defaults( self, input: ClusterServiceConnectDefaultsRequest ) -> Self
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.
sourcepub fn set_service_connect_defaults(
self,
input: Option<ClusterServiceConnectDefaultsRequest>
) -> Self
pub fn set_service_connect_defaults( self, input: Option<ClusterServiceConnectDefaultsRequest> ) -> Self
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.
sourcepub fn get_service_connect_defaults(
&self
) -> &Option<ClusterServiceConnectDefaultsRequest>
pub fn get_service_connect_defaults( &self ) -> &Option<ClusterServiceConnectDefaultsRequest>
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.
Trait Implementations§
source§impl Clone for CreateClusterFluentBuilder
impl Clone for CreateClusterFluentBuilder
source§fn clone(&self) -> CreateClusterFluentBuilder
fn clone(&self) -> CreateClusterFluentBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read more