class Amazonite::ApiGateway::Stage

Overview

Represents a unique identifier for a version of a deployed RestApi that is callable by users.

Included Modules

Defined in:

api_gateway/stage.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(deployment_id : String | Nil = nil, client_certificate_id : String | Nil = nil, stage_name : String | Nil = nil, description : String | Nil = nil, cache_cluster_enabled : Bool | Nil = nil, cache_cluster_size : CacheClusterSize | Nil = nil, cache_cluster_status : CacheClusterStatus | Nil = nil, method_settings : Hash(String, MethodSetting) | Nil = nil, variables : Hash(String, String) | Nil = nil, documentation_version : String | Nil = nil, access_log_settings : AccessLogSettings | Nil = nil, canary_settings : CanarySettings | Nil = nil, tracing_enabled : Bool | Nil = nil, web_acl_arn : String | Nil = nil, tags : Hash(String, String) | Nil = nil, created_date : Time | Nil = nil, last_updated_date : Time | Nil = nil) #

[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 access_log_settings : AccessLogSettings | Nil #

Settings for logging access in this stage.


[View source]
def access_log_settings=(access_log_settings : AccessLogSettings | Nil) #

Settings for logging access in this stage.


[View source]
def cache_cluster_enabled : Bool | Nil #

Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.


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

Specifies whether a cache cluster is enabled for the stage. To activate a method-level cache, set CachingEnabled to true for a method.


[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 cache_cluster_status : CacheClusterStatus | Nil #

The status of the cache cluster for the stage, if enabled.


[View source]
def cache_cluster_status=(cache_cluster_status : CacheClusterStatus | Nil) #

The status of the cache cluster for the stage, if enabled.


[View source]
def canary_settings : CanarySettings | Nil #

Settings for the canary deployment in this stage.


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

Settings for the canary deployment in this stage.


[View source]
def client_certificate_id : String | Nil #

The identifier of a client certificate for an API stage.


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

The identifier of a client certificate for an API stage.


[View source]
def created_date : Time | Nil #

The timestamp when the stage was created.


[View source]
def created_date=(created_date : Time | Nil) #

The timestamp when the stage was created.


[View source]
def deployment_id : String | Nil #

The identifier of the Deployment that the stage points to.


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

The identifier of the Deployment that the stage points to.


[View source]
def description : String | Nil #

The stage's description.


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

The stage's description.


[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 last_updated_date : Time | Nil #

The timestamp when the stage last updated.


[View source]
def last_updated_date=(last_updated_date : Time | Nil) #

The timestamp when the stage last updated.


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

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.


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

A map that defines the method settings for a Stage resource. Keys (designated as /{method_setting_key below) are method paths defined as {resource_path}/{http_method} for an individual method override, or /\*/\* for overriding all methods in the stage.


[View source]
def stage_name : String | Nil #

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.


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

The name of the stage is the first path segment in the Uniform Resource Identifier (URI) of a call to API Gateway. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.


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

The collection of tags. Each tag element is associated with a given resource.


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

The collection of tags. Each tag element is associated with a given resource.


[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 a 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 a Stage resource. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.


[View source]
def web_acl_arn : String | Nil #

The ARN of the WebAcl associated with the Stage.


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

The ARN of the WebAcl associated with the Stage.


[View source]