class
Amazonite::ApiGateway::CreateStageRequest
- Amazonite::ApiGateway::CreateStageRequest
- Reference
- Object
Overview
Requests API Gateway to create a Stage resource.
Included Modules
- JSON::Serializable
Defined in:
api_gateway/create_stage_request.crConstructors
- .new(rest_api_id : String, stage_name : String, deployment_id : String, description : String | Nil = nil, cache_cluster_enabled : Bool | Nil = nil, cache_cluster_size : CacheClusterSize | Nil = nil, variables : Hash(String, String) | Nil = nil, documentation_version : String | Nil = nil, canary_settings : CanarySettings | Nil = nil, tracing_enabled : Bool | Nil = nil, tags : Hash(String, String) | Nil = nil)
- .new(pull : JSON::PullParser)
- .new(*, __pull_for_json_serializable pull : JSON::PullParser)
Instance Method Summary
-
#==(other : self)
Returns
trueif this reference is the same as other. -
#cache_cluster_enabled : Bool | Nil
Whether cache clustering is enabled for the stage.
-
#cache_cluster_enabled=(cache_cluster_enabled : Bool | Nil)
Whether cache clustering is enabled for the stage.
-
#cache_cluster_size : CacheClusterSize | Nil
The stage's cache capacity in GB.
-
#cache_cluster_size=(cache_cluster_size : CacheClusterSize | Nil)
The stage's cache capacity in GB.
-
#canary_settings : CanarySettings | Nil
The canary deployment settings of this stage.
-
#canary_settings=(canary_settings : CanarySettings | Nil)
The canary deployment settings of this stage.
-
#deployment_id : String
The identifier of the Deployment resource for the Stage resource.
-
#deployment_id=(deployment_id : String)
The identifier of the Deployment resource for the Stage resource.
-
#description : String | Nil
The description of the Stage resource.
-
#description=(description : String | Nil)
The description of the Stage resource.
-
#documentation_version : String | Nil
The version of the associated API documentation.
-
#documentation_version=(documentation_version : String | Nil)
The version of the associated API documentation.
-
#hash(hasher)
See
Object#hash(hasher) -
#rest_api_id : String
The string identifier of the associated RestApi.
-
#rest_api_id=(rest_api_id : String)
The string identifier of the associated RestApi.
-
#stage_name : String
The name for the Stage resource.
-
#stage_name=(stage_name : String)
The name for the Stage resource.
-
#tags : Hash(String, String) | Nil
The key-value map of strings.
-
#tags=(tags : Hash(String, String) | Nil)
The key-value map of strings.
-
#tracing_enabled : Bool | Nil
Specifies whether active tracing with X-ray is enabled for the Stage.
-
#tracing_enabled=(tracing_enabled : Bool | Nil)
Specifies whether active tracing with X-ray is enabled for the Stage.
- #validate! : Nil
-
#variables : Hash(String, String) | Nil
A map that defines the stage variables for the new Stage resource.
-
#variables=(variables : Hash(String, String) | Nil)
A map that defines the stage variables for the new Stage resource.
Constructor Detail
Instance Method Detail
Returns true if this reference is the same as other. Invokes same?.
Whether cache clustering is enabled for the stage.
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.
The canary deployment settings of this stage.
The identifier of the Deployment resource for the Stage resource.
The version of the associated API documentation.
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.
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.
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.
Specifies whether active tracing with X-ray is enabled for the Stage.
Specifies whether active tracing with X-ray is enabled for the Stage.
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-._~:/?#&=,]+.
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-._~:/?#&=,]+.