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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

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.

Returns:

#auto_deployBoolean

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

Returns:

  • (Boolean)

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

#client_certificate_idString

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

Returns:

  • (String)

    The identifier of a client certificate for a Stage.

#default_route_settingsTypes::RouteSettings

The default route settings for the stage.

Returns:

#deployment_idString

The deployment identifier of the API stage.

Returns:

  • (String)

    The deployment identifier of the API stage.

#descriptionString

The description for the API stage.

Returns:

  • (String)

    The description for the API stage.

#route_settingsHash<String,Types::RouteSettings>

Route settings for the stage, by routeKey.

Returns:

#stage_nameString

The name of the stage.

Returns:

  • (String)

    The name of the stage.

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

Returns:

  • (Hash<String,String>)

    A map that defines the stage variables for a Stage.

#tagsHash<String,String>

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

Returns:

  • (Hash<String,String>)

    The collection of tags.