Class: Aws::ApiGatewayV2::Types::Stage

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents an API stage.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in this stage.



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#api_gateway_managedBoolean

Specifies whether a stage is managed by API Gateway. If you created an API using quick create, the $default stage is managed by API Gateway. You can't modify the $default stage.

Returns:

  • (Boolean)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#auto_deployBoolean

Specifies whether updates to an API automatically trigger a new deployment. The default value is false.

Returns:

  • (Boolean)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#client_certificate_idString

The identifier of a client certificate for a Stage. Supported only for WebSocket APIs.

Returns:

  • (String)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#created_dateTime

The timestamp when the stage was created.

Returns:

  • (Time)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#default_route_settingsTypes::RouteSettings

Default route settings for the stage.



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_idString

The identifier of the Deployment that the Stage is associated with. Can't be updated if autoDeploy is enabled.

Returns:

  • (String)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

The description of the stage.

Returns:

  • (String)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_deployment_status_messageString

Describes the status of the last deployment of a stage. Supported only for stages with autoDeploy enabled.

Returns:

  • (String)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#last_updated_dateTime

The timestamp when the stage was last updated.

Returns:

  • (Time)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:



5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_nameString

The name of the stage.

Returns:

  • (String)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#stage_variablesHash<String,String>

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

Returns:

  • (Hash<String,String>)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


5757
5758
5759
5760
5761
5762
5763
5764
5765
5766
5767
5768
5769
5770
5771
5772
5773
5774
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 5757

class Stage < Struct.new(
  :access_log_settings,
  :api_gateway_managed,
  :auto_deploy,
  :client_certificate_id,
  :created_date,
  :default_route_settings,
  :deployment_id,
  :description,
  :last_deployment_status_message,
  :last_updated_date,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  SENSITIVE = []
  include Aws::Structure
end