Class: Aws::OpsWorks::StackSummary

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

Defined Under Namespace

Classes: Collection

Read-Only Attributes collapse

Associations 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 '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_count ⇒ Integer

The number of apps.

Returns:

  • (Integer) 


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

def apps_count
  data.apps_count
end

#arn ⇒ String

The stack’s ARN.

Returns:

  • (String) 


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

def arn
  data.arn
end

#client ⇒ Client

Returns:



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

def client
  @client
end

#data ⇒ Types::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 '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 'lib/aws-sdk-opsworks/stack_summary.rb', line 95

def data_loaded?
  !!@data
end

#identifiers ⇒ Object

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Deprecated. 


111
112
113
 
# File 'lib/aws-sdk-opsworks/stack_summary.rb', line 111

def identifiers
  { stack_id: @stack_id }
end

#instances_count ⇒ Types::InstancesCount

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

Returns:



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

def instances_count
  data.instances_count
end

#layers_count ⇒ Integer

The number of layers.

Returns:

  • (Integer) 


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

def layers_count
  data.layers_count
end

#load ⇒ self 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 '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

#name ⇒ String

The stack name.

Returns:

  • (String) 


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

def name
  data.name
end

#stack ⇒ Stack

Returns:



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

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

#stack_id ⇒ String

Returns:

  • (String) 


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

def stack_id
  @stack_id
end