Class: Aws::APIGateway::Types::CreateStageRequest
- Inherits:
-
Struct
- Object
- Struct
- Aws::APIGateway::Types::CreateStageRequest
- Defined in:
- gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb
Overview
When making an API call, you may pass CreateStageRequest data as a 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.
Constant Summary collapse
- SENSITIVE =
[]
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
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
The string identifier of the associated RestApi.
-
#stage_name ⇒ String
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.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#cache_cluster_size ⇒ String
The stage's cache cluster size.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#canary_settings ⇒ Types::CanarySettings
The canary deployment settings of this stage.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#deployment_id ⇒ String
The identifier of the Deployment resource for the Stage resource.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#description ⇒ String
The description of the Stage resource.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#documentation_version ⇒ String
The version of the associated API documentation.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#rest_api_id ⇒ String
The string identifier of the associated RestApi.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#stage_name ⇒ String
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#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.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#tracing_enabled ⇒ Boolean
Specifies whether active tracing with X-ray is enabled for the Stage.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |
#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-._~:/?#&=,]+
.
1318 1319 1320 1321 1322 1323 1324 1325 1326 1327 1328 1329 1330 1331 1332 |
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1318 class CreateStageRequest < Struct.new( :rest_api_id, :stage_name, :deployment_id, :description, :cache_cluster_enabled, :cache_cluster_size, :variables, :documentation_version, :canary_settings, :tracing_enabled, :tags) SENSITIVE = [] include Aws::Structure end |