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

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

Overview

Note:

When making an API call, you may pass CreateDeploymentRequest data as a hash:

{
  rest_api_id: "String", # required
  stage_name: "String",
  stage_description: "String",
  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",
  },
  canary_settings: {
    percent_traffic: 1.0,
    stage_variable_overrides: {
      "String" => "String",
    },
    use_stage_cache: false,
  },
  tracing_enabled: false,
}

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) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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

Specifies the cache cluster size for the Stage resource specified in the input, if a cache cluster is enabled.

Returns:

  • (String) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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:



931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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

[Required] The string identifier of the associated RestApi.

Returns:

  • (String) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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) 


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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


931
932
933
934
935
936
937
938
939
940
941
942
943
 
# File 'lib/aws-sdk-apigateway/types.rb', line 931

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