stack Attributes

Important

The AWS OpsWorks Stacks service reached end of life on May 26, 2024 and has been disabled for both new and existing customers. We strongly recommend customers migrate their workloads to other solutions as soon as possible. If you have questions about migration, reach out to the AWS Support Team on AWS re:Post or through AWS Premium Support.

stack attributes specify some aspects of the stack configuration, such as service layer configurations.

• elb-load-balancers

• id

• name

• rds_instances

• vpc_id

elb-load-balancers

Contains a list of embedded objects, one for each Elastic Load Balancing load balancer in the stack. Each embedded object contains the following attributes that describe the load balancer configuration.

Note

The general node syntax for these attributes is as follows, where i specifies the instance's zero-based list index.

node["opsworks"]["stack"]["elb-load-balancers"]["i"]["attribute_name"]

dns_name

The load balancer's DNS name (string).

node["opsworks"]["stack"]["elb-load-balancers"]["i"]["dns_name"]

name

The load balancer's name (string).

node["opsworks"]["stack"]["elb-load-balancers"]["i"]["name"]

layer_id

The ID of the layer that the load balancer is attached to (string).

node["opsworks"]["stack"]["elb-load-balancers"]["i"]["layer_id"]

id

The stack ID (string).

node["opsworks"]["stack"]["id"]

name

The stack name (string).

node["opsworks"]["stack"]["name"]

rds_instances

Contains a list of embedded objects, one for each Amazon RDS instance that is registered with the stack. Each embedded object contains a set of attributes that define the instance's configuration. You specify these values when you use the Amazon RDS console or API to create the instance. You can also use the Amazon RDS console or API to edit some of the settings after the instance has been created. For more information, see the Amazon RDS documentation.

Note

The general node syntax for these attributes is as follows, where i specifies the instance's zero-based list index.

node["opsworks"]["stack"]["rds_instances"]["i"]["attribute_name"]

If your stack has multiple Amazon RDS instances, the following is an example of how to use a particular instance in a recipe.

if my_rds = node["opsworks"]["stack"]["rds_instances"].select{|rds_instance| rds_instance["db_instance_identifier"] == ‘db_id’ }.first
  template “/etc/rds.conf” do
    source "rds.conf.erb"
    variables :address => my_rds["address"]
  end
end

address	allocated_storage	arn
auto_minor_version_upgrade	availability_zone	backup_retention_period
db_instance_class	db_instance_identifier	db_instance_status
db_name	db_parameter_groups	db_security_groups
db_user	engine	instance_create_time
license_model	multi_az	option_group_memberships
port	preferred_backup_window	preferred_maintenance_window
publicly_accessible	read_replica_db_instance_identifiers	region
status_infos	vpc_security_groups

address

The instances URL, such as opsinstance.ccdvt3hwog1a.us-west-2.rds.amazonaws.com (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["address"]

allocated_storage

The allocated storage, in GB (number).

node["opsworks"]["stack"]["rds_instances"]["i"]["allocated_storage"]

arn

The instance's ARN (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["arn"]

auto_minor_version_upgrade

Whether to automatically apply minor version upgrades (Boolean).

node["opsworks"]["stack"]["rds_instances"]["i"]["auto_minor_version_upgrade"]

availability_zone

The instance's Availability Zone, such as us-west-2a (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["availability_zone"]

backup_retention_period

The backup retention period, in days (number).

node["opsworks"]["stack"]["rds_instances"]["i"]["backup_retention_period"]

db_instance_class

The DB instance class, such as db.m1.small (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_instance_class"]

db_instance_identifier

The user-defined DB instance identifier (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_instance_identifier"]

db_instance_status

The instance's status (string). For more information, see DB Instance.

node["opsworks"]["stack"]["rds_instances"]["i"]["db_instance_status"]

db_name

The user-defined DB name (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_name"]

db_parameter_groups

The instance's DB parameter groups, which contains a list of embedded objects, one for each parameter group. For more information, see Working with DB Parameter Groups. Each object contains the following attributes:

db_parameter_group_name

The group name (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_parameter_groups"][j"]["db_parameter_group_name"]

parameter_apply_status

The apply status (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_parameter_groups"][j"]["parameter_apply_status"]

db_security_groups

The instance's database security groups, which contains a list of embedded objects, one for each security group. For more information, see Working with DB Security Groups. Each object contains the following attributes

db_security_group_name

The security group name (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_security_groups"][j"]["db_security_group_name"]

status

The status (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_security_groups"][j"]["status"]

db_user

The user-defined Master User name (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["db_user"]

engine

The database engine, such as mysql(5.6.13) (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["engine"]

instance_create_time

The instance creation time, such as 2014-04-15T16:13:34Z (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["instance_create_time"]

license_model

The instance's license model, such as general-public-license (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["license_model"]

multi_az

Whether multi-AZ deployment is enabled (Boolean).

node["opsworks"]["stack"]["rds_instances"]["i"]["multi_az"]

option_group_memberships

The instance's option group memberships, which contains a list of embedded objects, one for each option group. For more information, see Working with Option Groups. Each object contains the following attributes:

option_group_name

The group's name (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["option_group_memberships"][j"]["option_group_name"]

status

The group's status (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["option_group_memberships"][j"]["status"]

port

The database server's port (number).

node["opsworks"]["stack"]["rds_instances"]["i"]["port"]

preferred_backup_window

The preferred daily backup window, such as 06:26-06:56 (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["preferred_backup_window"]

preferred_maintenance_window

The preferred weekly maintenance window, such as thu:07:13-thu:07:43 (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["preferred_maintenance_window"]

publicly_accessible

Whether the database is publicly accessible (Boolean).

node["opsworks"]["stack"]["rds_instances"]["i"]["publicly_accessible"]

read_replica_db_instance_identifiers

A list of the read-replica instance identifiers (list of string). For more information, see Working with Read Replicas.

node["opsworks"]["stack"]["rds_instances"]["i"]["read_replica_db_instance_identifiers"]

region

The AWS region, such as us-west-2 (string).

node["opsworks"]["stack"]["rds_instances"]["i"]["region"]

status_infos

A list of status information (list of string).

node["opsworks"]["stack"]["rds_instances"]["i"]["status_infos"]

vpc_security_groups

A list of VPC security groups (list of string).

node["opsworks"]["stack"]["rds_instances"]["i"]["vpc_security_groups"]

vpc_id

The VPC id (string). This value is null if the instance is not in a VPC.

node["opsworks"]["stack"]["vpc_id"]