aws_sdk_ecs/operation/create_capacity_provider/
builders.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2pub use crate::operation::create_capacity_provider::_create_capacity_provider_output::CreateCapacityProviderOutputBuilder;
3
4pub use crate::operation::create_capacity_provider::_create_capacity_provider_input::CreateCapacityProviderInputBuilder;
5
6impl crate::operation::create_capacity_provider::builders::CreateCapacityProviderInputBuilder {
7    /// Sends a request with this input using the given client.
8    pub async fn send_with(
9        self,
10        client: &crate::Client,
11    ) -> ::std::result::Result<
12        crate::operation::create_capacity_provider::CreateCapacityProviderOutput,
13        ::aws_smithy_runtime_api::client::result::SdkError<
14            crate::operation::create_capacity_provider::CreateCapacityProviderError,
15            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
16        >,
17    > {
18        let mut fluent_builder = client.create_capacity_provider();
19        fluent_builder.inner = self;
20        fluent_builder.send().await
21    }
22}
23/// Fluent builder constructing a request to `CreateCapacityProvider`.
24///
25/// <p>Creates a capacity provider. Capacity providers are associated with a cluster and are used in capacity provider strategies to facilitate cluster auto scaling. You can create capacity providers for Amazon ECS Managed Instances and EC2 instances. Fargate has the predefined <code>FARGATE</code> and <code>FARGATE_SPOT</code> capacity providers.</p>
26#[derive(::std::clone::Clone, ::std::fmt::Debug)]
27pub struct CreateCapacityProviderFluentBuilder {
28    handle: ::std::sync::Arc<crate::client::Handle>,
29    inner: crate::operation::create_capacity_provider::builders::CreateCapacityProviderInputBuilder,
30    config_override: ::std::option::Option<crate::config::Builder>,
31}
32impl
33    crate::client::customize::internal::CustomizableSend<
34        crate::operation::create_capacity_provider::CreateCapacityProviderOutput,
35        crate::operation::create_capacity_provider::CreateCapacityProviderError,
36    > for CreateCapacityProviderFluentBuilder
37{
38    fn send(
39        self,
40        config_override: crate::config::Builder,
41    ) -> crate::client::customize::internal::BoxFuture<
42        crate::client::customize::internal::SendResult<
43            crate::operation::create_capacity_provider::CreateCapacityProviderOutput,
44            crate::operation::create_capacity_provider::CreateCapacityProviderError,
45        >,
46    > {
47        ::std::boxed::Box::pin(async move { self.config_override(config_override).send().await })
48    }
49}
50impl CreateCapacityProviderFluentBuilder {
51    /// Creates a new `CreateCapacityProviderFluentBuilder`.
52    pub(crate) fn new(handle: ::std::sync::Arc<crate::client::Handle>) -> Self {
53        Self {
54            handle,
55            inner: ::std::default::Default::default(),
56            config_override: ::std::option::Option::None,
57        }
58    }
59    /// Access the CreateCapacityProvider as a reference.
60    pub fn as_input(&self) -> &crate::operation::create_capacity_provider::builders::CreateCapacityProviderInputBuilder {
61        &self.inner
62    }
63    /// Sends the request and returns the response.
64    ///
65    /// If an error occurs, an `SdkError` will be returned with additional details that
66    /// can be matched against.
67    ///
68    /// By default, any retryable failures will be retried twice. Retry behavior
69    /// is configurable with the [RetryConfig](aws_smithy_types::retry::RetryConfig), which can be
70    /// set when configuring the client.
71    pub async fn send(
72        self,
73    ) -> ::std::result::Result<
74        crate::operation::create_capacity_provider::CreateCapacityProviderOutput,
75        ::aws_smithy_runtime_api::client::result::SdkError<
76            crate::operation::create_capacity_provider::CreateCapacityProviderError,
77            ::aws_smithy_runtime_api::client::orchestrator::HttpResponse,
78        >,
79    > {
80        let input = self
81            .inner
82            .build()
83            .map_err(::aws_smithy_runtime_api::client::result::SdkError::construction_failure)?;
84        let runtime_plugins = crate::operation::create_capacity_provider::CreateCapacityProvider::operation_runtime_plugins(
85            self.handle.runtime_plugins.clone(),
86            &self.handle.conf,
87            self.config_override,
88        );
89        crate::operation::create_capacity_provider::CreateCapacityProvider::orchestrate(&runtime_plugins, input).await
90    }
91
92    /// Consumes this builder, creating a customizable operation that can be modified before being sent.
93    pub fn customize(
94        self,
95    ) -> crate::client::customize::CustomizableOperation<
96        crate::operation::create_capacity_provider::CreateCapacityProviderOutput,
97        crate::operation::create_capacity_provider::CreateCapacityProviderError,
98        Self,
99    > {
100        crate::client::customize::CustomizableOperation::new(self)
101    }
102    pub(crate) fn config_override(mut self, config_override: impl ::std::convert::Into<crate::config::Builder>) -> Self {
103        self.set_config_override(::std::option::Option::Some(config_override.into()));
104        self
105    }
106
107    pub(crate) fn set_config_override(&mut self, config_override: ::std::option::Option<crate::config::Builder>) -> &mut Self {
108        self.config_override = config_override;
109        self
110    }
111    /// <p>The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "<code>aws</code>", "<code>ecs</code>", or "<code>fargate</code>".</p>
112    pub fn name(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
113        self.inner = self.inner.name(input.into());
114        self
115    }
116    /// <p>The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "<code>aws</code>", "<code>ecs</code>", or "<code>fargate</code>".</p>
117    pub fn set_name(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
118        self.inner = self.inner.set_name(input);
119        self
120    }
121    /// <p>The name of the capacity provider. Up to 255 characters are allowed. They include letters (both upper and lowercase letters), numbers, underscores (_), and hyphens (-). The name can't be prefixed with "<code>aws</code>", "<code>ecs</code>", or "<code>fargate</code>".</p>
122    pub fn get_name(&self) -> &::std::option::Option<::std::string::String> {
123        self.inner.get_name()
124    }
125    /// <p>The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.</p>
126    pub fn cluster(mut self, input: impl ::std::convert::Into<::std::string::String>) -> Self {
127        self.inner = self.inner.cluster(input.into());
128        self
129    }
130    /// <p>The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.</p>
131    pub fn set_cluster(mut self, input: ::std::option::Option<::std::string::String>) -> Self {
132        self.inner = self.inner.set_cluster(input);
133        self
134    }
135    /// <p>The name of the cluster to associate with the capacity provider. When you create a capacity provider with Amazon ECS Managed Instances, it becomes available only within the specified cluster.</p>
136    pub fn get_cluster(&self) -> &::std::option::Option<::std::string::String> {
137        self.inner.get_cluster()
138    }
139    /// <p>The details of the Auto Scaling group for the capacity provider.</p>
140    pub fn auto_scaling_group_provider(mut self, input: crate::types::AutoScalingGroupProvider) -> Self {
141        self.inner = self.inner.auto_scaling_group_provider(input);
142        self
143    }
144    /// <p>The details of the Auto Scaling group for the capacity provider.</p>
145    pub fn set_auto_scaling_group_provider(mut self, input: ::std::option::Option<crate::types::AutoScalingGroupProvider>) -> Self {
146        self.inner = self.inner.set_auto_scaling_group_provider(input);
147        self
148    }
149    /// <p>The details of the Auto Scaling group for the capacity provider.</p>
150    pub fn get_auto_scaling_group_provider(&self) -> &::std::option::Option<crate::types::AutoScalingGroupProvider> {
151        self.inner.get_auto_scaling_group_provider()
152    }
153    /// <p>The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.</p>
154    pub fn managed_instances_provider(mut self, input: crate::types::CreateManagedInstancesProviderConfiguration) -> Self {
155        self.inner = self.inner.managed_instances_provider(input);
156        self
157    }
158    /// <p>The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.</p>
159    pub fn set_managed_instances_provider(mut self, input: ::std::option::Option<crate::types::CreateManagedInstancesProviderConfiguration>) -> Self {
160        self.inner = self.inner.set_managed_instances_provider(input);
161        self
162    }
163    /// <p>The configuration for the Amazon ECS Managed Instances provider. This configuration specifies how Amazon ECS manages Amazon EC2 instances on your behalf, including the infrastructure role, instance launch template, and tag propagation settings.</p>
164    pub fn get_managed_instances_provider(&self) -> &::std::option::Option<crate::types::CreateManagedInstancesProviderConfiguration> {
165        self.inner.get_managed_instances_provider()
166    }
167    ///
168    /// Appends an item to `tags`.
169    ///
170    /// To override the contents of this collection use [`set_tags`](Self::set_tags).
171    ///
172    /// <p>The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.</p>
173    /// <p>The following basic restrictions apply to tags:</p>
174    /// <ul>
175    /// <li>
176    /// <p>Maximum number of tags per resource - 50</p></li>
177    /// <li>
178    /// <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>
179    /// <li>
180    /// <p>Maximum key length - 128 Unicode characters in UTF-8</p></li>
181    /// <li>
182    /// <p>Maximum value length - 256 Unicode characters in UTF-8</p></li>
183    /// <li>
184    /// <p>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: + - = . _ : / @.</p></li>
185    /// <li>
186    /// <p>Tag keys and values are case-sensitive.</p></li>
187    /// <li>
188    /// <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p></li>
189    /// </ul>
190    pub fn tags(mut self, input: crate::types::Tag) -> Self {
191        self.inner = self.inner.tags(input);
192        self
193    }
194    /// <p>The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.</p>
195    /// <p>The following basic restrictions apply to tags:</p>
196    /// <ul>
197    /// <li>
198    /// <p>Maximum number of tags per resource - 50</p></li>
199    /// <li>
200    /// <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>
201    /// <li>
202    /// <p>Maximum key length - 128 Unicode characters in UTF-8</p></li>
203    /// <li>
204    /// <p>Maximum value length - 256 Unicode characters in UTF-8</p></li>
205    /// <li>
206    /// <p>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: + - = . _ : / @.</p></li>
207    /// <li>
208    /// <p>Tag keys and values are case-sensitive.</p></li>
209    /// <li>
210    /// <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p></li>
211    /// </ul>
212    pub fn set_tags(mut self, input: ::std::option::Option<::std::vec::Vec<crate::types::Tag>>) -> Self {
213        self.inner = self.inner.set_tags(input);
214        self
215    }
216    /// <p>The metadata that you apply to the capacity provider to categorize and organize them more conveniently. Each tag consists of a key and an optional value. You define both of them.</p>
217    /// <p>The following basic restrictions apply to tags:</p>
218    /// <ul>
219    /// <li>
220    /// <p>Maximum number of tags per resource - 50</p></li>
221    /// <li>
222    /// <p>For each resource, each tag key must be unique, and each tag key can have only one value.</p></li>
223    /// <li>
224    /// <p>Maximum key length - 128 Unicode characters in UTF-8</p></li>
225    /// <li>
226    /// <p>Maximum value length - 256 Unicode characters in UTF-8</p></li>
227    /// <li>
228    /// <p>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: + - = . _ : / @.</p></li>
229    /// <li>
230    /// <p>Tag keys and values are case-sensitive.</p></li>
231    /// <li>
232    /// <p>Do not use <code>aws:</code>, <code>AWS:</code>, 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.</p></li>
233    /// </ul>
234    pub fn get_tags(&self) -> &::std::option::Option<::std::vec::Vec<crate::types::Tag>> {
235        self.inner.get_tags()
236    }
237}