class Aws::APIGateway::Types::CreateStageRequest
Requests API Gateway to create a Stage
resource.
@note 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", }, }
@!attribute [rw] rest_api_id
\[Required\] The string identifier of the associated RestApi. @return [String]
@!attribute [rw] stage_name
\[Required\] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters. @return [String]
@!attribute [rw] deployment_id
\[Required\] The identifier of the Deployment resource for the Stage resource. @return [String]
@!attribute [rw] description
The description of the Stage resource. @return [String]
@!attribute [rw] cache_cluster_enabled
Whether cache clustering is enabled for the stage. @return [Boolean]
@!attribute [rw] cache_cluster_size
The stage's cache cluster size. @return [String]
@!attribute [rw] variables
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-._~:/?#&=,]+`. @return [Hash<String,String>]
@!attribute [rw] documentation_version
The version of the associated API documentation. @return [String]
@!attribute [rw] canary_settings
The canary deployment settings of this stage. @return [Types::CanarySettings]
@!attribute [rw] tracing_enabled
Specifies whether active tracing with X-ray is enabled for the Stage. @return [Boolean]
@!attribute [rw] tags
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. @return [Hash<String,String>]
Constants
- SENSITIVE