CfnStackProps

class aws_cdk.aws_opsworks.CfnStackProps(*, default_instance_profile_arn, name, service_role_arn, agent_version=None, attributes=None, chef_configuration=None, clone_app_ids=None, clone_permissions=None, configuration_manager=None, custom_cookbooks_source=None, custom_json=None, default_availability_zone=None, default_os=None, default_root_device_type=None, default_ssh_key_name=None, default_subnet_id=None, ecs_cluster_arn=None, elastic_ips=None, hostname_theme=None, rds_db_instances=None, source_stack_id=None, tags=None, use_custom_cookbooks=None, use_opsworks_security_groups=None, vpc_id=None)

Bases: object

Properties for defining a CfnStack.

Parameters
  • default_instance_profile_arn (str) – 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 .

  • name (str) – The stack name. Stack names can be a maximum of 64 characters.

  • service_role_arn (str) –

    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 .

  • agent_version (Optional[str]) – 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. .. epigraph:: You can also specify an agent version when you create or update an instance, which overrides the stack’s default setting.

  • attributes (Union[IResolvable, Mapping[str, str], None]) – One or more user-defined key-value pairs to be added to the stack attributes.

  • chef_configuration (Union[ChefConfigurationProperty, Dict[str, Any], IResolvable, None]) – 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 .

  • clone_app_ids (Optional[Sequence[str]]) – 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.

  • clone_permissions (Union[bool, IResolvable, None]) – If you’re cloning an AWS OpsWorks stack, indicates whether to clone the source stack’s permissions.

  • configuration_manager (Union[StackConfigurationManagerProperty, Dict[str, Any], IResolvable, None]) – 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.

  • custom_cookbooks_source (Union[SourceProperty, Dict[str, Any], IResolvable, None]) – Contains the information required to retrieve an app or cookbook from a repository. For more information, see Adding Apps or Cookbooks and Recipes .

  • custom_json (Optional[Any]) – 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 .

  • default_availability_zone (Optional[str]) – 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.

  • default_os (Optional[str]) – 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 .

  • default_root_device_type (Optional[str]) – 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 .

  • default_ssh_key_name (Optional[str]) – 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 .

  • default_subnet_id (Optional[str]) – 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.

  • ecs_cluster_arn (Optional[str]) – The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the AWS OpsWorks stack. .. epigraph:: If you specify a cluster that’s registered with another AWS OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.

  • elastic_ips (Union[IResolvable, Sequence[Union[ElasticIpProperty, Dict[str, Any], IResolvable]], None]) – A list of Elastic IP addresses to register with the AWS OpsWorks stack. .. epigraph:: 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.

  • hostname_theme (Optional[str]) – 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.

  • rds_db_instances (Union[IResolvable, Sequence[Union[RdsDbInstanceProperty, Dict[str, Any], IResolvable]], None]) – The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the AWS OpsWorks stack. .. epigraph:: 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.

  • source_stack_id (Optional[str]) – If you’re cloning an AWS OpsWorks stack, the stack ID of the source AWS OpsWorks stack to clone.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

  • use_custom_cookbooks (Union[bool, IResolvable, None]) – Whether the stack uses custom cookbooks.

  • use_opsworks_security_groups (Union[bool, IResolvable, None]) –

    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 .

  • vpc_id (Optional[str]) – 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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html

ExampleMetadata

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_opsworks as opsworks

# custom_json: Any

cfn_stack_props = opsworks.CfnStackProps(
    default_instance_profile_arn="defaultInstanceProfileArn",
    name="name",
    service_role_arn="serviceRoleArn",

    # the properties below are optional
    agent_version="agentVersion",
    attributes={
        "attributes_key": "attributes"
    },
    chef_configuration=opsworks.CfnStack.ChefConfigurationProperty(
        berkshelf_version="berkshelfVersion",
        manage_berkshelf=False
    ),
    clone_app_ids=["cloneAppIds"],
    clone_permissions=False,
    configuration_manager=opsworks.CfnStack.StackConfigurationManagerProperty(
        name="name",
        version="version"
    ),
    custom_cookbooks_source=opsworks.CfnStack.SourceProperty(
        password="password",
        revision="revision",
        ssh_key="sshKey",
        type="type",
        url="url",
        username="username"
    ),
    custom_json=custom_json,
    default_availability_zone="defaultAvailabilityZone",
    default_os="defaultOs",
    default_root_device_type="defaultRootDeviceType",
    default_ssh_key_name="defaultSshKeyName",
    default_subnet_id="defaultSubnetId",
    ecs_cluster_arn="ecsClusterArn",
    elastic_ips=[opsworks.CfnStack.ElasticIpProperty(
        ip="ip",

        # the properties below are optional
        name="name"
    )],
    hostname_theme="hostnameTheme",
    rds_db_instances=[opsworks.CfnStack.RdsDbInstanceProperty(
        db_password="dbPassword",
        db_user="dbUser",
        rds_db_instance_arn="rdsDbInstanceArn"
    )],
    source_stack_id="sourceStackId",
    tags=[CfnTag(
        key="key",
        value="value"
    )],
    use_custom_cookbooks=False,
    use_opsworks_security_groups=False,
    vpc_id="vpcId"
)

Attributes

agent_version

.

  • 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. .. epigraph:

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

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-agentversion

Type

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

Return type

Optional[str]

attributes

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-attributes

Return type

Union[IResolvable, Mapping[str, str], None]

chef_configuration

//docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html>`_ .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-chefconfiguration

Type

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

Return type

Union[ChefConfigurationProperty, IResolvable, None]

clone_app_ids

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids

Return type

Optional[List[str]]

clone_permissions

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions

Return type

Union[bool, IResolvable, None]

configuration_manager

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-configmanager

Return type

Union[StackConfigurationManagerProperty, IResolvable, None]

custom_cookbooks_source

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

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custcookbooksource

Return type

Union[SourceProperty, IResolvable, None]

custom_json

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-custjson

Return type

Any

default_availability_zone

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultaz

Return type

Optional[str]

default_instance_profile_arn

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultinstanceprof

Return type

str

default_os

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos

Return type

Optional[str]

default_root_device_type

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultrootdevicetype

Return type

Optional[str]

default_ssh_key_name

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname

Return type

Optional[str]

default_subnet_id

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#defaultsubnet

Return type

Optional[str]

ecs_cluster_arn

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn

Return type

Optional[str]

elastic_ips

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips

Return type

Union[IResolvable, List[Union[ElasticIpProperty, IResolvable]], None]

hostname_theme

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-hostnametheme

Return type

Optional[str]

name

The stack name.

Stack names can be a maximum of 64 characters.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-name

Return type

str

rds_db_instances

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances

Return type

Union[IResolvable, List[Union[RdsDbInstanceProperty, IResolvable]], None]

service_role_arn

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-servicerolearn

Return type

str

source_stack_id

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

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid

Return type

Optional[str]

tags

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.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-tags

Return type

Optional[List[CfnTag]]

use_custom_cookbooks

Whether the stack uses custom cookbooks.

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#usecustcookbooks

Return type

Union[bool, IResolvable, None]

use_opsworks_security_groups

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-useopsworkssecuritygroups

Return type

Union[bool, IResolvable, None]

vpc_id

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 .

Link

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid

Return type

Optional[str]