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

Class: Aws::OpsWorks::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:

{
  stack_id: "String", # required
  app_id: "String",
  instance_ids: ["String"],
  layer_ids: ["String"],
  command: { # required
    name: "install_dependencies", # required, accepts install_dependencies, update_dependencies, update_custom_cookbooks, execute_recipes, configure, setup, deploy, rollback, start, stop, restart, undeploy
    args: {
      "String" => ["String"],
    },
  },
  comment: "String",
  custom_json: "String",
}

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#app_id ⇒ String

The app ID. This parameter is required for app deployments, but not for other deployment commands.

Returns:

  • (String) —

    The app ID.

#command ⇒ Types::DeploymentCommand

A DeploymentCommand object that specifies the deployment command and any associated arguments.

Returns:

  • (Types::DeploymentCommand) —

    A DeploymentCommand object that specifies the deployment command and any associated arguments.

#comment ⇒ String

A user-defined comment.

Returns:

  • (String) —

    A user-defined comment.

#custom_json ⇒ String

A string that contains user-defined, custom JSON. You can use this parameter to override some corresponding default stack configuration JSON values. The string should be in the following format:

"{\"key1\": \"value1\", \"key2\": \"value2\",...}"

For more information about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes and Overriding Attributes With Custom JSON.

Returns:

  • (String) —

    A string that contains user-defined, custom JSON.

#instance_ids ⇒ Array<String>

The instance IDs for the deployment targets.

Returns:

  • (Array<String>) —

    The instance IDs for the deployment targets.

#layer_ids ⇒ Array<String>

The layer IDs for the deployment targets.

Returns:

  • (Array<String>) —

    The layer IDs for the deployment targets.

#stack_id ⇒ String

The stack ID.

Returns:

  • (String) —

    The stack ID.