You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::APIGateway::Types::CreateStageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateStageRequest
- Defined in:
- (unknown)
Overview
When passing CreateStageRequest as input to an Aws::Client method, you can use a vanilla Hash:
{
rest_api_id: "String", # required
stage_name: "String", # required
deployment_id: "String", # required
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",
},
documentation_version: "String",
canary_settings: {
percent_traffic: 1.0,
deployment_id: "String",
stage_variable_overrides: {
"String" => "String",
},
use_stage_cache: false,
},
tracing_enabled: false,
tags: {
"String" => "String",
},
}
Requests API Gateway to create a Stage resource.
Instance Attribute Summary collapse
-
#cache_cluster_enabled ⇒ Boolean
Whether cache clustering is enabled for the stage.
-
#cache_cluster_size ⇒ String
The stage\'s cache cluster size.
-
#canary_settings ⇒ Types::CanarySettings
The canary deployment settings of this stage.
-
#deployment_id ⇒ String
[Required] The identifier of the Deployment resource for the Stage resource.
-
#description ⇒ String
The description of the Stage resource.
-
#documentation_version ⇒ String
The version of the associated API documentation.
-
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
-
#stage_name ⇒ String
[Required] The name for the Stage resource.
-
#tags ⇒ Hash<String,String>
The key-value map of strings.
-
#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 new Stage resource.
Instance Attribute Details
#cache_cluster_enabled ⇒ Boolean
Whether cache clustering is enabled for the stage.
#cache_cluster_size ⇒ String
The stage\'s cache cluster size.
Possible values:
- 0.5
- 1.6
- 6.1
- 13.5
- 28.4
- 58.2
- 118
- 237
#canary_settings ⇒ Types::CanarySettings
The canary deployment settings of this stage.
#deployment_id ⇒ String
[Required] The identifier of the Deployment resource for the Stage resource.
#description ⇒ String
The description of the Stage resource.
#documentation_version ⇒ String
The version of the associated API documentation.
#rest_api_id ⇒ String
[Required] The string identifier of the associated RestApi.
#stage_name ⇒ String
[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
#tags ⇒ Hash<String,String>
The key-value map of strings. The valid character set is
[a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not
start with aws:
. The tag value can be up to 256 characters.
#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 new Stage
resource. Variable names can have alphanumeric and underscore
characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+
.