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
• Struct
• Aws::APIGateway::Types::CreateStageRequest

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

Requests API Gateway to create a Stage resource.

Instance Attribute Summary

• #cache_cluster_enabled ⇒ Boolean

  Whether cache clustering is enabled for the stage.

• #cache_cluster_size ⇒ String

  The stage's cache cluster size.

• #canary_settings ⇒ Types::CanarySettings

  The canary deployment settings of this stage.

• #deployment_id ⇒ String

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

• #description ⇒ String

  The description of the Stage resource.

• #documentation_version ⇒ String

  The version of the associated API documentation.

• #rest_api_id ⇒ String

  [Required] The string identifier of the associated RestApi.

• #stage_name ⇒ String

  [Required] The name for the Stage resource.

• #tags ⇒ Hash<String,String>

  The key-value map of strings.

• #tracing_enabled ⇒ Boolean

  Specifies whether active tracing with X-ray is enabled for the Stage.

• #variables ⇒ Hash<String,String>

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

Instance Attribute Details

#cache_cluster_enabled ⇒ Boolean

Whether cache clustering is enabled for the stage.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#cache_cluster_size ⇒ String

The stage's cache cluster size.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#canary_settings ⇒ Types::CanarySettings

The canary deployment settings of this stage.

Returns:

• (Types::CanarySettings)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#deployment_id ⇒ String

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

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#description ⇒ String

The description of the Stage resource.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#documentation_version ⇒ String

The version of the associated API documentation.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#rest_api_id ⇒ String

[Required] The string identifier of the associated RestApi.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#stage_name ⇒ String

[Required] The name for the Stage resource. Stage names can only contain alphanumeric characters, hyphens, and underscores. Maximum length is 128 characters.

Returns:

• (String)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#tags ⇒ Hash<String,String>

The key-value map of strings. The valid character set is [a-zA-Z+-=._:/]. The tag key can be up to 128 characters and must not start with aws:. The tag value can be up to 256 characters.

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#tracing_enabled ⇒ Boolean

Specifies whether active tracing with X-ray is enabled for the Stage.

Returns:

• (Boolean)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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

#variables ⇒ Hash<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>)

# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 1387

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