software.amazon.awscdk.services.opsworks

Class CfnStack

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.opsworks.CfnStack

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.140Z")
 @Stability(value=Stable)
public class CfnStack
extends CfnResource
implements IInspectable

A CloudFormation `AWS::OpsWorks::Stack`.

Creates a new stack. For more information, see Create a New Stack .

Required Permissions : To use this action, an IAM user must have an attached policy that explicitly grants permissions. For more information about user permissions, see Managing User Permissions .

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.opsworks.*;
 Object customJson;
 CfnStack cfnStack = CfnStack.Builder.create(this, "MyCfnStack")
         .defaultInstanceProfileArn("defaultInstanceProfileArn")
         .name("name")
         .serviceRoleArn("serviceRoleArn")
         // the properties below are optional
         .agentVersion("agentVersion")
         .attributes(Map.of(
                 "attributesKey", "attributes"))
         .chefConfiguration(ChefConfigurationProperty.builder()
                 .berkshelfVersion("berkshelfVersion")
                 .manageBerkshelf(false)
                 .build())
         .cloneAppIds(List.of("cloneAppIds"))
         .clonePermissions(false)
         .configurationManager(StackConfigurationManagerProperty.builder()
                 .name("name")
                 .version("version")
                 .build())
         .customCookbooksSource(SourceProperty.builder()
                 .password("password")
                 .revision("revision")
                 .sshKey("sshKey")
                 .type("type")
                 .url("url")
                 .username("username")
                 .build())
         .customJson(customJson)
         .defaultAvailabilityZone("defaultAvailabilityZone")
         .defaultOs("defaultOs")
         .defaultRootDeviceType("defaultRootDeviceType")
         .defaultSshKeyName("defaultSshKeyName")
         .defaultSubnetId("defaultSubnetId")
         .ecsClusterArn("ecsClusterArn")
         .elasticIps(List.of(ElasticIpProperty.builder()
                 .ip("ip")
                 // the properties below are optional
                 .name("name")
                 .build()))
         .hostnameTheme("hostnameTheme")
         .rdsDbInstances(List.of(RdsDbInstanceProperty.builder()
                 .dbPassword("dbPassword")
                 .dbUser("dbUser")
                 .rdsDbInstanceArn("rdsDbInstanceArn")
                 .build()))
         .sourceStackId("sourceStackId")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .useCustomCookbooks(false)
         .useOpsworksSecurityGroups(false)
         .vpcId("vpcId")
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnStack.Builder A fluent builder for CfnStack.
static interface	CfnStack.ChefConfigurationProperty Describes the Chef configuration.
static interface	CfnStack.ElasticIpProperty Describes an Elastic IP address.
static interface	CfnStack.RdsDbInstanceProperty Describes an Amazon RDS instance.
static interface	CfnStack.SourceProperty Contains the information required to retrieve an app or cookbook from a repository.
static interface	CfnStack.StackConfigurationManagerProperty Describes the configuration manager.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnStack(software.constructs.Construct scope, String id, CfnStackProps props) Create a new `AWS::OpsWorks::Stack`.
protected	CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAgentVersion() The default AWS OpsWorks Stacks agent version.
Object	getAttributes() One or more user-defined key-value pairs to be added to the stack attributes.
protected Map<String,Object>	getCfnProperties()
Object	getChefConfiguration() A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
List<String>	getCloneAppIds() If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack.
Object	getClonePermissions() If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
Object	getConfigurationManager() The configuration manager.
Object	getCustomCookbooksSource() Contains the information required to retrieve an app or cookbook from a repository.
Object	getCustomJson() A string that contains user-defined, custom JSON.
String	getDefaultAvailabilityZone() The stack's default Availability Zone, which must be in the specified region.
String	getDefaultInstanceProfileArn() The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
String	getDefaultOs() The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.
String	getDefaultRootDeviceType() The default root device type.
String	getDefaultSshKeyName() A default Amazon EC2 key pair name.
String	getDefaultSubnetId() The stack's default subnet ID.
String	getEcsClusterArn() The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.
Object	getElasticIps() A list of Elastic IP addresses to register with the AWS OpsWorks stack.
String	getHostnameTheme() The stack's host name theme, with spaces replaced by underscores.
String	getName() The stack name.
Object	getRdsDbInstances() The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
String	getServiceRoleArn() The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
String	getSourceStackId() If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
TagManager	getTags() A map that contains tag keys and tag values that are attached to a stack or layer.
Object	getUseCustomCookbooks() Whether the stack uses custom cookbooks.
Object	getUseOpsworksSecurityGroups() Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
String	getVpcId() The ID of the VPC that the stack is to be launched into.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAgentVersion(String value) The default AWS OpsWorks Stacks agent version.
void	setAttributes(IResolvable value) One or more user-defined key-value pairs to be added to the stack attributes.
void	setAttributes(Map<String,String> value) One or more user-defined key-value pairs to be added to the stack attributes.
void	setChefConfiguration(CfnStack.ChefConfigurationProperty value) A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
void	setChefConfiguration(IResolvable value) A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
void	setCloneAppIds(List<String> value) If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack.
void	setClonePermissions(Boolean value) If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
void	setClonePermissions(IResolvable value) If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
void	setConfigurationManager(CfnStack.StackConfigurationManagerProperty value) The configuration manager.
void	setConfigurationManager(IResolvable value) The configuration manager.
void	setCustomCookbooksSource(CfnStack.SourceProperty value) Contains the information required to retrieve an app or cookbook from a repository.
void	setCustomCookbooksSource(IResolvable value) Contains the information required to retrieve an app or cookbook from a repository.
void	setCustomJson(Object value) A string that contains user-defined, custom JSON.
void	setDefaultAvailabilityZone(String value) The stack's default Availability Zone, which must be in the specified region.
void	setDefaultInstanceProfileArn(String value) The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
void	setDefaultOs(String value) The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.
void	setDefaultRootDeviceType(String value) The default root device type.
void	setDefaultSshKeyName(String value) A default Amazon EC2 key pair name.
void	setDefaultSubnetId(String value) The stack's default subnet ID.
void	setEcsClusterArn(String value) The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.
void	setElasticIps(IResolvable value) A list of Elastic IP addresses to register with the AWS OpsWorks stack.
void	setElasticIps(List<Object> value) A list of Elastic IP addresses to register with the AWS OpsWorks stack.
void	setHostnameTheme(String value) The stack's host name theme, with spaces replaced by underscores.
void	setName(String value) The stack name.
void	setRdsDbInstances(IResolvable value) The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
void	setRdsDbInstances(List<Object> value) The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
void	setServiceRoleArn(String value) The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
void	setSourceStackId(String value) If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
void	setUseCustomCookbooks(Boolean value) Whether the stack uses custom cookbooks.
void	setUseCustomCookbooks(IResolvable value) Whether the stack uses custom cookbooks.
void	setUseOpsworksSecurityGroups(Boolean value) Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
void	setUseOpsworksSecurityGroups(IResolvable value) Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
void	setVpcId(String value) The ID of the VPC that the stack is to be launched into.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnStack

