You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CreateDeploymentRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateDeploymentRequest
- Defined in:
- (unknown)
Overview
When passing CreateDeploymentRequest as input to an Aws::Client method, you can use a vanilla 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,
}
Requests API Gateway to create a Deployment resource.
Instance Attribute Summary collapse
-
#cache_cluster_enabled ⇒ Boolean
Enables a cache cluster for the Stage resource specified in the input.
-
#cache_cluster_size ⇒ String
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
-
#canary_settings ⇒ Types::DeploymentCanarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.
-
#description ⇒ String
The description for the Deployment resource to create.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#stage_description ⇒ String
The description of the Stage resource for the Deployment resource to create.
-
#stage_name ⇒ String
The name of the Stage resource for the Deployment resource to create.
-
#tracing_enabled ⇒ Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
-
#variables ⇒ Hash<String,String>
A map that defines the stage variables for the Stage resource that is associated with the new deployment.
Instance Attribute Details
#cache_cluster_enabled ⇒ Boolean
Enables a cache cluster for the Stage resource specified in the input.
#cache_cluster_size ⇒ String
Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.
Possible values:
- 0.5
- 1.6
- 6.1
- 13.5
- 28.4
- 58.2
- 118
- 237
#canary_settings ⇒ Types::DeploymentCanarySettings
The input configuration for the canary deployment when the deployment is a canary release deployment.
#description ⇒ String
The description for the Deployment resource to create.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#stage_description ⇒ String
The description of the Stage resource for the Deployment resource to create.
#stage_name ⇒ String
The name of the Stage resource for the Deployment resource to create.
#tracing_enabled ⇒ Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
#variables ⇒ Hash<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-._~:/?#&=,]+
.