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

Class: Aws::APIGateway::Types::CreateStageRequest

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

Overview

Note:

When making an API call, you may pass CreateStageRequest data as a hash:

{
  rest_api_id: "String", # required
  stage_name: "String", # required
  deployment_id: "String", # required
  description: "String",
  cache_cluster_enabled: false,
  cache_cluster_size: "0.5", # accepts 0.5, 1.6, 6.1, 13.5, 28.4, 58.2, 118, 237
  variables: {
    "String" => "String",
  },
  documentation_version: "String",
}

Requests Amazon API Gateway to create a Stage resource.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_enabledBoolean

Whether cache clustering is enabled for the stage.

Returns:

  • (Boolean)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#cache_cluster_sizeString

The stage's cache cluster size.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#deployment_idString

The identifier of the Deployment resource for the Stage resource.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#descriptionString

The description of the Stage resource.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#documentation_versionString

The version of the associated API documentation.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#stage_nameString

The name for the Stage resource.

Returns:

  • (String)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end

#variablesHash<String,String>

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

Returns:

  • (Hash<String,String>)


1119
1120
1121
1122
1123
1124
1125
1126
1127
1128
1129
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1119

class CreateStageRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :deployment_id,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :documentation_version)
  include Aws::Structure
end