AWS CloudFormation
User Guide (Version )

AWS::OpsWorks::Instance

Creates an instance in a specified stack. For more information, see Adding an Instance to a Layer.

Required Permissions: To use this action, an IAM user must have a Manage permissions level for the stack, or an attached policy that explicitly grants permissions. For more information on user permissions, see Managing User Permissions.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{ "Type" : "AWS::OpsWorks::Instance", "Properties" : { "AgentVersion" : String, "AmiId" : String, "Architecture" : String, "AutoScalingType" : String, "AvailabilityZone" : String, "BlockDeviceMappings" : [ BlockDeviceMapping, ... ], "EbsOptimized" : Boolean, "ElasticIps" : [ String, ... ], "Hostname" : String, "InstallUpdatesOnBoot" : Boolean, "InstanceType" : String, "LayerIds" : [ String, ... ], "Os" : String, "RootDeviceType" : String, "SshKeyName" : String, "StackId" : String, "SubnetId" : String, "Tenancy" : String, "TimeBasedAutoScaling" : TimeBasedAutoScaling, "VirtualizationType" : String, "Volumes" : [ String, ... ] } }

YAML

Type: AWS::OpsWorks::Instance Properties :  AgentVersion : String  AmiId : String  Architecture : String  AutoScalingType : String  AvailabilityZone : String  BlockDeviceMappings : - BlockDeviceMapping  EbsOptimized : Boolean  ElasticIps : - String  Hostname : String  InstallUpdatesOnBoot : Boolean  InstanceType : String  LayerIds : - String  Os : String  RootDeviceType : String  SshKeyName : String  StackId : String  SubnetId : String  Tenancy : String  TimeBasedAutoScaling : TimeBasedAutoScaling  VirtualizationType : String  Volumes : - String

Properties

AgentVersion

The default AWS OpsWorks Stacks agent version. You have the following options:

  • INHERIT - Use the stack's default agent version setting.

  • version_number - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. AWS OpsWorks Stacks then automatically installs that version on the instance.

The default setting is INHERIT. To specify an agent version, you must use the complete version number, not the abbreviated number shown on the console. For a list of available agent version numbers, call DescribeAgentVersions. AgentVersion cannot be set to Chef 12.2.

Required: No

Type: String

Update requires: No interruption

AmiId

A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see Using Custom AMIs.

Note

If you specify a custom AMI, you must set Os to Custom.

Required: No

Type: String

Update requires: No interruption

Architecture

The instance architecture. The default option is x86_64. Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see Instance Families and Types.

Required: No

Type: String

Allowed Values: i386 | x86_64

Update requires: No interruption

AutoScalingType

For load-based or time-based instances, the type. Windows stacks can use only time-based instances.

Required: No

Type: String

Allowed Values: load | timer

Update requires: Replacement

AvailabilityZone

The Availability Zone of the AWS OpsWorks instance, such as us-east-2a.

Required: No

Type: String

Update requires: Replacement

BlockDeviceMappings

An array of BlockDeviceMapping objects that specify the instance's block devices. For more information, see Block Device Mapping. Note that block device mappings are not supported for custom AMIs.

Required: No

Type: List of BlockDeviceMapping

Update requires: Replacement

EbsOptimized

Whether to create an Amazon EBS-optimized instance.

Required: No

Type: Boolean

Update requires: Replacement

ElasticIps

A list of Elastic IP addresses to associate with the instance.

Required: No

Type: List of String

Update requires: No interruption

Hostname

The instance host name.

Required: No

Type: String

Update requires: No interruption

InstallUpdatesOnBoot

Whether to install operating system and package updates when the instance boots. The default value is true. To control when updates are installed, set this value to false. You must then update your instances manually by using CreateDeployment to run the update_dependencies stack command or by manually running yum (Amazon Linux) or apt-get (Ubuntu) on the instances.

Note

We strongly recommend using the default value of true to ensure that your instances have the latest security updates.

Required: No

Type: Boolean

Update requires: No interruption

InstanceType

The instance type, such as t2.micro. For a list of supported instance types, open the stack in the console, choose Instances, and choose + Instance. The Size list contains the currently supported types. For more information, see Instance Families and Types. The parameter values that you use to specify the various types are in the API Name column of the Available Instance Types table.

Required: Yes

Type: String

Update requires: No interruption

LayerIds

An array that contains the instance's layer IDs.

Required: Yes

Type: List of String

Update requires: No interruption

Os

The instance's operating system, which must be set to one of the following.

  • A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2018.03, Amazon Linux 2017.09, Amazon Linux 2017.03, Amazon Linux 2016.09, Amazon Linux 2016.03, Amazon Linux 2015.09, or Amazon Linux 2015.03.

  • A supported Ubuntu operating system, such as Ubuntu 16.04 LTS, Ubuntu 14.04 LTS, or Ubuntu 12.04 LTS.

  • CentOS Linux 7

  • Red Hat Enterprise Linux 7

  • A supported Windows operating system, such as Microsoft Windows Server 2012 R2 Base, Microsoft Windows Server 2012 R2 with SQL Server Express, Microsoft Windows Server 2012 R2 with SQL Server Standard, or Microsoft Windows Server 2012 R2 with SQL Server Web.

  • A custom AMI: Custom.

