class Aws::APIGateway::Types::CreateDeploymentRequest

Requests API Gateway to create a Deployment resource.

@note When making an API call, you may pass CreateDeploymentRequest

data as a hash:

    {
      rest_api_id: "String", # required
      stage_name: "String",
      stage_description: "String",
      description: "String",
      cache_cluster_enabled: false,
      cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
      variables: {
        "String" => "String",
      },
      canary_settings: {
        percent_traffic: 1.0,
        stage_variable_overrides: {
          "String" => "String",
        },
        use_stage_cache: false,
      },
      tracing_enabled: false,
    }

@!attribute [rw] rest_api_id

\[Required\] The string identifier of the associated RestApi.
@return [String]

@!attribute [rw] stage_name

The name of the Stage resource for the Deployment resource to
create.
@return [String]

@!attribute [rw] stage_description

The description of the Stage resource for the Deployment resource to
create.
@return [String]

@!attribute [rw] description

The description for the Deployment resource to create.
@return [String]

@!attribute [rw] cache_cluster_enabled

Enables a cache cluster for the Stage resource specified in the
input.
@return [Boolean]

@!attribute [rw] cache_cluster_size

Specifies the cache cluster size for the Stage resource specified in
the input, if a cache cluster is enabled.
@return [String]

@!attribute [rw] variables

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-._~:/?#&=,]+`.
@return [Hash<String,String>]

@!attribute [rw] canary_settings

The input configuration for the canary deployment when the
deployment is a canary release deployment.
@return [Types::DeploymentCanarySettings]

@!attribute [rw] tracing_enabled

Specifies whether active tracing with X-ray is enabled for the
Stage.
@return [Boolean]

Constants

SENSITIVE