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

Inherits:

Struct

• Object
• Struct
• Aws::OpsWorks::Types::Stack

Defined in:

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

Overview

Describes a stack.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #agent_version ⇒ String

  The agent version.

• #arn ⇒ String

  The stack's ARN.

• #attributes ⇒ Hash<String,String>

  The stack's attributes.

• #chef_configuration ⇒ Types::ChefConfiguration

  A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version.

• #configuration_manager ⇒ Types::StackConfigurationManager

  The configuration manager.

• #created_at ⇒ String

  The date when the stack was created.

• #custom_cookbooks_source ⇒ Types::Source

  Contains the information required to retrieve an app or cookbook from a repository.

• #custom_json ⇒ String

  A JSON object that contains user-defined attributes to be added to the stack configuration and deployment attributes.

• #default_availability_zone ⇒ String

  The stack's default Availability Zone.

• #default_instance_profile_arn ⇒ String

  The ARN of an IAM profile that is the default profile for all of the stack's EC2 instances.

• #default_os ⇒ String

  The stack's default operating system.

• #default_root_device_type ⇒ String

  The default root device type.

• #default_ssh_key_name ⇒ String

  A default Amazon EC2 key pair for the stack's instances.

• #default_subnet_id ⇒ String

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

• #hostname_theme ⇒ String

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

• #name ⇒ String

  The stack name.

• #region ⇒ String

  The stack AWS region, such as "ap-northeast-2".

• #service_role_arn ⇒ String

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

• #stack_id ⇒ String

  The stack ID.

• #use_custom_cookbooks ⇒ Boolean

  Whether the stack uses custom cookbooks.

• #use_opsworks_security_groups ⇒ Boolean

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

• #vpc_id ⇒ String

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

Instance Attribute Details

#agent_version ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#arn ⇒ String

The stack's ARN.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#attributes ⇒ Hash<String,String>

The stack's attributes.

Returns:

• (Hash<String,String>)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#chef_configuration ⇒ Types::ChefConfiguration

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

Returns:

• (Types::ChefConfiguration)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#configuration_manager ⇒ Types::StackConfigurationManager

The configuration manager.

Returns:

• (Types::StackConfigurationManager)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#created_at ⇒ String

The date when the stack was created.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#custom_cookbooks_source ⇒ Types::Source

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

Returns:

• (Types::Source)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#custom_json ⇒ String

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)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_availability_zone ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_instance_profile_arn ⇒ String

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)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_os ⇒ String

The stack's default operating system.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_root_device_type ⇒ String

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)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_ssh_key_name ⇒ String

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)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#default_subnet_id ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#hostname_theme ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The stack name.

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#service_role_arn ⇒ String

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

Returns:

• (String)

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

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)
  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 5000

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)
  SENSITIVE = []
  include Aws::Structure
end

#use_custom_cookbooks ⇒ Boolean

Whether the stack uses custom cookbooks.

Returns:

• (Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#use_opsworks_security_groups ⇒ Boolean

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

Returns:

• (Boolean)

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

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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_id ⇒ String

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

Returns:

• (String)

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

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)
  SENSITIVE = []
  include Aws::Structure
end