Struct aws_sdk_ecs::input::CreateTaskSetInput
source · [−]#[non_exhaustive]pub struct CreateTaskSetInput {Show 13 fields
pub service: Option<String>,
pub cluster: Option<String>,
pub external_id: Option<String>,
pub task_definition: Option<String>,
pub network_configuration: Option<NetworkConfiguration>,
pub load_balancers: Option<Vec<LoadBalancer>>,
pub service_registries: Option<Vec<ServiceRegistry>>,
pub launch_type: Option<LaunchType>,
pub capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>,
pub platform_version: Option<String>,
pub scale: Option<Scale>,
pub client_token: Option<String>,
pub tags: Option<Vec<Tag>>,
}
Fields (Non-exhaustive)
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.service: Option<String>
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
cluster: Option<String>
The short name or full Amazon Resource Name (ARN) of the cluster that hosts the service to create the task set in.
external_id: Option<String>
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.
task_definition: Option<String>
The task definition for the tasks in the task set to use.
network_configuration: Option<NetworkConfiguration>
An object representing the network configuration for a task set.
load_balancers: Option<Vec<LoadBalancer>>
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.
service_registries: Option<Vec<ServiceRegistry>>
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
launch_type: Option<LaunchType>
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.
capacity_provider_strategy: Option<Vec<CapacityProviderStrategyItem>>
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.
platform_version: Option<String>
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.
scale: Option<Scale>
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
client_token: Option<String>
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.
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.
Implementations
sourceimpl CreateTaskSetInput
impl CreateTaskSetInput
sourcepub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTaskSet, AwsErrorRetryPolicy>, BuildError>
pub async fn make_operation(
&self,
_config: &Config
) -> Result<Operation<CreateTaskSet, AwsErrorRetryPolicy>, BuildError>
Consumes the builder and constructs an Operation<CreateTaskSet
>
sourcepub fn builder() -> Builder
pub fn builder() -> Builder
Creates a new builder-style object to manufacture CreateTaskSetInput
sourceimpl CreateTaskSetInput
impl CreateTaskSetInput
sourcepub fn service(&self) -> Option<&str>
pub fn service(&self) -> Option<&str>
The short name or full Amazon Resource Name (ARN) of the service to create the task set in.
sourcepub fn cluster(&self) -> Option<&str>
pub fn cluster(&self) -> Option<&str>
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) -> Option<&str>
pub fn external_id(&self) -> Option<&str>
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) -> Option<&str>
pub fn task_definition(&self) -> Option<&str>
The task definition for the tasks in the task set to use.
sourcepub fn network_configuration(&self) -> Option<&NetworkConfiguration>
pub fn network_configuration(&self) -> Option<&NetworkConfiguration>
An object representing the network configuration for a task set.
sourcepub fn load_balancers(&self) -> Option<&[LoadBalancer]>
pub fn load_balancers(&self) -> Option<&[LoadBalancer]>
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) -> Option<&[ServiceRegistry]>
pub fn service_registries(&self) -> Option<&[ServiceRegistry]>
The details of the service discovery registries to assign to this task set. For more information, see Service Discovery.
sourcepub fn launch_type(&self) -> Option<&LaunchType>
pub fn launch_type(&self) -> Option<&LaunchType>
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
) -> Option<&[CapacityProviderStrategyItem]>
pub fn capacity_provider_strategy(
&self
) -> Option<&[CapacityProviderStrategyItem]>
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) -> Option<&str>
pub fn platform_version(&self) -> Option<&str>
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) -> Option<&Scale>
pub fn scale(&self) -> Option<&Scale>
A floating-point percentage of the desired number of tasks to place and keep running in the task set.
sourcepub fn client_token(&self) -> Option<&str>
pub fn client_token(&self) -> Option<&str>
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.
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 CreateTaskSetInput
impl Clone for CreateTaskSetInput
sourcefn clone(&self) -> CreateTaskSetInput
fn clone(&self) -> CreateTaskSetInput
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
sourceimpl Debug for CreateTaskSetInput
impl Debug for CreateTaskSetInput
sourceimpl PartialEq<CreateTaskSetInput> for CreateTaskSetInput
impl PartialEq<CreateTaskSetInput> for CreateTaskSetInput
sourcefn eq(&self, other: &CreateTaskSetInput) -> bool
fn eq(&self, other: &CreateTaskSetInput) -> bool
This method tests for self
and other
values to be equal, and is used
by ==
. Read more
sourcefn ne(&self, other: &CreateTaskSetInput) -> bool
fn ne(&self, other: &CreateTaskSetInput) -> bool
This method tests for !=
.
impl StructuralPartialEq for CreateTaskSetInput
Auto Trait Implementations
impl RefUnwindSafe for CreateTaskSetInput
impl Send for CreateTaskSetInput
impl Sync for CreateTaskSetInput
impl Unpin for CreateTaskSetInput
impl UnwindSafe for CreateTaskSetInput
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