aws_sdk_apigateway/client/
create_deployment.rs

1// Code generated by software.amazon.smithy.rust.codegen.smithy-rs. DO NOT EDIT.
2impl super::Client {
3    /// Constructs a fluent builder for the [`CreateDeployment`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder) operation.
4    ///
5    /// - The fluent builder is configurable:
6    ///   - [`rest_api_id(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::rest_api_id) / [`set_rest_api_id(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_rest_api_id):<br>required: **true**<br><p>The string identifier of the associated RestApi.</p><br>
7    ///   - [`stage_name(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::stage_name) / [`set_stage_name(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_stage_name):<br>required: **false**<br><p>The name of the Stage resource for the Deployment resource to create.</p><br>
8    ///   - [`stage_description(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::stage_description) / [`set_stage_description(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_stage_description):<br>required: **false**<br><p>The description of the Stage resource for the Deployment resource to create.</p><br>
9    ///   - [`description(impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::description) / [`set_description(Option<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_description):<br>required: **false**<br><p>The description for the Deployment resource to create.</p><br>
10    ///   - [`cache_cluster_enabled(bool)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::cache_cluster_enabled) / [`set_cache_cluster_enabled(Option<bool>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_cache_cluster_enabled):<br>required: **false**<br><p>Enables a cache cluster for the Stage resource specified in the input.</p><br>
11    ///   - [`cache_cluster_size(CacheClusterSize)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::cache_cluster_size) / [`set_cache_cluster_size(Option<CacheClusterSize>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_cache_cluster_size):<br>required: **false**<br><p>The stage's cache capacity in GB. For more information about choosing a cache size, see <a href="https://docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html">Enabling API caching to enhance responsiveness</a>.</p><br>
12    ///   - [`variables(impl Into<String>, impl Into<String>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::variables) / [`set_variables(Option<HashMap::<String, String>>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_variables):<br>required: **false**<br><p>A map that defines the stage variables for the Stage resource that is associated with the new deployment. Variable names can have alphanumeric and underscore characters, and the values must match <code>\[A-Za-z0-9-._~:/?#&amp;=,\]+</code>.</p><br>
13    ///   - [`canary_settings(DeploymentCanarySettings)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::canary_settings) / [`set_canary_settings(Option<DeploymentCanarySettings>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_canary_settings):<br>required: **false**<br><p>The input configuration for the canary deployment when the deployment is a canary release deployment.</p><br>
14    ///   - [`tracing_enabled(bool)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::tracing_enabled) / [`set_tracing_enabled(Option<bool>)`](crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::set_tracing_enabled):<br>required: **false**<br><p>Specifies whether active tracing with X-ray is enabled for the Stage.</p><br>
15    /// - On success, responds with [`CreateDeploymentOutput`](crate::operation::create_deployment::CreateDeploymentOutput) with field(s):
16    ///   - [`id(Option<String>)`](crate::operation::create_deployment::CreateDeploymentOutput::id): <p>The identifier for the deployment resource.</p>
17    ///   - [`description(Option<String>)`](crate::operation::create_deployment::CreateDeploymentOutput::description): <p>The description for the deployment resource.</p>
18    ///   - [`created_date(Option<DateTime>)`](crate::operation::create_deployment::CreateDeploymentOutput::created_date): <p>The date and time that the deployment resource was created.</p>
19    ///   - [`api_summary(Option<HashMap::<String, HashMap::<String, MethodSnapshot>>>)`](crate::operation::create_deployment::CreateDeploymentOutput::api_summary): <p>A summary of the RestApi at the date and time that the deployment resource was created.</p>
20    /// - On failure, responds with [`SdkError<CreateDeploymentError>`](crate::operation::create_deployment::CreateDeploymentError)
21    pub fn create_deployment(&self) -> crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder {
22        crate::operation::create_deployment::builders::CreateDeploymentFluentBuilder::new(self.handle.clone())
23    }
24}
aws_sdk_apigateway/client/create_deployment.rs

aws_sdk_apigateway/client/
create_deployment.rs