protected CfnStack(software.amazon.jsii.JsiiObjectRef objRef)

CfnStack

protected CfnStack(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnStack

@Stability(value=Stable)
public CfnStack(@NotNull
                                         software.constructs.Construct scope,
                                         @NotNull
                                         String id,
                                         @NotNull
                                         CfnStackProps props)

Create a new `AWS::OpsWorks::Stack`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

A map that contains tag keys and tag values that are attached to a stack or layer.

• The key cannot be empty.
• The key can be a maximum of 127 characters, and can contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
• The value can be a maximum 255 characters, and contain only Unicode letters, numbers, or separators, or the following special characters: + - = . _ : /
• Leading and trailing white spaces are trimmed from both the key and value.
• A maximum of 40 tags is allowed for any resource.

getCustomJson

@Stability(value=Stable)
 @NotNull
public Object getCustomJson()

A string that contains user-defined, custom JSON.

It can be used 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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes .

setCustomJson

@Stability(value=Stable)
public void setCustomJson(@NotNull
                                                   Object value)

A string that contains user-defined, custom JSON.

It can be used 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 about custom JSON, see Use Custom JSON to Modify the Stack Configuration Attributes .

getDefaultInstanceProfileArn

@Stability(value=Stable)
 @NotNull
public String getDefaultInstanceProfileArn()

The Amazon Resource Name (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 .

setDefaultInstanceProfileArn

@Stability(value=Stable)
public void setDefaultInstanceProfileArn(@NotNull
                                                                  String value)

The Amazon Resource Name (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 .

getName

@Stability(value=Stable)
 @NotNull
public String getName()

The stack name.

Stack names can be a maximum of 64 characters.

setName

@Stability(value=Stable)
public void setName(@NotNull
                                             String value)

The stack name.

Stack names can be a maximum of 64 characters.

getServiceRoleArn

@Stability(value=Stable)
 @NotNull
public String getServiceRoleArn()

The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.

You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers .

setServiceRoleArn

@Stability(value=Stable)
public void setServiceRoleArn(@NotNull
                                                       String value)

The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.

You must set this parameter to the Amazon Resource Name (ARN) for an existing IAM role. For more information about IAM ARNs, see Using Identifiers .

getAgentVersion

@Stability(value=Stable)
 @Nullable
public String getAgentVersion()

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

• Auto-update - Set this parameter to LATEST . AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks installs that version on the stack's instances.

The default setting is the most recent release of the agent. 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.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

setAgentVersion

@Stability(value=Stable)
public void setAgentVersion(@Nullable
                                                     String value)

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

• Auto-update - Set this parameter to LATEST . AWS OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
• Fixed version - Set this parameter to your preferred agent version. To update the agent version, you must edit the stack configuration and specify a new version. AWS OpsWorks Stacks installs that version on the stack's instances.

The default setting is the most recent release of the agent. 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.

You can also specify an agent version when you create or update an instance, which overrides the stack's default setting.

getAttributes

@Stability(value=Stable)
 @Nullable
public Object getAttributes()

One or more user-defined key-value pairs to be added to the stack attributes.

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   IResolvable value)

One or more user-defined key-value pairs to be added to the stack attributes.

setAttributes

@Stability(value=Stable)
public void setAttributes(@Nullable
                                                   Map<String,String> value)

One or more user-defined key-value pairs to be added to the stack attributes.

getChefConfiguration

@Stability(value=Stable)
 @Nullable
public Object getChefConfiguration()

A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) .

setChefConfiguration

@Stability(value=Stable)
public void setChefConfiguration(@Nullable
                                                          CfnStack.ChefConfigurationProperty value)

A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) .

