class Amazonite::ApiGateway::CreateStageRequest

Overview

Requests API Gateway to create a Stage resource.

Included Modules

Defined in:

api_gateway/create_stage_request.cr

Constructors

Instance Method Summary

Constructor Detail

def self.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) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]
def self.new(*, __pull_for_json_serializable pull : JSON::PullParser) #

[View source]

Instance Method Detail

def ==(other : self) #
Description copied from class Reference

Returns true if this reference is the same as other. Invokes same?.


def cache_cluster_enabled : Bool | Nil #

Whether cache clustering is enabled for the stage.


[View source]
def cache_cluster_enabled=(cache_cluster_enabled : Bool | Nil) #

Whether cache clustering is enabled for the stage.


[View source]
def cache_cluster_size : CacheClusterSize | Nil #

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.


[View source]
def cache_cluster_size=(cache_cluster_size : CacheClusterSize | Nil) #

The stage's cache capacity in GB. For more information about choosing a cache size, see Enabling API caching to enhance responsiveness.


[View source]
def canary_settings : CanarySettings | Nil #

The canary deployment settings of this stage.


[View source]
def canary_settings=(canary_settings : CanarySettings | Nil) #

The canary deployment settings of this stage.


[View source]
def deployment_id : String #

The identifier of the Deployment resource for the Stage resource.


[View source]
def deployment_id=(deployment_id : String) #

The identifier of the Deployment resource for the Stage resource.


[View source]
def description : String | Nil #

The description of the Stage resource.


[View source]
def description=(description : String | Nil) #

The description of the Stage resource.


[View source]
def documentation_version : String | Nil #

The version of the associated API documentation.


[View source]
def documentation_version=(documentation_version : String | Nil) #

The version of the associated API documentation.


[View source]
def hash(hasher) #
Description copied from class Reference

See Object#hash(hasher)


def rest_api_id : String #

The string identifier of the associated RestApi.


[View source]
def rest_api_id=(rest_api_id : String) #

The string identifier of the associated RestApi.


[View source]
def stage_name : String #

The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.


[View source]
def stage_name=(stage_name : String) #

The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.


[View source]
def tags : Hash(String, String) | Nil #

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.


[View source]
def tags=(tags : Hash(String, String) | Nil) #

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.


[View source]
def tracing_enabled : Bool | Nil #

Specifies whether active tracing with X-ray is enabled for the Stage.


[View source]
def tracing_enabled=(tracing_enabled : Bool | Nil) #

Specifies whether active tracing with X-ray is enabled for the Stage.


[View source]
def validate! : Nil #

[View source]
def variables : Hash(String, String) | Nil #

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-._~:/?#&=,]+.


[View source]
def variables=(variables : Hash(String, String) | Nil) #

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-._~:/?#&=,]+.


[View source]