You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-apigateway/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",
  },
}

Requests Amazon API Gateway to create a Deployment resource.

Instance Attribute Summary collapse

Instance Attribute Details

#cache_cluster_enabledBoolean

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

Returns:

  • (Boolean)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end

#cache_cluster_sizeString

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

Returns:

  • (String)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end

#descriptionString

The description for the Deployment resource to create.

Returns:

  • (String)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end

#stage_descriptionString

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

Returns:

  • (String)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end

#stage_nameString

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

Returns:

  • (String)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  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>)


765
766
767
768
769
770
771
772
773
774
# File 'gems/aws-sdk-apigateway/lib/aws-sdk-apigateway/types.rb', line 765

class CreateDeploymentRequest < Struct.new(
  :rest_api_id,
  :stage_name,
  :stage_description,
  :description,
  :cache_cluster_enabled,
  :cache_cluster_size,
  :variables)
  include Aws::Structure
end