For more information about the supported operating systems, see AWS OpsWorks Stacks Operating Systems.

The default option is the current Amazon Linux version. If you set this parameter to Custom, you must use the CreateInstance action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is Custom. For more information about supported operating systems, see Operating SystemsFor more information about how to use custom AMIs with AWS OpsWorks Stacks, see Using Custom AMIs.

Required: No

Type: String

Update requires: No interruption

RootDeviceType

The instance root device type. For more information, see Storage for the Root Device.

Required: No

Type: String

Allowed Values: ebs | instance-store

Update requires: Replacement

SshKeyName

The instance's Amazon EC2 key-pair name.

Required: No

Type: String

Update requires: No interruption

StackId

The stack ID.

Required: Yes

Type: String

Update requires: Replacement

SubnetId

The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct AWS OpsWorks Stacks to launch the instance in a different subnet.

Required: No

Type: String

Update requires: Replacement

Tenancy

The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: dedicated, default, or host. Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see Dedicated Hosts Overview and Amazon EC2 Dedicated Hosts. For more information about dedicated instances, see Dedicated Instances and Amazon EC2 Dedicated Instances.

Required: No

Type: String

Update requires: Replacement

TimeBasedAutoScaling

The time-based scaling configuration for the instance.

Required: No

Type: TimeBasedAutoScaling

Allowed Values: load | timer

Update requires: Replacement

VirtualizationType

The instance's virtualization type, paravirtual or hvm.

Required: No

Type: String

Update requires: Replacement

Volumes

A list of AWS OpsWorks volume IDs to associate with the instance. For more information, see AWS::OpsWorks::Volume.

Required: No

Type: List of String

Update requires: No interruption

Return Values

Ref

When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the resource name. For example:

{ "Ref": "myInstance1" }

For the AWS OpsWorks instance myInstance1, Ref returns the AWS OpsWorks instance ID.

For more information about using the Ref function, see Ref.

Fn::GetAtt

The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.

AvailabilityZone

The Availability Zone of the AWS OpsWorks instance, such as us-east-2a.

PrivateDnsName

The private DNS name of the AWS OpsWorks instance.

PrivateIp

The private IP address of the AWS OpsWorks instance, such as 192.0.2.0.

PublicDnsName

The public DNS name of the AWS OpsWorks instance.

PublicIp

The public IP address of the AWS OpsWorks instance, such as 192.0.2.0.

Note

Use this attribute only when the AWS OpsWorks instance is in an AWS OpsWorks layer that auto-assigns public IP addresses.

Examples

Create Basic AWS OpsWorks Instances

The following example creates two AWS OpsWorks instances that are associated with the myStack AWS OpsWorks stack and the myLayer AWS OpsWorks layer:

JSON

"myInstance1" : { "Type" : "AWS::OpsWorks::Instance", "Properties" : { "StackId" : {"Ref":"myStack"}, "LayerIds" : [{"Ref":"myLayer"}], "InstanceType" : "m1.small" } }, "myInstance2" : { "Type" : "AWS::OpsWorks::Instance", "Properties" : { "StackId" : {"Ref":"myStack"}, "LayerIds" : [{"Ref":"myLayer"}], "InstanceType" : "m1.small" } }

YAML

myInstance1: Type: "AWS::OpsWorks::Instance" Properties: StackId: Ref: "myStack" LayerIds: - Ref: "myLayer" InstanceType: "m1.small" myInstance2: Type: "AWS::OpsWorks::Instance" Properties: StackId: Ref: "myStack" LayerIds: - Ref: "myLayer" InstanceType: "m1.small"

Define a Time-based Auto Scaling Instance

In the following example, the DBInstance instance is online for four hours from UTC 1200-1600 on Friday, Saturday, and Sunday. The instance is offline for all other times and days.

JSON

"DBInstance" : { "Type" : "AWS::OpsWorks::Instance", "Properties" : { "AutoScalingType" : "timer", "StackId" : {"Ref":"Stack"}, "LayerIds" : [{"Ref":"DBLayer"}], "InstanceType" : "m1.small", "TimeBasedAutoScaling" : { "Friday" : { "12" : "on", "13" : "on", "14" : "on", "15" : "on" }, "Saturday" : { "12" : "on", "13" : "on", "14" : "on", "15" : "on" }, "Sunday" : { "12" : "on", "13" : "on", "14" : "on", "15" : "on" } } } }

YAML

DBInstance: Type: "AWS::OpsWorks::Instance" Properties: AutoScalingType: "timer" StackId: Ref: "Stack" LayerIds: - Ref: "DBLayer" InstanceType: "m1.small" TimeBasedAutoScaling: Friday: 12: "on" 13: "on" 14: "on" 15: "on" Saturday: 12: "on" 13: "on" 14: "on" 15: "on" Sunday: 12: "on" 13: "on" 14: "on" 15: "on"

See Also