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

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing CreateDeploymentRequest as input to an Aws::Client method, you can use a vanilla 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,
  },
}

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

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

#cache_cluster_sizeString

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

Possible values:

  • 0.5
  • 1.6
  • 6.1
  • 13.5
  • 28.4
  • 58.2
  • 118
  • 237

Returns:

  • (String)

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

#canary_settingsTypes::DeploymentCanarySettings

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

Returns:

#descriptionString

The description for the Deployment resource to create.

Returns:

  • (String)

    The description for the Deployment resource to create.

#rest_api_idString

The string identifier of the associated RestApi.

Returns:

  • (String)

    The string identifier of the associated RestApi.

#stage_descriptionString

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

Returns:

  • (String)

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

#stage_nameString

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

Returns:

  • (String)

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

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

    A map that defines the stage variables for the Stage resource that is associated with the new deployment.