Class: Aws::ApiGatewayV2::Types::CreateStageInput

Inherits:

Struct

• Object
• Struct
• Aws::ApiGatewayV2::Types::CreateStageInput

Defined in:

gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb

Overview

Represents the input parameters for a CreateStage request.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #access_log_settings ⇒ Types::AccessLogSettings

  Settings for logging access in this stage.

• #auto_deploy ⇒ Boolean

  Specifies whether updates to an API automatically trigger a new deployment.

• #client_certificate_id ⇒ String

  The identifier of a client certificate for a Stage.

• #default_route_settings ⇒ Types::RouteSettings

  The default route settings for the stage.

• #deployment_id ⇒ String

  The deployment identifier of the API stage.

• #description ⇒ String

  The description for the API stage.

• #route_settings ⇒ Hash<String,Types::RouteSettings>

  Route settings for the stage, by routeKey.

• #stage_name ⇒ String

  The name of the stage.

• #stage_variables ⇒ Hash<String,String>

  A map that defines the stage variables for a Stage.

• #tags ⇒ Hash<String,String>

  The collection of tags.

Instance Attribute Details

#access_log_settings ⇒ Types::AccessLogSettings

Settings for logging access in this stage.

Returns:

• (Types::AccessLogSettings)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#auto_deploy ⇒ Boolean

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

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#client_certificate_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#default_route_settings ⇒ Types::RouteSettings

The default route settings for the stage.

Returns:

• (Types::RouteSettings)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#deployment_id ⇒ String

The deployment identifier of the API stage.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#description ⇒ String

The description for the API stage.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#route_settings ⇒ Hash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:

• (Hash<String,Types::RouteSettings>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#stage_name ⇒ String

The name of the stage.

Returns:

• (String)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#stage_variables ⇒ Hash<String,String>

A map that defines the stage variables for a Stage. Variable names can have alphanumeric and underscore characters, and the values must match [A-Za-z0-9-._~:/?#&=,]+.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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

#tags ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2491

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