You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Represents the input parameters for a CreateStage request.

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in this stage.



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#auto_deployBoolean

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

Returns:

  • (Boolean)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#client_certificate_idString

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

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#default_route_settingsTypes::RouteSettings

The default route settings for the stage.



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#deployment_idString

The deployment identifier of the API stage.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#descriptionString

The description for the API stage.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:



2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#stage_nameString

The name of the stage.

Returns:

  • (String)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#stage_variablesHash<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-._~:/?#&=,]+. Supported only for WebSocket APIs.

Returns:

  • (Hash<String,String>)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)


2339
2340
2341
2342
2343
2344
2345
2346
2347
2348
2349
2350
2351
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2339

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)
  include Aws::Structure
end