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

Class: Aws::OpsWorks::Types::Stack

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

Overview

Describes a stack.

Instance Attribute Summary collapse

Instance Attribute Details

#agent_versionString

The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#arnString

The stack's ARN.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#attributesHash<String,String>

The stack's attributes.

Returns:

  • (Hash<String,String>)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#chef_configurationTypes::ChefConfiguration

A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#configuration_managerTypes::StackConfigurationManager

The configuration manager.



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#created_atString

The date when the stack was created.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#custom_cookbooks_sourceTypes::Source

Contains the information required to retrieve an app or cookbook from a repository. For more information, see Creating Apps or Custom Recipes and Cookbooks.

Returns:



5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#custom_jsonString

A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes. You can use custom JSON to override the corresponding default stack configuration attribute values 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)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_availability_zoneString

The stack's default Availability Zone. For more information, see Regions and Endpoints.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_instance_profile_arnString

The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances. For more information about IAM ARNs, see Using Identifiers.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_osString

The stack's default operating system.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_root_device_typeString

The default root device type. This value is used by default for all instances in the stack, but you can override it when you create an instance. For more information, see Storage for the Root Device.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_ssh_key_nameString

A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#default_subnet_idString

The default subnet ID; applicable only if the stack is running in a VPC.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#hostname_themeString

The stack host name theme, with spaces replaced by underscores.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#nameString

The stack name.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#regionString

The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#service_role_arnString

The stack AWS Identity and Access Management (IAM) role.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#stack_idString

The stack ID.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#use_custom_cookbooksBoolean

Whether the stack uses custom cookbooks.

Returns:

  • (Boolean)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#use_opsworks_security_groupsBoolean

Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

Returns:

  • (Boolean)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end

#vpc_idString

The VPC ID; applicable only if the stack is running in a VPC.

Returns:

  • (String)


5599
5600
5601
5602
5603
5604
5605
5606
5607
5608
5609
5610
5611
5612
5613
5614
5615
5616
5617
5618
5619
5620
5621
5622
5623
# File 'gems/aws-sdk-opsworks/lib/aws-sdk-opsworks/types.rb', line 5599

class Stack < Struct.new(
  :stack_id,
  :name,
  :arn,
  :region,
  :vpc_id,
  :attributes,
  :service_role_arn,
  :default_instance_profile_arn,
  :default_os,
  :hostname_theme,
  :default_availability_zone,
  :default_subnet_id,
  :custom_json,
  :configuration_manager,
  :chef_configuration,
  :use_custom_cookbooks,
  :use_opsworks_security_groups,
  :custom_cookbooks_source,
  :default_ssh_key_name,
  :created_at,
  :default_root_device_type,
  :agent_version)
  include Aws::Structure
end