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

Class: Aws::APIGateway::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:

{
  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",
  canary_settings: {
    percent_traffic: 1.0,
    deployment_id: "String",
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
}

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

    Whether cache clustering is enabled for the stage.

#cache_cluster_sizeString

The stage\'s cache cluster size.

Possible values:

  • 0.5
  • 1.6
  • 6.1
  • 13.5
  • 28.4
  • 58.2
  • 118
  • 237

Returns:

  • (String)

    The stage\'s cache cluster size.

#canary_settingsTypes::CanarySettings

The canary deployment settings of this stage.

Returns:

#deployment_idString

[Required] The identifier of the Deployment resource for the Stage resource.

Returns:

  • (String)

    [Required] The identifier of the Deployment resource for the Stage resource.

#descriptionString

The description of the Stage resource.

Returns:

  • (String)

    The description of the Stage resource.

#documentation_versionString

The version of the associated API documentation.

Returns:

  • (String)

    The version of the associated API documentation.

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.

#stage_nameString

[Required] The name for the Stage resource.

Returns:

  • (String)

    [Required] The name for the Stage resource.

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

    A map that defines the stage variables for the new Stage resource.