setChefConfiguration

@Stability(value=Stable)
public void setChefConfiguration(@Nullable
                                                          IResolvable value)

A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks. For more information, see [Create a New Stack](https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html) .

getCloneAppIds

@Stability(value=Stable)
 @Nullable
public List<String> getCloneAppIds()

If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack.

setCloneAppIds

@Stability(value=Stable)
public void setCloneAppIds(@Nullable
                                                    List<String> value)

If you're cloning an AWS OpsWorks stack, a list of AWS OpsWorks application stack IDs from the source stack to include in the cloned stack.

getClonePermissions

@Stability(value=Stable)
 @Nullable
public Object getClonePermissions()

If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.

setClonePermissions

@Stability(value=Stable)
public void setClonePermissions(@Nullable
                                                         Boolean value)

If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.

setClonePermissions

@Stability(value=Stable)
public void setClonePermissions(@Nullable
                                                         IResolvable value)

If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.

getConfigurationManager

@Stability(value=Stable)
 @Nullable
public Object getConfigurationManager()

The configuration manager.

When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

setConfigurationManager

@Stability(value=Stable)
public void setConfigurationManager(@Nullable
                                                             CfnStack.StackConfigurationManagerProperty value)

The configuration manager.

When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

setConfigurationManager

@Stability(value=Stable)
public void setConfigurationManager(@Nullable
                                                             IResolvable value)

The configuration manager.

When you create a stack we recommend that you use the configuration manager to specify the Chef version: 12, 11.10, or 11.4 for Linux stacks, or 12.2 for Windows stacks. The default value for Linux stacks is currently 12.

getCustomCookbooksSource

@Stability(value=Stable)
 @Nullable
public Object getCustomCookbooksSource()

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

For more information, see Adding Apps or Cookbooks and Recipes .

setCustomCookbooksSource

@Stability(value=Stable)
public void setCustomCookbooksSource(@Nullable
                                                              CfnStack.SourceProperty value)

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

For more information, see Adding Apps or Cookbooks and Recipes .

setCustomCookbooksSource

@Stability(value=Stable)
public void setCustomCookbooksSource(@Nullable
                                                              IResolvable value)

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

For more information, see Adding Apps or Cookbooks and Recipes .

getDefaultAvailabilityZone

@Stability(value=Stable)
 @Nullable
public String getDefaultAvailabilityZone()

The stack's default Availability Zone, which must be in the specified region.

For more information, see Regions and Endpoints . If you also specify a value for DefaultSubnetId , the subnet must be in the same zone. For more information, see the VpcId parameter description.

setDefaultAvailabilityZone

@Stability(value=Stable)
public void setDefaultAvailabilityZone(@Nullable
                                                                String value)

The stack's default Availability Zone, which must be in the specified region.

For more information, see Regions and Endpoints . If you also specify a value for DefaultSubnetId , the subnet must be in the same zone. For more information, see the VpcId parameter description.

getDefaultOs

@Stability(value=Stable)
 @Nullable
public String getDefaultOs()

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.

You can specify one of the following.

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2 , 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 18.04 LTS , 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 . You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs .

The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems .

setDefaultOs

@Stability(value=Stable)
public void setDefaultOs(@Nullable
                                                  String value)

The stack's default operating system, which is installed on every instance unless you specify a different operating system when you create the instance.

You can specify one of the following.

• A supported Linux operating system: An Amazon Linux version, such as Amazon Linux 2 , 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 18.04 LTS , 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 . You specify the custom AMI you want to use when you create instances. For more information, see Using Custom AMIs .

The default option is the current Amazon Linux version. Not all operating systems are supported with all versions of Chef. For more information about supported operating systems, see AWS OpsWorks Stacks Operating Systems .

getDefaultRootDeviceType

@Stability(value=Stable)
 @Nullable
public String getDefaultRootDeviceType()

The default root device type.

This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store . For more information, see Storage for the Root Device .

setDefaultRootDeviceType

@Stability(value=Stable)
public void setDefaultRootDeviceType(@Nullable
                                                              String value)

The default root device type.

This value is the default for all instances in the stack, but you can override it when you create an instance. The default option is instance-store . For more information, see Storage for the Root Device .

getDefaultSshKeyName

@Stability(value=Stable)
 @Nullable
public String getDefaultSshKeyName()

A default Amazon EC2 key pair name.

The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access . You can override this setting by specifying a different key pair, or no key pair, when you create an instance .

setDefaultSshKeyName

@Stability(value=Stable)
public void setDefaultSshKeyName(@Nullable
                                                          String value)

A default Amazon EC2 key pair name.

The default value is none. If you specify a key pair name, AWS OpsWorks installs the public key on the instance and you can use the private key with an SSH client to log in to the instance. For more information, see Using SSH to Communicate with an Instance and Managing SSH Access . You can override this setting by specifying a different key pair, or no key pair, when you create an instance .

getDefaultSubnetId

@Stability(value=Stable)
 @Nullable
public String getDefaultSubnetId()

The stack's default subnet ID.

All instances are launched into this subnet unless you specify another subnet ID when you create the instance. This parameter is required if you specify a value for the VpcId parameter. If you also specify a value for DefaultAvailabilityZone , the subnet must be in that zone.

setDefaultSubnetId

@Stability(value=Stable)
public void setDefaultSubnetId(@Nullable
                                                        String value)

The stack's default subnet ID.

All instances are launched into this subnet unless you specify another subnet ID when you create the instance. This parameter is required if you specify a value for the VpcId parameter. If you also specify a value for DefaultAvailabilityZone , the subnet must be in that zone.

getEcsClusterArn

@Stability(value=Stable)
 @Nullable
public String getEcsClusterArn()

The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.

If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.

setEcsClusterArn

@Stability(value=Stable)
public void setEcsClusterArn(@Nullable
                                                      String value)

The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.

If you specify a cluster that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.

getElasticIps

@Stability(value=Stable)
 @Nullable
public Object getElasticIps()

A list of Elastic IP addresses to register with the AWS OpsWorks stack.

If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.

setElasticIps

@Stability(value=Stable)
public void setElasticIps(@Nullable
                                                   IResolvable value)

A list of Elastic IP addresses to register with the AWS OpsWorks stack.

If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.

setElasticIps

@Stability(value=Stable)
public void setElasticIps(@Nullable
                                                   List<Object> value)

A list of Elastic IP addresses to register with the AWS OpsWorks stack.

If you specify an IP address that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.

getHostnameTheme

@Stability(value=Stable)
 @Nullable
public String getHostnameTheme()

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

The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent , which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods
• Clouds
• Europe_Cities
• Fruits
• Greek_Deities_and_Titans
• Legendary_creatures_from_Japan
• Planets_and_Moons
• Roman_Deities
• Scottish_Islands
• US_Cities
• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion , which returns a host name based on the current theme.

