Menu
AWS OpsWorks
API Reference (API Version 2013-02-18)

Stack

Describes a stack.

Contents

AgentVersion

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

Type: String

Required: No

Arn

The stack's ARN.

Type: String

Required: No

Attributes

The stack's attributes.

Type: String to string map

Valid Keys: Color

Required: No

ChefConfiguration

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

Type: ChefConfiguration object

Required: No

ConfigurationManager

The configuration manager.

Type: StackConfigurationManager object

Required: No

CreatedAt

The date when the stack was created.

Type: String

Required: No

CustomCookbooksSource

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

Type: Source object

Required: No

CustomJson

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.

Type: String

Required: No

DefaultAvailabilityZone

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

Type: String

Required: No

DefaultInstanceProfileArn

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.

Type: String

Required: No

DefaultOs

The stack's default operating system.

Type: String

Required: No

DefaultRootDeviceType

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.

Type: String

Valid Values: ebs | instance-store

Required: No

DefaultSshKeyName

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

Type: String

Required: No

DefaultSubnetId

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

Type: String

Required: No

HostnameTheme

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

Type: String

Required: No

Name

The stack name.

Type: String

Required: No

Region

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

Type: String

Required: No

ServiceRoleArn

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

Type: String

Required: No

StackId

The stack ID.

Type: String

Required: No

UseCustomCookbooks

Whether the stack uses custom cookbooks.

Type: Boolean

Required: No

UseOpsworksSecurityGroups

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

Type: Boolean

Required: No

VpcId

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

Type: String

Required: No

See Also

For more information about using this API in one of the language-specific AWS SDKs, see the following:

On this page: