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

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

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

Overview

Note:

When making an API call, you may pass CreateStageRequest data as a 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.



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#api_idString

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :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.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#default_route_settingsTypes::RouteSettings

Represents a collection of route settings.



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#deployment_idString

The identifier.

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#descriptionString

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

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :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>

The route settings map.

Returns:



2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#stage_nameString

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

Returns:

  • (String)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#stage_variablesHash<String,String>

The stage variable map.

Returns:

  • (Hash<String,String>)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end

#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>)


2132
2133
2134
2135
2136
2137
2138
2139
2140
2141
2142
2143
2144
# File 'gems/aws-sdk-apigatewayv2/lib/aws-sdk-apigatewayv2/types.rb', line 2132

class CreateStageRequest < Struct.new(
  :access_log_settings,
  :api_id,
  :client_certificate_id,
  :default_route_settings,
  :deployment_id,
  :description,
  :route_settings,
  :stage_name,
  :stage_variables,
  :tags)
  include Aws::Structure
end