Struct aws_sdk_apigateway::operation::create_deployment::CreateDeploymentInput

#[non_exhaustive]
pub struct CreateDeploymentInput {
    pub rest_api_id: Option<String>,
    pub stage_name: Option<String>,
    pub stage_description: Option<String>,
    pub description: Option<String>,
    pub cache_cluster_enabled: Option<bool>,
    pub cache_cluster_size: Option<CacheClusterSize>,
    pub variables: Option<HashMap<String, String>>,
    pub canary_settings: Option<DeploymentCanarySettings>,
    pub tracing_enabled: Option<bool>,
}

Requests API Gateway to create a Deployment resource.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

rest_api_id: Option<String>

The string identifier of the associated RestApi.

stage_name: Option<String>

The name of the Stage resource for the Deployment resource to create.

stage_description: Option<String>

The description of the Stage resource for the Deployment resource to create.

description: Option<String>

The description for the Deployment resource to create.

cache_cluster_enabled: Option<bool>

Enables a cache cluster for the Stage resource specified in the input.

cache_cluster_size: Option<CacheClusterSize>

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

variables: Option<HashMap<String, String>>

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 \[A-Za-z0-9-._~:/?#&=,\]+.

canary_settings: Option<DeploymentCanarySettings>

The input configuration for the canary deployment when the deployment is a canary release deployment.

tracing_enabled: Option<bool>

Specifies whether active tracing with X-ray is enabled for the Stage.

Implementations

impl CreateDeploymentInput

pub fn rest_api_id(&self) -> Option<&str>

The string identifier of the associated RestApi.

pub fn stage_name(&self) -> Option<&str>

The name of the Stage resource for the Deployment resource to create.

pub fn stage_description(&self) -> Option<&str>

The description of the Stage resource for the Deployment resource to create.

pub fn description(&self) -> Option<&str>

The description for the Deployment resource to create.

pub fn cache_cluster_enabled(&self) -> Option<bool>

Enables a cache cluster for the Stage resource specified in the input.

pub fn cache_cluster_size(&self) -> Option<&CacheClusterSize>

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.

pub fn variables(&self) -> Option<&HashMap<String, String>>

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 \[A-Za-z0-9-._~:/?#&=,\]+.

pub fn canary_settings(&self) -> Option<&DeploymentCanarySettings>

The input configuration for the canary deployment when the deployment is a canary release deployment.

pub fn tracing_enabled(&self) -> Option<bool>

Specifies whether active tracing with X-ray is enabled for the Stage.

impl CreateDeploymentInput

pub fn builder() -> CreateDeploymentInputBuilder

Creates a new builder-style object to manufacture CreateDeploymentInput.

Trait Implementations

impl Clone for CreateDeploymentInput

fn clone(&self) -> CreateDeploymentInput

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateDeploymentInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateDeploymentInput

fn eq(&self, other: &CreateDeploymentInput) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateDeploymentInput