Documentation

Describes a stack.

See: newStack smart constructor.

Create a value of Stack with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:defaultInstanceProfileArn:Stack', stack_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.

$sel:serviceRoleArn:Stack', stack_serviceRoleArn - The stack AWS Identity and Access Management (IAM) role.

$sel:defaultRootDeviceType:Stack', stack_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.

$sel:arn:Stack', stack_arn - The stack's ARN.

$sel:createdAt:Stack', stack_createdAt - The date when the stack was created.

$sel:vpcId:Stack', stack_vpcId - The VPC ID; applicable only if the stack is running in a VPC.

$sel:chefConfiguration:Stack', stack_chefConfiguration - A ChefConfiguration object that specifies whether to enable Berkshelf and the Berkshelf version. For more information, see Create a New Stack.

$sel:agentVersion:Stack', stack_agentVersion - The agent version. This parameter is set to LATEST for auto-update. or a version number for a fixed agent version.

$sel:defaultSshKeyName:Stack', stack_defaultSshKeyName - A default Amazon EC2 key pair for the stack's instances. You can override this value when you create or update an instance.

$sel:customJson:Stack', stack_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.

$sel:customCookbooksSource:Stack', stack_customCookbooksSource - Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes.

$sel:defaultAvailabilityZone:Stack', stack_defaultAvailabilityZone - The stack's default Availability Zone. For more information, see Regions and Endpoints.

$sel:attributes:Stack', stack_attributes - The stack's attributes.

$sel:name:Stack', stack_name - The stack name.

$sel:defaultOs:Stack', stack_defaultOs - The stack's default operating system.

$sel:useOpsworksSecurityGroups:Stack', stack_useOpsworksSecurityGroups - Whether the stack automatically associates the AWS OpsWorks Stacks built-in security groups with the stack's layers.

$sel:useCustomCookbooks:Stack', stack_useCustomCookbooks - Whether the stack uses custom cookbooks.

$sel:defaultSubnetId:Stack', stack_defaultSubnetId - The default subnet ID; applicable only if the stack is running in a VPC.

$sel:region:Stack', stack_region - The stack AWS region, such as "ap-northeast-2". For more information about AWS regions, see Regions and Endpoints.

$sel:configurationManager:Stack', stack_configurationManager - The configuration manager.

$sel:stackId:Stack', stack_stackId - The stack ID.

$sel:hostnameTheme:Stack', stack_hostnameTheme - The stack host name theme, with spaces replaced by underscores.

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.

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

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.

The stack's ARN.

The date when the stack was created.

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

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

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

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

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.

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

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

The stack's attributes.

The stack name.

The stack's default operating system.

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

Whether the stack uses custom cookbooks.

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

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

The configuration manager.

The stack ID.

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