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

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

Overview

Requests API Gateway to create a Deployment resource.

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_enabled ⇒ Boolean

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

Returns:

  • (Boolean) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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.

Returns:

  • (String) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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:



718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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) 


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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


718
719
720
721
722
723
724
725
726
727
728
729
730
 
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 718

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