Class: Aws::OpsWorks::Types::Deployment

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::Deployment

Defined in:

gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb

Overview

Describes a deployment of a stack or app.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #app_id ⇒ String

  The app ID.

• #command ⇒ Types::DeploymentCommand

  Used to specify a stack or deployment command.

• #comment ⇒ String

  A user-defined comment.

• #completed_at ⇒ String

  Date when the deployment completed.

• #created_at ⇒ String

  Date when the deployment was created.

• #custom_json ⇒ String

  A string that contains user-defined custom JSON.

• #deployment_id ⇒ String

  The deployment ID.

• #duration ⇒ Integer

  The deployment duration.

• #iam_user_arn ⇒ String

  The user's IAM ARN.

• #instance_ids ⇒ Array<String>

  The IDs of the target instances.

• #stack_id ⇒ String

  The stack ID.

• #status ⇒ String

  The deployment status:.

Instance Attribute Details

#app_id ⇒ String

The app ID.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#command ⇒ Types::DeploymentCommand

Used to specify a stack or deployment command.

Returns:

• (Types::DeploymentCommand)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#comment ⇒ String

A user-defined comment.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#completed_at ⇒ String

Date when the deployment completed.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ String

Date when the deployment was created.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#custom_json ⇒ String

A string that contains user-defined custom JSON. It can be used to override the corresponding default stack configuration attribute values for stack or to pass data to recipes. 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)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#deployment_id ⇒ String

The deployment ID.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#duration ⇒ Integer

The deployment duration.

Returns:

• (Integer)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#iam_user_arn ⇒ String

The user's IAM ARN.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#instance_ids ⇒ Array<String>

The IDs of the target instances.

Returns:

• (Array<String>)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#stack_id ⇒ String

The stack ID.

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end

#status ⇒ String

The deployment status:

• running

• successful

• failed

Returns:

• (String)

# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2488

class Deployment < Struct.new(
  :deployment_id,
  :stack_id,
  :app_id,
  :created_at,
  :completed_at,
  :duration,
  :iam_user_arn,
  :comment,
  :command,
  :status,
  :custom_json,
  :instance_ids)
  SENSITIVE = []
  include Aws::Structure
end