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

Class: Aws::ApiGatewayV2::Types::CreateStageRequest

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

Overview

Note:

When passing CreateStageRequest as input to an Aws::Client method, you can use a vanilla Hash:

{
  access_log_settings: {
    destination_arn: "Arn",
    format: "StringWithLengthBetween1And1024",
  },
  api_id: "__string", # required
  client_certificate_id: "Id",
  default_route_settings: {
    data_trace_enabled: false,
    detailed_metrics_enabled: false,
    logging_level: "ERROR", # accepts ERROR, INFO, false
    throttling_burst_limit: 1,
    throttling_rate_limit: 1.0,
  },
  deployment_id: "Id",
  description: "StringWithLengthBetween0And1024",
  route_settings: {
    "__string" => {
      data_trace_enabled: false,
      detailed_metrics_enabled: false,
      logging_level: "ERROR", # accepts ERROR, INFO, false
      throttling_burst_limit: 1,
      throttling_rate_limit: 1.0,
    },
  },
  stage_name: "StringWithLengthBetween1And128", # required
  stage_variables: {
    "__string" => "StringWithLengthBetween0And2048",
  },
  tags: {
    "__string" => "StringWithLengthBetween1And1600",
  },
}

Instance Attribute Summary collapse

Instance Attribute Details

#access_log_settingsTypes::AccessLogSettings

Settings for logging access in a stage.

Returns:

#api_idString

Returns:

  • (String)

#client_certificate_idString

The identifier.

Returns:

  • (String)

    The identifier.

    .

#default_route_settingsTypes::RouteSettings

Represents a collection of route settings.

Returns:

#deployment_idString

The identifier.

Returns:

  • (String)

    The identifier.

    .

#descriptionString

A string with a length between [0-1024].

Returns:

  • (String)

    A string with a length between [0-1024].

    .

#route_settingsHash<String,Types::RouteSettings>

The route settings map.

Returns:

#stage_nameString

A string with a length between [1-128].

Returns:

  • (String)

    A string with a length between [1-128].

    .

#stage_variablesHash<String,String>

The stage variable map.

Returns:

  • (Hash<String,String>)

    The stage variable map.

    .

#tagsHash<String,String>

A key value pair of string with key length between[1-128] and value length between[1-256]

Returns:

  • (Hash<String,String>)

    A key value pair of string with key length between[1-128] and value length between[1-256]

    .