CfnStack

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.opsworks.CfnStack

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-11-18T02:14:06.214Z")
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 interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

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

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnStack(Construct scope, java.lang.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

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAgentVersion()` The default AWS OpsWorks Stacks agent version.
`java.lang.Object`	`getAttributes()` One or more user-defined key-value pairs to be added to the stack attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getChefConfiguration()` A `ChefConfiguration` object that specifies whether to enable Berkshelf and the Berkshelf version on Chef 11.10 stacks.
`java.util.List<java.lang.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.
`java.lang.Object`	`getClonePermissions()` If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
`java.lang.Object`	`getConfigurationManager()` The configuration manager.
`java.lang.Object`	`getCustomCookbooksSource()` Contains the information required to retrieve an app or cookbook from a repository.
`java.lang.Object`	`getCustomJson()` A string that contains user-defined, custom JSON.
`java.lang.String`	`getDefaultAvailabilityZone()` The stack's default Availability Zone, which must be in the specified region.
`java.lang.String`	`getDefaultInstanceProfileArn()` The Amazon Resource Name (ARN) of an IAM profile that is the default profile for all of the stack's EC2 instances.
`java.lang.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.
`java.lang.String`	`getDefaultRootDeviceType()` The default root device type.
`java.lang.String`	`getDefaultSshKeyName()` A default Amazon EC2 key pair name.
`java.lang.String`	`getDefaultSubnetId()` The stack's default subnet ID.
`java.lang.String`	`getEcsClusterArn()` The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack.
`java.lang.Object`	`getElasticIps()` A list of Elastic IP addresses to register with the AWS OpsWorks stack.
`java.lang.String`	`getHostnameTheme()` The stack's host name theme, with spaces replaced by underscores.
`java.lang.String`	`getName()` The stack name.
`java.lang.Object`	`getRdsDbInstances()` The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
`java.lang.String`	`getServiceRoleArn()` The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
`java.lang.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.
`java.lang.Object`	`getUseCustomCookbooks()` Whether the stack uses custom cookbooks.
`java.lang.Object`	`getUseOpsworksSecurityGroups()` Whether to associate the AWS OpsWorks Stacks built-in security groups with the stack's layers.
`java.lang.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 java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAgentVersion(java.lang.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(java.util.Map<java.lang.String,java.lang.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(java.util.List<java.lang.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(java.lang.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(java.lang.Object value)` A string that contains user-defined, custom JSON.
`void`	`setDefaultAvailabilityZone(java.lang.String value)` The stack's default Availability Zone, which must be in the specified region.
`void`	`setDefaultInstanceProfileArn(java.lang.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(java.lang.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(java.lang.String value)` The default root device type.
`void`	`setDefaultSshKeyName(java.lang.String value)` A default Amazon EC2 key pair name.
`void`	`setDefaultSubnetId(java.lang.String value)` The stack's default subnet ID.
`void`	`setEcsClusterArn(java.lang.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(java.util.List<java.lang.Object> value)` A list of Elastic IP addresses to register with the AWS OpsWorks stack.
`void`	`setHostnameTheme(java.lang.String value)` The stack's host name theme, with spaces replaced by underscores.
`void`	`setName(java.lang.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(java.util.List<java.lang.Object> value)` The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack.
`void`	`setServiceRoleArn(java.lang.String value)` The stack's IAM role, which allows AWS OpsWorks Stacks to work with AWS resources on your behalf.
`void`	`setSourceStackId(java.lang.String value)` If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
`void`	`setUseCustomCookbooks(java.lang.Boolean value)` Whether the stack uses custom cookbooks.
`void`	`setUseCustomCookbooks(IResolvable value)` Whether the stack uses custom cookbooks.
`void`	`setUseOpsworksSecurityGroups(java.lang.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(java.lang.String value)` The ID of the VPC that the stack is to be launched into.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.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
```
public CfnStack(Construct scope,
                java.lang.String id,
                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
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
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
```
public java.lang.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
```
public void setCustomJson(java.lang.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
```
public java.lang.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
```
public void setDefaultInstanceProfileArn(java.lang.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
```
public java.lang.String getName()
```
    The stack name.
    Stack names can be a maximum of 64 characters.
  - setName
```
public void setName(java.lang.String value)
```
    The stack name.
    Stack names can be a maximum of 64 characters.
  - getServiceRoleArn
```
public java.lang.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
```
public void setServiceRoleArn(java.lang.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
```
public java.lang.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
```
public void setAgentVersion(java.lang.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
```
public java.lang.Object getAttributes()
```
    One or more user-defined key-value pairs to be added to the stack attributes.
  - setAttributes
```
public void setAttributes(IResolvable value)
```
    One or more user-defined key-value pairs to be added to the stack attributes.
  - setAttributes
```
public void setAttributes(java.util.Map<java.lang.String,java.lang.String> value)
```
    One or more user-defined key-value pairs to be added to the stack attributes.
  - getChefConfiguration
```
public java.lang.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
```
public void setChefConfiguration(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) .
  - setChefConfiguration
```
public void setChefConfiguration(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) .
  - getCloneAppIds
```
public java.util.List<java.lang.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
```
public void setCloneAppIds(java.util.List<java.lang.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
```
public java.lang.Object getClonePermissions()
```
    If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
  - setClonePermissions
```
public void setClonePermissions(java.lang.Boolean value)
```
    If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
  - setClonePermissions
```
public void setClonePermissions(IResolvable value)
```
    If you're cloning an AWS OpsWorks stack, indicates whether to clone the source stack's permissions.
  - getConfigurationManager
```
public java.lang.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
```
public void setConfigurationManager(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.
  - setConfigurationManager
```
public void setConfigurationManager(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.
  - getCustomCookbooksSource
```
public java.lang.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
```
public void setCustomCookbooksSource(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 .
  - setCustomCookbooksSource
```
public void setCustomCookbooksSource(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 .
  - getDefaultAvailabilityZone
```
public java.lang.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
```
public void setDefaultAvailabilityZone(java.lang.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
```
public java.lang.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
```
public void setDefaultOs(java.lang.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
```
public java.lang.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
```
public void setDefaultRootDeviceType(java.lang.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
```
public java.lang.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
```
public void setDefaultSshKeyName(java.lang.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
```
public java.lang.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
```
public void setDefaultSubnetId(java.lang.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
```
public java.lang.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
```
public void setEcsClusterArn(java.lang.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
```
public java.lang.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
```
public void setElasticIps(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
```
public void setElasticIps(java.util.List<java.lang.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
```
public java.lang.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
```
public void setHostnameTheme(java.lang.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
```
public java.lang.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
```
public void setRdsDbInstances(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
```
public void setRdsDbInstances(java.util.List<java.lang.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
```
public java.lang.String getSourceStackId()
```
    If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
  - setSourceStackId
```
public void setSourceStackId(java.lang.String value)
```
    If you're cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.
  - getUseCustomCookbooks
```
public java.lang.Object getUseCustomCookbooks()
```
    Whether the stack uses custom cookbooks.
  - setUseCustomCookbooks
```
public void setUseCustomCookbooks(java.lang.Boolean value)
```
    Whether the stack uses custom cookbooks.
  - setUseCustomCookbooks
```
public void setUseCustomCookbooks(IResolvable value)
```
    Whether the stack uses custom cookbooks.
  - getUseOpsworksSecurityGroups
```
public java.lang.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
```
public void setUseOpsworksSecurityGroups(java.lang.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
```
public void setUseOpsworksSecurityGroups(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
```
public java.lang.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
```
public void setVpcId(java.lang.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 .

Class CfnStack

Nested Class Summary

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

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnStack

CfnStack

CfnStack

Method Detail

inspect

renderProperties

getCfnProperties

getTags

getCustomJson

setCustomJson

getDefaultInstanceProfileArn

setDefaultInstanceProfileArn

getName

setName

getServiceRoleArn

setServiceRoleArn

getAgentVersion

setAgentVersion

getAttributes

setAttributes

setAttributes

getChefConfiguration

setChefConfiguration

setChefConfiguration

getCloneAppIds

setCloneAppIds

getClonePermissions

setClonePermissions

setClonePermissions

getConfigurationManager

setConfigurationManager

setConfigurationManager

getCustomCookbooksSource

setCustomCookbooksSource

setCustomCookbooksSource

getDefaultAvailabilityZone

setDefaultAvailabilityZone

getDefaultOs

setDefaultOs

getDefaultRootDeviceType

setDefaultRootDeviceType

getDefaultSshKeyName

setDefaultSshKeyName

getDefaultSubnetId

setDefaultSubnetId

getEcsClusterArn

setEcsClusterArn

getElasticIps

setElasticIps

setElasticIps

getHostnameTheme

setHostnameTheme

getRdsDbInstances

setRdsDbInstances

setRdsDbInstances

getSourceStackId

setSourceStackId

getUseCustomCookbooks

setUseCustomCookbooks

setUseCustomCookbooks

getUseOpsworksSecurityGroups

setUseOpsworksSecurityGroups

setUseOpsworksSecurityGroups

getVpcId

setVpcId