setHostnameTheme

@Stability(value=Stable)
public void setHostnameTheme(@Nullable
                                                      String value)

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

The theme is used to generate host names for the stack's instances. By default, HostnameTheme is set to Layer_Dependent , which creates host names by appending integers to the layer's short name. The other themes are:

• Baked_Goods
• Clouds
• Europe_Cities
• Fruits
• Greek_Deities_and_Titans
• Legendary_creatures_from_Japan
• Planets_and_Moons
• Roman_Deities
• Scottish_Islands
• US_Cities
• Wild_Cats

To obtain a generated host name, call GetHostNameSuggestion , which returns a host name based on the current theme.

getRdsDbInstances

@Stability(value=Stable)
 @Nullable
public Object getRdsDbInstances()

The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.

If you specify a database instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.

setRdsDbInstances

@Stability(value=Stable)
public void setRdsDbInstances(@Nullable
                                                       IResolvable value)

The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.

If you specify a database instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.

setRdsDbInstances

@Stability(value=Stable)
public void setRdsDbInstances(@Nullable
                                                       List<Object> value)

The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.

If you specify a database instance that's registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.

getSourceStackId

@Stability(value=Stable)
 @Nullable
public String getSourceStackId()

If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.

setSourceStackId

@Stability(value=Stable)
public void setSourceStackId(@Nullable
                                                      String value)

If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.

getUseCustomCookbooks

@Stability(value=Stable)
 @Nullable
public Object getUseCustomCookbooks()

Whether the stack uses custom cookbooks.

setUseCustomCookbooks

@Stability(value=Stable)
public void setUseCustomCookbooks(@Nullable
                                                           Boolean value)

Whether the stack uses custom cookbooks.

setUseCustomCookbooks

@Stability(value=Stable)
public void setUseCustomCookbooks(@Nullable
                                                           IResolvable value)

Whether the stack uses custom cookbooks.

getUseOpsworksSecurityGroups

@Stability(value=Stable)
 @Nullable
public Object getUseOpsworksSecurityGroups()

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

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack .

setUseOpsworksSecurityGroups

@Stability(value=Stable)
public void setUseOpsworksSecurityGroups(@Nullable
                                                                  Boolean value)

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

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack .

setUseOpsworksSecurityGroups

@Stability(value=Stable)
public void setUseOpsworksSecurityGroups(@Nullable
                                                                  IResolvable value)

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

AWS OpsWorks Stacks provides a standard set of built-in security groups, one for each layer, which are associated with layers by default. With UseOpsworksSecurityGroups you can instead provide your own custom security groups. UseOpsworksSecurityGroups has the following settings:

• True - AWS OpsWorks Stacks automatically associates the appropriate built-in security group with each layer (default setting). You can associate additional security groups with a layer after you create it, but you cannot delete the built-in security group.
• False - AWS OpsWorks Stacks does not associate built-in security groups with layers. You must create appropriate EC2 security groups and associate a security group with each layer that you create. However, you can still manually associate a built-in security group with a layer on creation; custom security groups are required only for those layers that need custom settings.

For more information, see Create a New Stack .

getVpcId

@Stability(value=Stable)
 @Nullable
public String getVpcId()

The ID of the VPC that the stack is to be launched into.

The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

• If your account supports EC2-Classic, the default value is no VPC .
• If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

• It must belong to a VPC in your account that is in the specified region.
• You must specify a value for DefaultSubnetId .

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC . For more information about default VPC and EC2-Classic, see Supported Platforms .

setVpcId

@Stability(value=Stable)
public void setVpcId(@Nullable
                                              String value)

The ID of the VPC that the stack is to be launched into.

The VPC must be in the stack's region. All instances are launched into this VPC. You cannot change the ID later.

• If your account supports EC2-Classic, the default value is no VPC .
• If your account does not support EC2-Classic, the default value is the default VPC for the specified region.

If the VPC ID corresponds to a default VPC and you have specified either the DefaultAvailabilityZone or the DefaultSubnetId parameter only, AWS OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, AWS OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.

If you specify a nondefault VPC ID, note the following:

• It must belong to a VPC in your account that is in the specified region.
• You must specify a value for DefaultSubnetId .

For more information about how to use AWS OpsWorks Stacks with a VPC, see Running a Stack in a VPC . For more information about default VPC and EC2-Classic, see Supported Platforms .