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

Class: Aws::OpsWorks::Types::CreateDeploymentRequest

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Note:

When making an API call, you may pass CreateDeploymentRequest data as a 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",
}

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

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

Returns:

  • (String)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#commandTypes::DeploymentCommand

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



1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#commentString

A user-defined comment.

Returns:

  • (String)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#custom_jsonString

A string that contains user-defined, custom JSON. It is used to override the corresponding default stack configuration JSON values. The string should be in the following format:

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

For more information on custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes.

Returns:

  • (String)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#instance_idsArray<String>

The instance IDs for the deployment targets.

Returns:

  • (Array<String>)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#layer_idsArray<String>

The layer IDs for the deployment targets.

Returns:

  • (Array<String>)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end

#stack_idString

The stack ID.

Returns:

  • (String)


1264
1265
1266
1267
1268
1269
1270
1271
1272
1273
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 1264

class CreateDeploymentRequest < Struct.new(
  :stack_id,
  :app_id,
  :instance_ids,
  :layer_ids,
  :command,
  :comment,
  :custom_json)
  include Aws::Structure
end