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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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_enabledBoolean

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

Returns:

  • (Boolean)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_sizeString

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)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_settingsTypes::DeploymentCanarySettings

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



712
713
714
715
716
717
718
719
720
721
722
723
724
# 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

#descriptionString

The description for the Deployment resource to create.

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_descriptionString

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

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_nameString

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

Returns:

  • (String)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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_enabledBoolean

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

Returns:

  • (Boolean)


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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

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


712
713
714
715
716
717
718
719
720
721
722
723
724
# 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