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

Class: Aws::OpsWorks::StackSummary

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

Defined Under Namespace

Classes: Collection

Associations collapse

Read-Only Attributes collapse

Instance Method Summary collapse

Constructor Details

#initialize(stack_id, options = {}) ⇒ StackSummary #initialize(options = {}) ⇒ StackSummary

Returns a new instance of StackSummary

Overloads:

  • #initialize(stack_id, options = {}) ⇒ StackSummary

    Parameters:

    • stack_id (String)

    Options Hash (options):

  • #initialize(options = {}) ⇒ StackSummary

    Options Hash (options):

    • :stack_id (required, String)
    • :client (Client)


19
20
21
22
23
24
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 19

def initialize(*args)
  options = Hash === args.last ? args.pop.dup : {}
  @stack_id = extract_stack_id(args, options)
  @data = options.delete(:data)
  @client = options.delete(:client) || Client.new(options)
end

Instance Method Details

#apps_countInteger

The number of apps.

Returns:

  • (Integer)


53
54
55
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 53

def apps_count
  data.apps_count
end

#arnString

The stack's ARN.

Returns:

  • (String)


41
42
43
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 41

def arn
  data.arn
end

#clientClient

Returns:



67
68
69
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 67

def client
  @client
end

#dataTypes::StackSummary

Returns the data for this Aws::OpsWorks::StackSummary. Calls Client#describe_stack_summary if #data_loaded? is false.

Returns:



87
88
89
90
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 87

def data
  load unless @data
  @data
end

#data_loaded?Boolean

Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.

Returns:

  • (Boolean)

    Returns true if this resource is loaded. Accessing attributes or #data on an unloaded resource will trigger a call to #load.



95
96
97
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 95

def data_loaded?
  !!@data
end

#instances_countTypes::InstancesCount

An InstancesCount object with the number of instances in each status.



60
61
62
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 60

def instances_count
  data.instances_count
end

#layers_countInteger

The number of layers.

Returns:

  • (Integer)


47
48
49
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 47

def layers_count
  data.layers_count
end

#loadself Also known as: reload

Loads, or reloads #data for the current Aws::OpsWorks::StackSummary. Returns self making it possible to chain methods.

stack_summary.reload.data

Returns:

  • (self)


77
78
79
80
81
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 77

def load
  resp = @client.describe_stack_summary(stack_id: @stack_id)
  @data = resp.stack_summary
  self
end

#nameString

The stack name.

Returns:

  • (String)


35
36
37
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 35

def name
  data.name
end

#stackStack

Returns:



102
103
104
105
106
107
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 102

def stack
  Stack.new(
    id: @stack_id,
    client: @client
  )
end

#stack_idString

Returns:

  • (String)


29
30
31
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/stack_summary.rb', line 29

def stack_id
  @stack_id
end