Struct aws_sdk_ecs::client::fluent_builders::CreateTaskSet
source · [−]pub struct CreateTaskSet { /* private fields */ }
Expand description
Fluent builder constructing a request to CreateTaskSet
.
Create a task set in the specified cluster and service. This is used when a service uses the EXTERNAL
deployment controller type. For more information, see Amazon ECS Deployment Types in the Amazon Elastic Container Service Developer Guide.
Implementations
sourceimpl CreateTaskSet
impl CreateTaskSet
sourcepub async fn send(
self
) -> Result<CreateTaskSetOutput, SdkError<CreateTaskSetError>>
pub async fn send(
self
) -> Result<CreateTaskSetOutput, SdkError<CreateTaskSetError>>
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 fn service(self, input: impl Into<String>) -> Self
pub fn service(self, input: impl Into<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
sourcepub fn set_service(self, input: Option<String>) -> Self
pub fn set_service(self, input: Option<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
sourcepub fn cluster(self, input: impl Into<String>) -> Self
pub fn cluster(self, input: impl Into<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
sourcepub fn set_cluster(self, input: Option<String>) -> Self
pub fn set_cluster(self, input: Option<String>) -> Self
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
sourcepub fn external_id(self, input: impl Into<String>) -> Self
pub fn external_id(self, input: impl Into<String>) -> Self
An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute set to the provided value.
sourcepub fn set_external_id(self, input: Option<String>) -> Self
pub fn set_external_id(self, input: Option<String>) -> Self
An optional non-unique tag that identifies this task set in external systems. If the task set is associated with a service discovery registry, the tasks in this task set will have the ECS_TASK_SET_EXTERNAL_ID
Cloud Map attribute set to the provided value.
sourcepub fn task_definition(self, input: impl Into<String>) -> Self
pub fn task_definition(self, input: impl Into<String>) -> Self
The task definition for the tasks in the task set to use.
sourcepub fn set_task_definition(self, input: Option<String>) -> Self
pub fn set_task_definition(self, input: Option<String>) -> Self
The task definition for the tasks in the task set to use.
sourcepub fn network_configuration(self, input: NetworkConfiguration) -> Self
pub fn network_configuration(self, input: NetworkConfiguration) -> Self
An object representing the network configuration for a task set.
sourcepub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>
) -> Self
pub fn set_network_configuration(
self,
input: Option<NetworkConfiguration>
) -> Self
An object representing the network configuration for a task set.
sourcepub fn load_balancers(self, input: LoadBalancer) -> Self
pub fn load_balancers(self, input: LoadBalancer) -> Self
Appends an item to loadBalancers
.
To override the contents of this collection use set_load_balancers
.
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
sourcepub fn set_load_balancers(self, input: Option<Vec<LoadBalancer>>) -> Self
pub fn set_load_balancers(self, input: Option<Vec<LoadBalancer>>) -> Self
A load balancer object representing the load balancer to use with the task set. The supported load balancer types are either an Application Load Balancer or a Network Load Balancer.
sourcepub fn service_registries(self, input: ServiceRegistry) -> Self
pub fn service_registries(self, input: ServiceRegistry) -> Self
Appends an item to serviceRegistries
.
To override the contents of this collection use set_service_registries
.
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
sourcepub fn set_service_registries(self, input: Option<Vec<ServiceRegistry>>) -> Self
pub fn set_service_registries(self, input: Option<Vec<ServiceRegistry>>) -> Self
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
sourcepub fn launch_type(self, input: LaunchType) -> Self
pub fn launch_type(self, input: LaunchType) -> Self
The launch type that new tasks in the task set uses. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
sourcepub fn set_launch_type(self, input: Option<LaunchType>) -> Self
pub fn set_launch_type(self, input: Option<LaunchType>) -> Self
The launch type that new tasks in the task set uses. For more information, see Amazon ECS Launch Types in the Amazon Elastic Container Service Developer Guide.
If a launchType
is specified, the capacityProviderStrategy
parameter must be omitted.
sourcepub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem
) -> Self
pub fn capacity_provider_strategy(
self,
input: CapacityProviderStrategyItem
) -> Self
Appends an item to capacityProviderStrategy
.
To override the contents of this collection use set_capacity_provider_strategy
.
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider
API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders
API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
sourcepub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self
pub fn set_capacity_provider_strategy(
self,
input: Option<Vec<CapacityProviderStrategyItem>>
) -> Self
The capacity provider strategy to use for the task set.
A capacity provider strategy consists of one or more capacity providers along with the base
and weight
to assign to them. A capacity provider must be associated with the cluster to be used in a capacity provider strategy. The PutClusterCapacityProviders
API is used to associate a capacity provider with a cluster. Only capacity providers with an ACTIVE
or UPDATING
status can be used.
If a capacityProviderStrategy
is specified, the launchType
parameter must be omitted. If no capacityProviderStrategy
or launchType
is specified, the defaultCapacityProviderStrategy
for the cluster is used.
If specifying a capacity provider that uses an Auto Scaling group, the capacity provider must already be created. New capacity providers can be created with the CreateCapacityProvider
API operation.
To use a Fargate capacity provider, specify either the FARGATE
or FARGATE_SPOT
capacity providers. The Fargate capacity providers are available to all accounts and only need to be associated with a cluster to be used.
The PutClusterCapacityProviders
API operation is used to update the list of available capacity providers for a cluster after the cluster is created.
sourcepub fn platform_version(self, input: impl Into<String>) -> Self
pub fn platform_version(self, input: impl Into<String>) -> Self
The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST
platform version is used.
sourcepub fn set_platform_version(self, input: Option<String>) -> Self
pub fn set_platform_version(self, input: Option<String>) -> Self
The platform version that the tasks in the task set uses. A platform version is specified only for tasks using the Fargate launch type. If one isn't specified, the LATEST
platform version is used.
sourcepub fn scale(self, input: Scale) -> Self
pub fn scale(self, input: Scale) -> Self
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
sourcepub fn set_scale(self, input: Option<Scale>) -> Self
pub fn set_scale(self, input: Option<Scale>) -> Self
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
sourcepub fn client_token(self, input: impl Into<String>) -> Self
pub fn client_token(self, input: impl Into<String>) -> Self
The identifier that you provide to ensure the idempotency of the request. It's case sensitive and must be unique. It can be up to 32 ASCII characters are allowed.
sourcepub fn set_client_token(self, input: Option<String>) -> Self
pub fn set_client_token(self, input: Option<String>) -> Self
The identifier that you provide to ensure the idempotency of the request. It's case sensitive and must be unique. It can be up to 32 ASCII characters are allowed.
Appends an item to tags
.
To override the contents of this collection use set_tags
.
The metadata that you apply to the task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.
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 task set to help you categorize and organize them. Each tag consists of a key and an optional value. You define both. When a service is deleted, the tags are deleted.
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.
Trait Implementations
sourceimpl Clone for CreateTaskSet
impl Clone for CreateTaskSet
sourcefn clone(&self) -> CreateTaskSet
fn clone(&self) -> CreateTaskSet
Returns a copy of the value. Read more
1.0.0 · sourcefn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
Performs copy-assignment from source
. Read more
Auto Trait Implementations
impl !RefUnwindSafe for CreateTaskSet
impl Send for CreateTaskSet
impl Sync for CreateTaskSet
impl Unpin for CreateTaskSet
impl !UnwindSafe for CreateTaskSet
Blanket Implementations
sourceimpl<T> BorrowMut<T> for T where
T: ?Sized,
impl<T> BorrowMut<T> for T where
T: ?Sized,
const: unstable · sourcefn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more
sourceimpl<T> Instrument for T
impl<T> Instrument for T
sourcefn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
sourcefn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
sourceimpl<T> WithSubscriber for T
impl<T> WithSubscriber for T
sourcefn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> where
S: Into<Dispatch>,
Attaches the provided Subscriber
to this type, returning a
WithDispatch
wrapper. Read more
sourcefn with_current_subscriber(self) -> WithDispatch<Self>
fn with_current_subscriber(self) -> WithDispatch<Self>
Attaches the current default Subscriber
to this type, returning a
WithDispatch
wrapper. Read more