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

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

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

Overview

Describes a deployment of a stack or app.

Instance Attribute Summary collapse

Instance Attribute Details

#app_idString

The app ID.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#commandTypes::DeploymentCommand

Used to specify a stack or deployment command.



2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#commentString

A user-defined comment.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#completed_atString

Date when the deployment completed.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#created_atString

Date when the deployment was created.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#custom_jsonString

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)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#deployment_idString

The deployment ID.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#durationInteger

The deployment duration.

Returns:

  • (Integer)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#iam_user_arnString

The user's IAM ARN.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#instance_idsArray<String>

The IDs of the target instances.

Returns:

  • (Array<String>)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#stack_idString

The stack ID.

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end

#statusString

The deployment status:

  • running

  • successful

  • failed

Returns:

  • (String)


2429
2430
2431
2432
2433
2434
2435
2436
2437
2438
2439
2440
2441
2442
2443
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 2429

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)
  include Aws::Structure
end