Create Deployment

opsworks_create_deployment

R Documentation

Runs deployment or stack commands

Description

Runs deployment or stack commands. For more information, see Deploying Apps and Run Stack Commands.

Required Permissions: To use this action, an IAM user must have a Deploy or Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Usage

opsworks_create_deployment(StackId, AppId, InstanceIds, LayerIds,
  Command, Comment, CustomJson)

Arguments

StackId

[required] The stack ID.

AppId

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

InstanceIds

The instance IDs for the deployment targets.

LayerIds

The layer IDs for the deployment targets.

Command

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

Comment

A user-defined comment.

CustomJson

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.

Value

A list with the following syntax:

list(
  DeploymentId = "string"
)

Request syntax

svc$create_deployment(
  StackId = "string",
  AppId = "string",
  InstanceIds = list(
    "string"
  ),
  LayerIds = list(
    "string"
  ),
  Command = list(
    Name = "install_dependencies"|"update_dependencies"|"update_custom_cookbooks"|"execute_recipes"|"configure"|"setup"|"deploy"|"rollback"|"start"|"stop"|"restart"|"undeploy",
    Args = list(
      list(
        "string"
      )
    )
  ),
  Comment = "string",
  CustomJson = "string"
)