Class: Aws::APIGateway::Types::CreateDeploymentRequest

Inherits:

Struct

• Object
• Struct
• Aws::APIGateway::Types::CreateDeploymentRequest

Includes:

Structure

Defined in:

lib/aws-sdk-apigateway/types.rb

Overview

Requests API Gateway to create a Deployment resource.

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #cache_cluster_enabled ⇒ Boolean

  Enables a cache cluster for the Stage resource specified in the input.

• #cache_cluster_size ⇒ String

  The stage’s cache capacity in GB.

• #canary_settings ⇒ Types::DeploymentCanarySettings

  The input configuration for the canary deployment when the deployment is a canary release deployment.

• #description ⇒ String

  The description for the Deployment resource to create.

• #rest_api_id ⇒ String

  The string identifier of the associated RestApi.

• #stage_description ⇒ String

  The description of the Stage resource for the Deployment resource to create.

• #stage_name ⇒ String

  The name of the Stage resource for the Deployment resource to create.

• #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 Stage resource that is associated with the new deployment.

Instance Attribute Details

#cache_cluster_enabled ⇒ Boolean

Enables a cache cluster for the Stage resource specified in the input.

Returns:

• (Boolean)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#cache_cluster_size ⇒ String

The stage’s cache capacity in GB. For more information about choosing a cache size, see [Enabling API caching to enhance responsiveness].

[1]: docs.aws.amazon.com/apigateway/latest/developerguide/api-gateway-caching.html

Returns:

• (String)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#canary_settings ⇒ Types::DeploymentCanarySettings

The input configuration for the canary deployment when the deployment is a canary release deployment.

Returns:

• (Types::DeploymentCanarySettings)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

The description for the Deployment resource to create.

Returns:

• (String)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#rest_api_id ⇒ String

The string identifier of the associated RestApi.

Returns:

• (String)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#stage_description ⇒ String

The description of the Stage resource for the Deployment resource to create.

Returns:

• (String)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#stage_name ⇒ String

The name of the Stage resource for the Deployment resource to create.

Returns:

• (String)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#tracing_enabled ⇒ Boolean

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

Returns:

• (Boolean)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end

#variables ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

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

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables,
  :canary_settings,
  :tracing_enabled)
  SENSITIVE = []
  include Aws::Structure
end