aws-cdk-lib 2.209.1__py3-none-any.whl → 2.211.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +6 -11
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.209.1.jsii.tgz → aws-cdk-lib@2.211.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +2 -1
- aws_cdk/aws_appconfig/__init__.py +9 -0
- aws_cdk/aws_arcregionswitch/__init__.py +4962 -0
- aws_cdk/aws_athena/__init__.py +23 -19
- aws_cdk/aws_autoscaling/__init__.py +6 -6
- aws_cdk/aws_batch/__init__.py +721 -51
- aws_cdk/aws_cassandra/__init__.py +28 -1
- aws_cdk/aws_cloudfront/__init__.py +20 -8
- aws_cdk/aws_cognito/__init__.py +9 -2
- aws_cdk/aws_datazone/__init__.py +118 -77
- aws_cdk/aws_dax/__init__.py +39 -0
- aws_cdk/aws_deadline/__init__.py +155 -7
- aws_cdk/aws_docdb/__init__.py +20 -11
- aws_cdk/aws_dynamodb/__init__.py +160 -20
- aws_cdk/aws_ec2/__init__.py +978 -256
- aws_cdk/aws_ecr/__init__.py +274 -0
- aws_cdk/aws_ecs/__init__.py +335 -220
- aws_cdk/aws_eks/__init__.py +51 -3
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +9 -7
- aws_cdk/aws_entityresolution/__init__.py +240 -45
- aws_cdk/aws_evs/__init__.py +20 -45
- aws_cdk/aws_iot/__init__.py +387 -0
- aws_cdk/aws_iotsitewise/__init__.py +1247 -139
- aws_cdk/aws_ivs/__init__.py +443 -33
- aws_cdk/aws_kinesisfirehose/__init__.py +2 -0
- aws_cdk/aws_kms/__init__.py +15 -0
- aws_cdk/aws_lambda/__init__.py +3 -3
- aws_cdk/aws_lightsail/__init__.py +590 -0
- aws_cdk/aws_logs/__init__.py +97 -3
- aws_cdk/aws_medialive/__init__.py +270 -7
- aws_cdk/aws_mediapackagev2/__init__.py +204 -6
- aws_cdk/aws_neptune/__init__.py +41 -2
- aws_cdk/aws_networkfirewall/__init__.py +490 -134
- aws_cdk/aws_observabilityadmin/__init__.py +1468 -0
- aws_cdk/aws_opensearchserverless/__init__.py +2 -2
- aws_cdk/aws_opsworks/__init__.py +125 -125
- aws_cdk/aws_opsworkscm/__init__.py +1 -53
- aws_cdk/aws_pcs/__init__.py +36 -0
- aws_cdk/aws_qbusiness/__init__.py +3 -3
- aws_cdk/aws_quicksight/__init__.py +107 -0
- aws_cdk/aws_rds/__init__.py +274 -0
- aws_cdk/aws_s3/__init__.py +56 -1
- aws_cdk/aws_s3express/__init__.py +52 -1
- aws_cdk/aws_sagemaker/__init__.py +4033 -218
- aws_cdk/aws_ses/__init__.py +172 -9
- aws_cdk/aws_ssm/__init__.py +8 -4
- aws_cdk/aws_verifiedpermissions/__init__.py +23 -2
- aws_cdk/aws_wisdom/__init__.py +2 -2
- aws_cdk/aws_workspacesweb/__init__.py +949 -157
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/METADATA +8 -8
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/RECORD +58 -56
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.209.1.dist-info → aws_cdk_lib-2.211.0.dist-info}/top_level.txt +0 -0
aws_cdk/aws_opsworks/__init__.py
CHANGED
|
@@ -151,7 +151,7 @@ class CfnApp(
|
|
|
151
151
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
152
152
|
:param name: The app name.
|
|
153
153
|
:param stack_id: The stack ID.
|
|
154
|
-
:param type: The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer.
|
|
154
|
+
:param type: The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify ``other`` .
|
|
155
155
|
:param app_source: A ``Source`` object that specifies the app repository.
|
|
156
156
|
:param attributes: One or more user-defined key/value pairs to be added to the stack attributes.
|
|
157
157
|
:param data_sources: The app's data source.
|
|
@@ -615,9 +615,9 @@ class CfnApp(
|
|
|
615
615
|
username: typing.Optional[builtins.str] = None,
|
|
616
616
|
) -> None:
|
|
617
617
|
'''
|
|
618
|
-
:param password: When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set ``Password`` to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set ``Password`` to the password. For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ . In responses,
|
|
619
|
-
:param revision: The application's version.
|
|
620
|
-
:param ssh_key: In requests, the repository's SSH key. In responses,
|
|
618
|
+
:param password: When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set ``Password`` to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set ``Password`` to the password. For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ . In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
619
|
+
:param revision: The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
|
|
620
|
+
:param ssh_key: In requests, the repository's SSH key. In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
621
621
|
:param type: The repository type.
|
|
622
622
|
:param url: The source URL. The following is an example of an Amazon S3 source URL: ``https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz`` .
|
|
623
623
|
:param username: This parameter depends on the repository type. - For Amazon S3 bundles, set ``Username`` to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set ``Username`` to the user name.
|
|
@@ -671,7 +671,7 @@ class CfnApp(
|
|
|
671
671
|
|
|
672
672
|
For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ .
|
|
673
673
|
|
|
674
|
-
In responses,
|
|
674
|
+
In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
675
675
|
|
|
676
676
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-password
|
|
677
677
|
'''
|
|
@@ -682,7 +682,7 @@ class CfnApp(
|
|
|
682
682
|
def revision(self) -> typing.Optional[builtins.str]:
|
|
683
683
|
'''The application's version.
|
|
684
684
|
|
|
685
|
-
|
|
685
|
+
OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
|
|
686
686
|
|
|
687
687
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-revision
|
|
688
688
|
'''
|
|
@@ -693,7 +693,7 @@ class CfnApp(
|
|
|
693
693
|
def ssh_key(self) -> typing.Optional[builtins.str]:
|
|
694
694
|
'''In requests, the repository's SSH key.
|
|
695
695
|
|
|
696
|
-
In responses,
|
|
696
|
+
In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
697
697
|
|
|
698
698
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-app-source.html#cfn-opsworks-app-source-sshkey
|
|
699
699
|
'''
|
|
@@ -875,7 +875,7 @@ class CfnAppProps:
|
|
|
875
875
|
|
|
876
876
|
:param name: The app name.
|
|
877
877
|
:param stack_id: The stack ID.
|
|
878
|
-
:param type: The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer.
|
|
878
|
+
:param type: The app type. Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify ``other`` .
|
|
879
879
|
:param app_source: A ``Source`` object that specifies the app repository.
|
|
880
880
|
:param attributes: One or more user-defined key/value pairs to be added to the stack attributes.
|
|
881
881
|
:param data_sources: The app's data source.
|
|
@@ -997,7 +997,7 @@ class CfnAppProps:
|
|
|
997
997
|
def type(self) -> builtins.str:
|
|
998
998
|
'''The app type.
|
|
999
999
|
|
|
1000
|
-
Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer.
|
|
1000
|
+
Each supported type is associated with a particular layer. For example, PHP applications are associated with a PHP layer. OpsWorks Stacks deploys an application to those instances that are members of the corresponding layer. If your app isn't one of the standard types, or you prefer to implement your own Deploy recipes, specify ``other`` .
|
|
1001
1001
|
|
|
1002
1002
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-app.html#cfn-opsworks-app-type
|
|
1003
1003
|
'''
|
|
@@ -1155,7 +1155,7 @@ class CfnElasticLoadBalancerAttachment(
|
|
|
1155
1155
|
:param scope: Scope in which this resource is defined.
|
|
1156
1156
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
1157
1157
|
:param elastic_load_balancer_name: The Elastic Load Balancing instance name.
|
|
1158
|
-
:param layer_id: The
|
|
1158
|
+
:param layer_id: The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
|
|
1159
1159
|
'''
|
|
1160
1160
|
if __debug__:
|
|
1161
1161
|
type_hints = typing.get_type_hints(_typecheckingstub__486f7e1e8e8052927626441be8be1b13d2a9ce484c4915a83fb32a7def2f835d)
|
|
@@ -1226,7 +1226,7 @@ class CfnElasticLoadBalancerAttachment(
|
|
|
1226
1226
|
@builtins.property
|
|
1227
1227
|
@jsii.member(jsii_name="layerId")
|
|
1228
1228
|
def layer_id(self) -> builtins.str:
|
|
1229
|
-
'''The
|
|
1229
|
+
'''The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.'''
|
|
1230
1230
|
return typing.cast(builtins.str, jsii.get(self, "layerId"))
|
|
1231
1231
|
|
|
1232
1232
|
@layer_id.setter
|
|
@@ -1255,7 +1255,7 @@ class CfnElasticLoadBalancerAttachmentProps:
|
|
|
1255
1255
|
'''Properties for defining a ``CfnElasticLoadBalancerAttachment``.
|
|
1256
1256
|
|
|
1257
1257
|
:param elastic_load_balancer_name: The Elastic Load Balancing instance name.
|
|
1258
|
-
:param layer_id: The
|
|
1258
|
+
:param layer_id: The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
|
|
1259
1259
|
|
|
1260
1260
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html
|
|
1261
1261
|
:exampleMetadata: fixture=_generated
|
|
@@ -1292,7 +1292,7 @@ class CfnElasticLoadBalancerAttachmentProps:
|
|
|
1292
1292
|
|
|
1293
1293
|
@builtins.property
|
|
1294
1294
|
def layer_id(self) -> builtins.str:
|
|
1295
|
-
'''The
|
|
1295
|
+
'''The OpsWorks layer ID to which the Elastic Load Balancing load balancer is attached.
|
|
1296
1296
|
|
|
1297
1297
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-elasticloadbalancerattachment.html#cfn-opsworks-elasticloadbalancerattachment-layerid
|
|
1298
1298
|
'''
|
|
@@ -1423,24 +1423,24 @@ class CfnInstance(
|
|
|
1423
1423
|
:param instance_type: The instance type, such as ``t2.micro`` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see `Instance Families and Types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
|
|
1424
1424
|
:param layer_ids: An array that contains the instance's layer IDs.
|
|
1425
1425
|
:param stack_id: The stack ID.
|
|
1426
|
-
:param agent_version: The default
|
|
1426
|
+
:param agent_version: The default OpsWorks Stacks agent version. You have the following options:. - ``INHERIT`` - Use the stack's default agent version setting. - *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance. The default setting is ``INHERIT`` . 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.
|
|
1427
1427
|
:param ami_id: A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . .. epigraph:: If you specify a custom AMI, you must set ``Os`` to ``Custom`` .
|
|
1428
1428
|
:param architecture: The instance architecture. The default option is ``x86_64`` . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see `Instance Families and Types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ .
|
|
1429
1429
|
:param auto_scaling_type: For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
|
|
1430
|
-
:param availability_zone: The Availability Zone of the
|
|
1430
|
+
:param availability_zone: The Availability Zone of the OpsWorks instance, such as ``us-east-2a`` .
|
|
1431
1431
|
:param block_device_mappings: An array of ``BlockDeviceMapping`` objects that specify the instance's block devices. For more information, see `Block Device Mapping <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html>`_ . Note that block device mappings are not supported for custom AMIs.
|
|
1432
1432
|
:param ebs_optimized: Whether to create an Amazon EBS-optimized instance.
|
|
1433
1433
|
:param elastic_ips: A list of Elastic IP addresses to associate with the instance.
|
|
1434
1434
|
:param hostname: The instance host name. The following are character limits for instance host names. - Linux-based instances: 63 characters - Windows-based instances: 15 characters
|
|
1435
1435
|
:param install_updates_on_boot: Whether to install operating system and package updates when the instance boots. The default value is ``true`` . To control when updates are installed, set this value to ``false`` . You must then update your instances manually by using ``CreateDeployment`` to run the ``update_dependencies`` stack command or by manually running ``yum`` (Amazon Linux) or ``apt-get`` (Ubuntu) on the instances. .. epigraph:: We strongly recommend using the default value of ``true`` to ensure that your instances have the latest security updates.
|
|
1436
|
-
:param os: The instance's operating system, which must be set to 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`` . Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `
|
|
1436
|
+
:param os: The instance's operating system, which must be set to 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`` . Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ . The default option is the current Amazon Linux version. If you set this parameter to ``Custom`` , you must use the ``CreateInstance`` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is ``Custom`` . For more information about how to use custom AMIs with OpsWorks Stacks, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ .
|
|
1437
1437
|
:param root_device_type: The instance root device type. For more information, see `Storage for the Root Device <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device>`_ .
|
|
1438
1438
|
:param ssh_key_name: The instance's Amazon EC2 key-pair name.
|
|
1439
|
-
:param subnet_id: The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct
|
|
1439
|
+
:param subnet_id: The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
|
|
1440
1440
|
:param tenancy: The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: ``dedicated`` , ``default`` , or ``host`` . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see `Dedicated Hosts Overview <https://docs.aws.amazon.com/ec2/dedicated-hosts/>`_ and `Amazon EC2 Dedicated Hosts <https://docs.aws.amazon.com/ec2/dedicated-hosts/>`_ . For more information about dedicated instances, see `Dedicated Instances <https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html>`_ and `Amazon EC2 Dedicated Instances <https://docs.aws.amazon.com/ec2/purchasing-options/dedicated-instances/>`_ .
|
|
1441
1441
|
:param time_based_auto_scaling: The time-based scaling configuration for the instance.
|
|
1442
1442
|
:param virtualization_type: The instance's virtualization type, ``paravirtual`` or ``hvm`` .
|
|
1443
|
-
:param volumes: A list of
|
|
1443
|
+
:param volumes: A list of OpsWorks volume IDs to associate with the instance. For more information, see ```AWS::OpsWorks::Volume`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html>`_ .
|
|
1444
1444
|
'''
|
|
1445
1445
|
if __debug__:
|
|
1446
1446
|
type_hints = typing.get_type_hints(_typecheckingstub__c8b34de3ee05594312f14cce61c717304294b3891e9f25d66dd351119744660a)
|
|
@@ -1505,7 +1505,7 @@ class CfnInstance(
|
|
|
1505
1505
|
@builtins.property
|
|
1506
1506
|
@jsii.member(jsii_name="attrAvailabilityZone")
|
|
1507
1507
|
def attr_availability_zone(self) -> builtins.str:
|
|
1508
|
-
'''The Availability Zone of the
|
|
1508
|
+
'''The Availability Zone of the OpsWorks instance, such as ``us-east-2a`` .
|
|
1509
1509
|
|
|
1510
1510
|
:cloudformationAttribute: AvailabilityZone
|
|
1511
1511
|
'''
|
|
@@ -1522,7 +1522,7 @@ class CfnInstance(
|
|
|
1522
1522
|
@builtins.property
|
|
1523
1523
|
@jsii.member(jsii_name="attrPrivateDnsName")
|
|
1524
1524
|
def attr_private_dns_name(self) -> builtins.str:
|
|
1525
|
-
'''The private DNS name of the
|
|
1525
|
+
'''The private DNS name of the OpsWorks instance.
|
|
1526
1526
|
|
|
1527
1527
|
:cloudformationAttribute: PrivateDnsName
|
|
1528
1528
|
'''
|
|
@@ -1531,7 +1531,7 @@ class CfnInstance(
|
|
|
1531
1531
|
@builtins.property
|
|
1532
1532
|
@jsii.member(jsii_name="attrPrivateIp")
|
|
1533
1533
|
def attr_private_ip(self) -> builtins.str:
|
|
1534
|
-
'''The private IP address of the
|
|
1534
|
+
'''The private IP address of the OpsWorks instance, such as ``192.0.2.0`` .
|
|
1535
1535
|
|
|
1536
1536
|
:cloudformationAttribute: PrivateIp
|
|
1537
1537
|
'''
|
|
@@ -1540,7 +1540,7 @@ class CfnInstance(
|
|
|
1540
1540
|
@builtins.property
|
|
1541
1541
|
@jsii.member(jsii_name="attrPublicDnsName")
|
|
1542
1542
|
def attr_public_dns_name(self) -> builtins.str:
|
|
1543
|
-
'''The public DNS name of the
|
|
1543
|
+
'''The public DNS name of the OpsWorks instance.
|
|
1544
1544
|
|
|
1545
1545
|
:cloudformationAttribute: PublicDnsName
|
|
1546
1546
|
'''
|
|
@@ -1549,11 +1549,11 @@ class CfnInstance(
|
|
|
1549
1549
|
@builtins.property
|
|
1550
1550
|
@jsii.member(jsii_name="attrPublicIp")
|
|
1551
1551
|
def attr_public_ip(self) -> builtins.str:
|
|
1552
|
-
'''The public IP address of the
|
|
1552
|
+
'''The public IP address of the OpsWorks instance, such as ``192.0.2.0`` .
|
|
1553
1553
|
|
|
1554
1554
|
.. epigraph::
|
|
1555
1555
|
|
|
1556
|
-
Use this attribute only when the
|
|
1556
|
+
Use this attribute only when the OpsWorks instance is in an OpsWorks layer that auto-assigns public IP addresses.
|
|
1557
1557
|
|
|
1558
1558
|
:cloudformationAttribute: PublicIp
|
|
1559
1559
|
'''
|
|
@@ -1606,7 +1606,7 @@ class CfnInstance(
|
|
|
1606
1606
|
@builtins.property
|
|
1607
1607
|
@jsii.member(jsii_name="agentVersion")
|
|
1608
1608
|
def agent_version(self) -> typing.Optional[builtins.str]:
|
|
1609
|
-
'''The default
|
|
1609
|
+
'''The default OpsWorks Stacks agent version.
|
|
1610
1610
|
|
|
1611
1611
|
You have the following options:.
|
|
1612
1612
|
'''
|
|
@@ -1661,7 +1661,7 @@ class CfnInstance(
|
|
|
1661
1661
|
@builtins.property
|
|
1662
1662
|
@jsii.member(jsii_name="availabilityZone")
|
|
1663
1663
|
def availability_zone(self) -> typing.Optional[builtins.str]:
|
|
1664
|
-
'''The Availability Zone of the
|
|
1664
|
+
'''The Availability Zone of the OpsWorks instance, such as ``us-east-2a`` .'''
|
|
1665
1665
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "availabilityZone"))
|
|
1666
1666
|
|
|
1667
1667
|
@availability_zone.setter
|
|
@@ -1853,7 +1853,7 @@ class CfnInstance(
|
|
|
1853
1853
|
@builtins.property
|
|
1854
1854
|
@jsii.member(jsii_name="volumes")
|
|
1855
1855
|
def volumes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
1856
|
-
'''A list of
|
|
1856
|
+
'''A list of OpsWorks volume IDs to associate with the instance.'''
|
|
1857
1857
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "volumes"))
|
|
1858
1858
|
|
|
1859
1859
|
@volumes.setter
|
|
@@ -1883,7 +1883,7 @@ class CfnInstance(
|
|
|
1883
1883
|
virtual_name: typing.Optional[builtins.str] = None,
|
|
1884
1884
|
) -> None:
|
|
1885
1885
|
'''
|
|
1886
|
-
:param device_name: The device name that is exposed to the instance, such as ``/dev/sdh`` . For the root device, you can use the explicit device name or you can set this parameter to ``ROOT_DEVICE`` and
|
|
1886
|
+
:param device_name: The device name that is exposed to the instance, such as ``/dev/sdh`` . For the root device, you can use the explicit device name or you can set this parameter to ``ROOT_DEVICE`` and OpsWorks Stacks will provide the correct device name.
|
|
1887
1887
|
:param ebs: An ``EBSBlockDevice`` that defines how to configure an Amazon EBS volume when the instance is launched. You can specify either the ``VirtualName`` or ``Ebs`` , but not both.
|
|
1888
1888
|
:param no_device: Suppresses the specified device included in the AMI's block device mapping.
|
|
1889
1889
|
:param virtual_name: The virtual device name. For more information, see `BlockDeviceMapping <https://docs.aws.amazon.com/AWSEC2/latest/APIReference/API_BlockDeviceMapping.html>`_ . You can specify either the ``VirtualName`` or ``Ebs`` , but not both.
|
|
@@ -1930,7 +1930,7 @@ class CfnInstance(
|
|
|
1930
1930
|
def device_name(self) -> typing.Optional[builtins.str]:
|
|
1931
1931
|
'''The device name that is exposed to the instance, such as ``/dev/sdh`` .
|
|
1932
1932
|
|
|
1933
|
-
For the root device, you can use the explicit device name or you can set this parameter to ``ROOT_DEVICE`` and
|
|
1933
|
+
For the root device, you can use the explicit device name or you can set this parameter to ``ROOT_DEVICE`` and OpsWorks Stacks will provide the correct device name.
|
|
1934
1934
|
|
|
1935
1935
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-instance-blockdevicemapping.html#cfn-opsworks-instance-blockdevicemapping-devicename
|
|
1936
1936
|
'''
|
|
@@ -2350,24 +2350,24 @@ class CfnInstanceProps:
|
|
|
2350
2350
|
:param instance_type: The instance type, such as ``t2.micro`` . For a list of supported instance types, open the stack in the console, choose *Instances* , and choose *+ Instance* . The *Size* list contains the currently supported types. For more information, see `Instance Families and Types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ . The parameter values that you use to specify the various types are in the *API Name* column of the *Available Instance Types* table.
|
|
2351
2351
|
:param layer_ids: An array that contains the instance's layer IDs.
|
|
2352
2352
|
:param stack_id: The stack ID.
|
|
2353
|
-
:param agent_version: The default
|
|
2353
|
+
:param agent_version: The default OpsWorks Stacks agent version. You have the following options:. - ``INHERIT`` - Use the stack's default agent version setting. - *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance. The default setting is ``INHERIT`` . 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.
|
|
2354
2354
|
:param ami_id: A custom AMI ID to be used to create the instance. The AMI should be based on one of the supported operating systems. For more information, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . .. epigraph:: If you specify a custom AMI, you must set ``Os`` to ``Custom`` .
|
|
2355
2355
|
:param architecture: The instance architecture. The default option is ``x86_64`` . Instance types do not necessarily support both architectures. For a list of the architectures that are supported by the different instance types, see `Instance Families and Types <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/instance-types.html>`_ .
|
|
2356
2356
|
:param auto_scaling_type: For load-based or time-based instances, the type. Windows stacks can use only time-based instances.
|
|
2357
|
-
:param availability_zone: The Availability Zone of the
|
|
2357
|
+
:param availability_zone: The Availability Zone of the OpsWorks instance, such as ``us-east-2a`` .
|
|
2358
2358
|
:param block_device_mappings: An array of ``BlockDeviceMapping`` objects that specify the instance's block devices. For more information, see `Block Device Mapping <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/block-device-mapping-concepts.html>`_ . Note that block device mappings are not supported for custom AMIs.
|
|
2359
2359
|
:param ebs_optimized: Whether to create an Amazon EBS-optimized instance.
|
|
2360
2360
|
:param elastic_ips: A list of Elastic IP addresses to associate with the instance.
|
|
2361
2361
|
:param hostname: The instance host name. The following are character limits for instance host names. - Linux-based instances: 63 characters - Windows-based instances: 15 characters
|
|
2362
2362
|
:param install_updates_on_boot: Whether to install operating system and package updates when the instance boots. The default value is ``true`` . To control when updates are installed, set this value to ``false`` . You must then update your instances manually by using ``CreateDeployment`` to run the ``update_dependencies`` stack command or by manually running ``yum`` (Amazon Linux) or ``apt-get`` (Ubuntu) on the instances. .. epigraph:: We strongly recommend using the default value of ``true`` to ensure that your instances have the latest security updates.
|
|
2363
|
-
:param os: The instance's operating system, which must be set to 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`` . Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `
|
|
2363
|
+
:param os: The instance's operating system, which must be set to 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`` . Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ . The default option is the current Amazon Linux version. If you set this parameter to ``Custom`` , you must use the ``CreateInstance`` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is ``Custom`` . For more information about how to use custom AMIs with OpsWorks Stacks, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ .
|
|
2364
2364
|
:param root_device_type: The instance root device type. For more information, see `Storage for the Root Device <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device>`_ .
|
|
2365
2365
|
:param ssh_key_name: The instance's Amazon EC2 key-pair name.
|
|
2366
|
-
:param subnet_id: The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct
|
|
2366
|
+
:param subnet_id: The ID of the instance's subnet. If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
|
|
2367
2367
|
:param tenancy: The instance's tenancy option. The default option is no tenancy, or if the instance is running in a VPC, inherit tenancy settings from the VPC. The following are valid values for this parameter: ``dedicated`` , ``default`` , or ``host`` . Because there are costs associated with changes in tenancy options, we recommend that you research tenancy options before choosing them for your instances. For more information about dedicated hosts, see `Dedicated Hosts Overview <https://docs.aws.amazon.com/ec2/dedicated-hosts/>`_ and `Amazon EC2 Dedicated Hosts <https://docs.aws.amazon.com/ec2/dedicated-hosts/>`_ . For more information about dedicated instances, see `Dedicated Instances <https://docs.aws.amazon.com/AmazonVPC/latest/UserGuide/dedicated-instance.html>`_ and `Amazon EC2 Dedicated Instances <https://docs.aws.amazon.com/ec2/purchasing-options/dedicated-instances/>`_ .
|
|
2368
2368
|
:param time_based_auto_scaling: The time-based scaling configuration for the instance.
|
|
2369
2369
|
:param virtualization_type: The instance's virtualization type, ``paravirtual`` or ``hvm`` .
|
|
2370
|
-
:param volumes: A list of
|
|
2370
|
+
:param volumes: A list of OpsWorks volume IDs to associate with the instance. For more information, see ```AWS::OpsWorks::Volume`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html>`_ .
|
|
2371
2371
|
|
|
2372
2372
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html
|
|
2373
2373
|
:exampleMetadata: fixture=_generated
|
|
@@ -2534,10 +2534,10 @@ class CfnInstanceProps:
|
|
|
2534
2534
|
|
|
2535
2535
|
@builtins.property
|
|
2536
2536
|
def agent_version(self) -> typing.Optional[builtins.str]:
|
|
2537
|
-
'''The default
|
|
2537
|
+
'''The default OpsWorks Stacks agent version. You have the following options:.
|
|
2538
2538
|
|
|
2539
2539
|
- ``INHERIT`` - Use the stack's default agent version setting.
|
|
2540
|
-
- *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version.
|
|
2540
|
+
- *version_number* - Use the specified agent version. This value overrides the stack's default setting. To update the agent version, edit the instance configuration and specify a new version. OpsWorks Stacks installs that version on the instance.
|
|
2541
2541
|
|
|
2542
2542
|
The default setting is ``INHERIT`` . 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.
|
|
2543
2543
|
|
|
@@ -2584,7 +2584,7 @@ class CfnInstanceProps:
|
|
|
2584
2584
|
|
|
2585
2585
|
@builtins.property
|
|
2586
2586
|
def availability_zone(self) -> typing.Optional[builtins.str]:
|
|
2587
|
-
'''The Availability Zone of the
|
|
2587
|
+
'''The Availability Zone of the OpsWorks instance, such as ``us-east-2a`` .
|
|
2588
2588
|
|
|
2589
2589
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-availabilityzone
|
|
2590
2590
|
'''
|
|
@@ -2663,9 +2663,9 @@ class CfnInstanceProps:
|
|
|
2663
2663
|
- 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`` .
|
|
2664
2664
|
- A custom AMI: ``Custom`` .
|
|
2665
2665
|
|
|
2666
|
-
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `
|
|
2666
|
+
Not all operating systems are supported with all versions of Chef. For more information about the supported operating systems, see `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ .
|
|
2667
2667
|
|
|
2668
|
-
The default option is the current Amazon Linux version. If you set this parameter to ``Custom`` , you must use the ``CreateInstance`` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is ``Custom`` . For more information about how to use custom AMIs with
|
|
2668
|
+
The default option is the current Amazon Linux version. If you set this parameter to ``Custom`` , you must use the ``CreateInstance`` action's AmiId parameter to specify the custom AMI that you want to use. Block device mappings are not supported if the value is ``Custom`` . For more information about how to use custom AMIs with OpsWorks Stacks, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ .
|
|
2669
2669
|
|
|
2670
2670
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-os
|
|
2671
2671
|
'''
|
|
@@ -2696,7 +2696,7 @@ class CfnInstanceProps:
|
|
|
2696
2696
|
def subnet_id(self) -> typing.Optional[builtins.str]:
|
|
2697
2697
|
'''The ID of the instance's subnet.
|
|
2698
2698
|
|
|
2699
|
-
If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct
|
|
2699
|
+
If the stack is running in a VPC, you can use this parameter to override the stack's default subnet ID value and direct OpsWorks Stacks to launch the instance in a different subnet.
|
|
2700
2700
|
|
|
2701
2701
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-instance.html#cfn-opsworks-instance-subnetid
|
|
2702
2702
|
'''
|
|
@@ -2736,7 +2736,7 @@ class CfnInstanceProps:
|
|
|
2736
2736
|
|
|
2737
2737
|
@builtins.property
|
|
2738
2738
|
def volumes(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
2739
|
-
'''A list of
|
|
2739
|
+
'''A list of OpsWorks volume IDs to associate with the instance.
|
|
2740
2740
|
|
|
2741
2741
|
For more information, see ```AWS::OpsWorks::Volume`` <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-volume.html>`_ .
|
|
2742
2742
|
|
|
@@ -2876,7 +2876,7 @@ class CfnLayer(
|
|
|
2876
2876
|
:param auto_assign_public_ips: For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see `How to Edit a Layer <https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html>`_ .
|
|
2877
2877
|
:param enable_auto_healing: Whether to disable auto healing for the layer.
|
|
2878
2878
|
:param name: The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
|
|
2879
|
-
:param shortname: For custom layers only, use this parameter to specify the layer's short name, which is used internally by
|
|
2879
|
+
:param shortname: For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the `Layer Reference <https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html>`_ .
|
|
2880
2880
|
:param stack_id: The layer stack ID.
|
|
2881
2881
|
:param type: The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
|
|
2882
2882
|
:param attributes: One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the ``EcsClusterArn`` attribute to the cluster's ARN.
|
|
@@ -2886,9 +2886,9 @@ class CfnLayer(
|
|
|
2886
2886
|
:param custom_security_group_ids: An array containing the layer custom security group IDs.
|
|
2887
2887
|
:param install_updates_on_boot: Whether to install operating system and package updates when the instance boots. The default value is ``true`` . To control when updates are installed, set this value to ``false`` . You must then update your instances manually by using ``CreateDeployment`` to run the ``update_dependencies`` stack command or by manually running ``yum`` (Amazon Linux) or ``apt-get`` (Ubuntu) on the instances. .. epigraph:: To ensure that your instances have the latest security updates, we strongly recommend using the default value of ``true`` .
|
|
2888
2888
|
:param lifecycle_event_configuration: A ``LifeCycleEventConfiguration`` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
|
|
2889
|
-
:param load_based_auto_scaling: The load-based scaling configuration for the
|
|
2889
|
+
:param load_based_auto_scaling: The load-based scaling configuration for the OpsWorks layer.
|
|
2890
2890
|
:param packages: An array of ``Package`` objects that describes the layer packages.
|
|
2891
|
-
:param tags: Specifies one or more sets of tags (key–value pairs) to associate with this
|
|
2891
|
+
:param tags: Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer. Use tags to manage your resources.
|
|
2892
2892
|
:param use_ebs_optimized_instances: Whether to use Amazon EBS-optimized instances.
|
|
2893
2893
|
:param volume_configurations: A ``VolumeConfigurations`` object that describes the layer's Amazon EBS volumes.
|
|
2894
2894
|
'''
|
|
@@ -3037,7 +3037,7 @@ class CfnLayer(
|
|
|
3037
3037
|
@builtins.property
|
|
3038
3038
|
@jsii.member(jsii_name="shortname")
|
|
3039
3039
|
def shortname(self) -> builtins.str:
|
|
3040
|
-
'''For custom layers only, use this parameter to specify the layer's short name, which is used internally by
|
|
3040
|
+
'''For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.'''
|
|
3041
3041
|
return typing.cast(builtins.str, jsii.get(self, "shortname"))
|
|
3042
3042
|
|
|
3043
3043
|
@shortname.setter
|
|
@@ -3192,7 +3192,7 @@ class CfnLayer(
|
|
|
3192
3192
|
def load_based_auto_scaling(
|
|
3193
3193
|
self,
|
|
3194
3194
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLayer.LoadBasedAutoScalingProperty"]]:
|
|
3195
|
-
'''The load-based scaling configuration for the
|
|
3195
|
+
'''The load-based scaling configuration for the OpsWorks layer.'''
|
|
3196
3196
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLayer.LoadBasedAutoScalingProperty"]], jsii.get(self, "loadBasedAutoScaling"))
|
|
3197
3197
|
|
|
3198
3198
|
@load_based_auto_scaling.setter
|
|
@@ -3221,7 +3221,7 @@ class CfnLayer(
|
|
|
3221
3221
|
@builtins.property
|
|
3222
3222
|
@jsii.member(jsii_name="tagsRaw")
|
|
3223
3223
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
3224
|
-
'''Specifies one or more sets of tags (key–value pairs) to associate with this
|
|
3224
|
+
'''Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.'''
|
|
3225
3225
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
3226
3226
|
|
|
3227
3227
|
@tags_raw.setter
|
|
@@ -3292,7 +3292,7 @@ class CfnLayer(
|
|
|
3292
3292
|
) -> None:
|
|
3293
3293
|
'''
|
|
3294
3294
|
:param cpu_threshold: The CPU utilization threshold, as a percent of the available CPU. A value of -1 disables the threshold.
|
|
3295
|
-
:param ignore_metrics_time: The amount of time (in minutes) after a scaling event occurs that
|
|
3295
|
+
:param ignore_metrics_time: The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events. For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. ``IgnoreMetricsTime`` allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
|
|
3296
3296
|
:param instance_count: The number of instances to add or remove when the load exceeds a threshold.
|
|
3297
3297
|
:param load_threshold: The load threshold. A value of -1 disables the threshold. For more information about how load is computed, see `Load (computing) <https://docs.aws.amazon.com/http://en.wikipedia.org/wiki/Load_%28computing%29>`_ .
|
|
3298
3298
|
:param memory_threshold: The memory utilization threshold, as a percent of the available memory. A value of -1 disables the threshold.
|
|
@@ -3351,9 +3351,9 @@ class CfnLayer(
|
|
|
3351
3351
|
|
|
3352
3352
|
@builtins.property
|
|
3353
3353
|
def ignore_metrics_time(self) -> typing.Optional[jsii.Number]:
|
|
3354
|
-
'''The amount of time (in minutes) after a scaling event occurs that
|
|
3354
|
+
'''The amount of time (in minutes) after a scaling event occurs that OpsWorks Stacks should ignore metrics and suppress additional scaling events.
|
|
3355
3355
|
|
|
3356
|
-
For example,
|
|
3356
|
+
For example, OpsWorks Stacks adds new instances following an upscaling event but the instances won't start reducing the load until they have been booted and configured. There is no point in raising additional scaling events during that operation, which typically takes several minutes. ``IgnoreMetricsTime`` allows you to direct OpsWorks Stacks to suppress scaling events long enough to get the new instances online.
|
|
3357
3357
|
|
|
3358
3358
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-autoscalingthresholds.html#cfn-opsworks-layer-autoscalingthresholds-ignoremetricstime
|
|
3359
3359
|
'''
|
|
@@ -3488,9 +3488,9 @@ class CfnLayer(
|
|
|
3488
3488
|
up_scaling: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnLayer.AutoScalingThresholdsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3489
3489
|
) -> None:
|
|
3490
3490
|
'''
|
|
3491
|
-
:param down_scaling: An ``AutoScalingThresholds`` object that describes the downscaling configuration, which defines how and when
|
|
3491
|
+
:param down_scaling: An ``AutoScalingThresholds`` object that describes the downscaling configuration, which defines how and when OpsWorks Stacks reduces the number of instances.
|
|
3492
3492
|
:param enable: Whether load-based auto scaling is enabled for the layer.
|
|
3493
|
-
:param up_scaling: An ``AutoScalingThresholds`` object that describes the upscaling configuration, which defines how and when
|
|
3493
|
+
:param up_scaling: An ``AutoScalingThresholds`` object that describes the upscaling configuration, which defines how and when OpsWorks Stacks increases the number of instances.
|
|
3494
3494
|
|
|
3495
3495
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html
|
|
3496
3496
|
:exampleMetadata: fixture=_generated
|
|
@@ -3538,7 +3538,7 @@ class CfnLayer(
|
|
|
3538
3538
|
def down_scaling(
|
|
3539
3539
|
self,
|
|
3540
3540
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLayer.AutoScalingThresholdsProperty"]]:
|
|
3541
|
-
'''An ``AutoScalingThresholds`` object that describes the downscaling configuration, which defines how and when
|
|
3541
|
+
'''An ``AutoScalingThresholds`` object that describes the downscaling configuration, which defines how and when OpsWorks Stacks reduces the number of instances.
|
|
3542
3542
|
|
|
3543
3543
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-downscaling
|
|
3544
3544
|
'''
|
|
@@ -3560,7 +3560,7 @@ class CfnLayer(
|
|
|
3560
3560
|
def up_scaling(
|
|
3561
3561
|
self,
|
|
3562
3562
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnLayer.AutoScalingThresholdsProperty"]]:
|
|
3563
|
-
'''An ``AutoScalingThresholds`` object that describes the upscaling configuration, which defines how and when
|
|
3563
|
+
'''An ``AutoScalingThresholds`` object that describes the upscaling configuration, which defines how and when OpsWorks Stacks increases the number of instances.
|
|
3564
3564
|
|
|
3565
3565
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-loadbasedautoscaling.html#cfn-opsworks-layer-loadbasedautoscaling-upscaling
|
|
3566
3566
|
'''
|
|
@@ -3715,7 +3715,7 @@ class CfnLayer(
|
|
|
3715
3715
|
) -> None:
|
|
3716
3716
|
'''
|
|
3717
3717
|
:param delay_until_elb_connections_drained: Whether to enable Elastic Load Balancing connection draining. For more information, see `Connection Draining <https://docs.aws.amazon.com/ElasticLoadBalancing/latest/DeveloperGuide/TerminologyandKeyConcepts.html#conn-drain>`_
|
|
3718
|
-
:param execution_timeout: The time, in seconds, that
|
|
3718
|
+
:param execution_timeout: The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance.
|
|
3719
3719
|
|
|
3720
3720
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-shutdowneventconfiguration.html
|
|
3721
3721
|
:exampleMetadata: fixture=_generated
|
|
@@ -3756,7 +3756,7 @@ class CfnLayer(
|
|
|
3756
3756
|
|
|
3757
3757
|
@builtins.property
|
|
3758
3758
|
def execution_timeout(self) -> typing.Optional[jsii.Number]:
|
|
3759
|
-
'''The time, in seconds, that
|
|
3759
|
+
'''The time, in seconds, that OpsWorks Stacks waits after triggering a Shutdown event before shutting down an instance.
|
|
3760
3760
|
|
|
3761
3761
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-layer-shutdowneventconfiguration.html#cfn-opsworks-layer-shutdowneventconfiguration-executiontimeout
|
|
3762
3762
|
'''
|
|
@@ -3998,7 +3998,7 @@ class CfnLayerProps:
|
|
|
3998
3998
|
:param auto_assign_public_ips: For stacks that are running in a VPC, whether to automatically assign a public IP address to the layer's instances. For more information, see `How to Edit a Layer <https://docs.aws.amazon.com/opsworks/latest/userguide/workinglayers-basics-edit.html>`_ .
|
|
3999
3999
|
:param enable_auto_healing: Whether to disable auto healing for the layer.
|
|
4000
4000
|
:param name: The layer name, which is used by the console. Layer names can be a maximum of 32 characters.
|
|
4001
|
-
:param shortname: For custom layers only, use this parameter to specify the layer's short name, which is used internally by
|
|
4001
|
+
:param shortname: For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes. The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'. Built-in layer short names are defined by OpsWorks Stacks. For more information, see the `Layer Reference <https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html>`_ .
|
|
4002
4002
|
:param stack_id: The layer stack ID.
|
|
4003
4003
|
:param type: The layer type. A stack cannot have more than one built-in layer of the same type. It can have any number of custom layers. Built-in layers are not available in Chef 12 stacks.
|
|
4004
4004
|
:param attributes: One or more user-defined key-value pairs to be added to the stack attributes. To create a cluster layer, set the ``EcsClusterArn`` attribute to the cluster's ARN.
|
|
@@ -4008,9 +4008,9 @@ class CfnLayerProps:
|
|
|
4008
4008
|
:param custom_security_group_ids: An array containing the layer custom security group IDs.
|
|
4009
4009
|
:param install_updates_on_boot: Whether to install operating system and package updates when the instance boots. The default value is ``true`` . To control when updates are installed, set this value to ``false`` . You must then update your instances manually by using ``CreateDeployment`` to run the ``update_dependencies`` stack command or by manually running ``yum`` (Amazon Linux) or ``apt-get`` (Ubuntu) on the instances. .. epigraph:: To ensure that your instances have the latest security updates, we strongly recommend using the default value of ``true`` .
|
|
4010
4010
|
:param lifecycle_event_configuration: A ``LifeCycleEventConfiguration`` object that you can use to configure the Shutdown event to specify an execution timeout and enable or disable Elastic Load Balancer connection draining.
|
|
4011
|
-
:param load_based_auto_scaling: The load-based scaling configuration for the
|
|
4011
|
+
:param load_based_auto_scaling: The load-based scaling configuration for the OpsWorks layer.
|
|
4012
4012
|
:param packages: An array of ``Package`` objects that describes the layer packages.
|
|
4013
|
-
:param tags: Specifies one or more sets of tags (key–value pairs) to associate with this
|
|
4013
|
+
:param tags: Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer. Use tags to manage your resources.
|
|
4014
4014
|
:param use_ebs_optimized_instances: Whether to use Amazon EBS-optimized instances.
|
|
4015
4015
|
:param volume_configurations: A ``VolumeConfigurations`` object that describes the layer's Amazon EBS volumes.
|
|
4016
4016
|
|
|
@@ -4196,11 +4196,11 @@ class CfnLayerProps:
|
|
|
4196
4196
|
|
|
4197
4197
|
@builtins.property
|
|
4198
4198
|
def shortname(self) -> builtins.str:
|
|
4199
|
-
'''For custom layers only, use this parameter to specify the layer's short name, which is used internally by
|
|
4199
|
+
'''For custom layers only, use this parameter to specify the layer's short name, which is used internally by OpsWorks Stacks and by Chef recipes.
|
|
4200
4200
|
|
|
4201
4201
|
The short name is also used as the name for the directory where your app files are installed. It can have a maximum of 32 characters, which are limited to the alphanumeric characters, '-', '_', and '.'.
|
|
4202
4202
|
|
|
4203
|
-
Built-in layer short names are defined by
|
|
4203
|
+
Built-in layer short names are defined by OpsWorks Stacks. For more information, see the `Layer Reference <https://docs.aws.amazon.com/opsworks/latest/userguide/layers.html>`_ .
|
|
4204
4204
|
|
|
4205
4205
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-shortname
|
|
4206
4206
|
'''
|
|
@@ -4316,7 +4316,7 @@ class CfnLayerProps:
|
|
|
4316
4316
|
def load_based_auto_scaling(
|
|
4317
4317
|
self,
|
|
4318
4318
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnLayer.LoadBasedAutoScalingProperty]]:
|
|
4319
|
-
'''The load-based scaling configuration for the
|
|
4319
|
+
'''The load-based scaling configuration for the OpsWorks layer.
|
|
4320
4320
|
|
|
4321
4321
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-layer.html#cfn-opsworks-layer-loadbasedautoscaling
|
|
4322
4322
|
'''
|
|
@@ -4334,7 +4334,7 @@ class CfnLayerProps:
|
|
|
4334
4334
|
|
|
4335
4335
|
@builtins.property
|
|
4336
4336
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4337
|
-
'''Specifies one or more sets of tags (key–value pairs) to associate with this
|
|
4337
|
+
'''Specifies one or more sets of tags (key–value pairs) to associate with this OpsWorks layer.
|
|
4338
4338
|
|
|
4339
4339
|
Use tags to manage your resources.
|
|
4340
4340
|
|
|
@@ -4491,29 +4491,29 @@ class CfnStack(
|
|
|
4491
4491
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
4492
4492
|
:param 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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`_ .
|
|
4493
4493
|
:param name: The stack name. Stack names can be a maximum of 64 characters.
|
|
4494
|
-
:param service_role_arn: The stack's IAM role, which allows
|
|
4495
|
-
:param agent_version: The default
|
|
4494
|
+
:param service_role_arn: The stack's IAM role, which allows 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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`_ .
|
|
4495
|
+
:param agent_version: The default OpsWorks Stacks agent version. You have the following options:. - Auto-update - Set this parameter to ``LATEST`` . 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. 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.
|
|
4496
4496
|
:param attributes: One or more user-defined key-value pairs to be added to the stack attributes.
|
|
4497
4497
|
:param chef_configuration: 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>`_ .
|
|
4498
|
-
:param clone_app_ids: If you're cloning an
|
|
4499
|
-
:param clone_permissions: If you're cloning an
|
|
4498
|
+
:param clone_app_ids: If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.
|
|
4499
|
+
:param clone_permissions: If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.
|
|
4500
4500
|
:param 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.
|
|
4501
4501
|
:param custom_cookbooks_source: Contains the information required to retrieve an app or cookbook from a repository. For more information, see `Adding Apps <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html>`_ or `Cookbooks and Recipes <https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html>`_ .
|
|
4502
4502
|
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html>`_ .
|
|
4503
4503
|
:param default_availability_zone: The stack's default Availability Zone, which must be in the specified region. For more information, see `Regions and Endpoints <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ . If you also specify a value for ``DefaultSubnetId`` , the subnet must be in the same zone. For more information, see the ``VpcId`` parameter description.
|
|
4504
|
-
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . 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 `
|
|
4504
|
+
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . 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 `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ .
|
|
4505
4505
|
:param 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 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device>`_ .
|
|
4506
|
-
:param default_ssh_key_name: A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name,
|
|
4506
|
+
:param default_ssh_key_name: A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html>`_ and `Managing SSH Access <https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html>`_ . You can override this setting by specifying a different key pair, or no key pair, when you `create an instance <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html>`_ .
|
|
4507
4507
|
:param 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.
|
|
4508
|
-
:param ecs_cluster_arn: The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the
|
|
4509
|
-
:param elastic_ips: A list of Elastic IP addresses to register with the
|
|
4508
|
+
:param ecs_cluster_arn: The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack. .. epigraph:: If you specify a cluster that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
|
|
4509
|
+
:param elastic_ips: A list of Elastic IP addresses to register with the OpsWorks stack. .. epigraph:: If you specify an IP address that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.
|
|
4510
4510
|
:param 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.
|
|
4511
|
-
:param rds_db_instances: The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the
|
|
4512
|
-
:param source_stack_id: If you're cloning an
|
|
4511
|
+
:param rds_db_instances: The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack. .. epigraph:: If you specify a database instance that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.
|
|
4512
|
+
:param source_stack_id: If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.
|
|
4513
4513
|
:param 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.
|
|
4514
4514
|
:param use_custom_cookbooks: Whether the stack uses custom cookbooks.
|
|
4515
|
-
:param use_opsworks_security_groups: Whether to associate the
|
|
4516
|
-
:param 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,
|
|
4515
|
+
:param use_opsworks_security_groups: Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. 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 - 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 - 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html>`_ .
|
|
4516
|
+
:param 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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see `Running a Stack in a VPC <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html>`_ . For more information about default VPC and EC2-Classic, see `Supported Platforms <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html>`_ .
|
|
4517
4517
|
'''
|
|
4518
4518
|
if __debug__:
|
|
4519
4519
|
type_hints = typing.get_type_hints(_typecheckingstub__6bf36f6bd552e246cec8163081581d4887e2e1838c2af0dfdfec5a94265183ed)
|
|
@@ -4627,7 +4627,7 @@ class CfnStack(
|
|
|
4627
4627
|
@builtins.property
|
|
4628
4628
|
@jsii.member(jsii_name="serviceRoleArn")
|
|
4629
4629
|
def service_role_arn(self) -> builtins.str:
|
|
4630
|
-
'''The stack's IAM role, which allows
|
|
4630
|
+
'''The stack's IAM role, which allows OpsWorks Stacks to work with AWS resources on your behalf.'''
|
|
4631
4631
|
return typing.cast(builtins.str, jsii.get(self, "serviceRoleArn"))
|
|
4632
4632
|
|
|
4633
4633
|
@service_role_arn.setter
|
|
@@ -4640,7 +4640,7 @@ class CfnStack(
|
|
|
4640
4640
|
@builtins.property
|
|
4641
4641
|
@jsii.member(jsii_name="agentVersion")
|
|
4642
4642
|
def agent_version(self) -> typing.Optional[builtins.str]:
|
|
4643
|
-
'''The default
|
|
4643
|
+
'''The default OpsWorks Stacks agent version.
|
|
4644
4644
|
|
|
4645
4645
|
You have the following options:.
|
|
4646
4646
|
'''
|
|
@@ -4692,7 +4692,7 @@ class CfnStack(
|
|
|
4692
4692
|
@builtins.property
|
|
4693
4693
|
@jsii.member(jsii_name="cloneAppIds")
|
|
4694
4694
|
def clone_app_ids(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4695
|
-
'''If you're cloning an
|
|
4695
|
+
'''If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.'''
|
|
4696
4696
|
return typing.cast(typing.Optional[typing.List[builtins.str]], jsii.get(self, "cloneAppIds"))
|
|
4697
4697
|
|
|
4698
4698
|
@clone_app_ids.setter
|
|
@@ -4707,7 +4707,7 @@ class CfnStack(
|
|
|
4707
4707
|
def clone_permissions(
|
|
4708
4708
|
self,
|
|
4709
4709
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4710
|
-
'''If you're cloning an
|
|
4710
|
+
'''If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.'''
|
|
4711
4711
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "clonePermissions"))
|
|
4712
4712
|
|
|
4713
4713
|
@clone_permissions.setter
|
|
@@ -4837,7 +4837,7 @@ class CfnStack(
|
|
|
4837
4837
|
@builtins.property
|
|
4838
4838
|
@jsii.member(jsii_name="ecsClusterArn")
|
|
4839
4839
|
def ecs_cluster_arn(self) -> typing.Optional[builtins.str]:
|
|
4840
|
-
'''The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the
|
|
4840
|
+
'''The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack.'''
|
|
4841
4841
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "ecsClusterArn"))
|
|
4842
4842
|
|
|
4843
4843
|
@ecs_cluster_arn.setter
|
|
@@ -4852,7 +4852,7 @@ class CfnStack(
|
|
|
4852
4852
|
def elastic_ips(
|
|
4853
4853
|
self,
|
|
4854
4854
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnStack.ElasticIpProperty"]]]]:
|
|
4855
|
-
'''A list of Elastic IP addresses to register with the
|
|
4855
|
+
'''A list of Elastic IP addresses to register with the OpsWorks stack.'''
|
|
4856
4856
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnStack.ElasticIpProperty"]]]], jsii.get(self, "elasticIps"))
|
|
4857
4857
|
|
|
4858
4858
|
@elastic_ips.setter
|
|
@@ -4883,7 +4883,7 @@ class CfnStack(
|
|
|
4883
4883
|
def rds_db_instances(
|
|
4884
4884
|
self,
|
|
4885
4885
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnStack.RdsDbInstanceProperty"]]]]:
|
|
4886
|
-
'''The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the
|
|
4886
|
+
'''The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack.'''
|
|
4887
4887
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, "CfnStack.RdsDbInstanceProperty"]]]], jsii.get(self, "rdsDbInstances"))
|
|
4888
4888
|
|
|
4889
4889
|
@rds_db_instances.setter
|
|
@@ -4899,7 +4899,7 @@ class CfnStack(
|
|
|
4899
4899
|
@builtins.property
|
|
4900
4900
|
@jsii.member(jsii_name="sourceStackId")
|
|
4901
4901
|
def source_stack_id(self) -> typing.Optional[builtins.str]:
|
|
4902
|
-
'''If you're cloning an
|
|
4902
|
+
'''If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.'''
|
|
4903
4903
|
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "sourceStackId"))
|
|
4904
4904
|
|
|
4905
4905
|
@source_stack_id.setter
|
|
@@ -4945,7 +4945,7 @@ class CfnStack(
|
|
|
4945
4945
|
def use_opsworks_security_groups(
|
|
4946
4946
|
self,
|
|
4947
4947
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4948
|
-
'''Whether to associate the
|
|
4948
|
+
'''Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.'''
|
|
4949
4949
|
return typing.cast(typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]], jsii.get(self, "useOpsworksSecurityGroups"))
|
|
4950
4950
|
|
|
4951
4951
|
@use_opsworks_security_groups.setter
|
|
@@ -5135,7 +5135,7 @@ class CfnStack(
|
|
|
5135
5135
|
rds_db_instance_arn: builtins.str,
|
|
5136
5136
|
) -> None:
|
|
5137
5137
|
'''
|
|
5138
|
-
:param db_password:
|
|
5138
|
+
:param db_password: OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
5139
5139
|
:param db_user: The master user name.
|
|
5140
5140
|
:param rds_db_instance_arn: The instance's ARN.
|
|
5141
5141
|
|
|
@@ -5167,7 +5167,7 @@ class CfnStack(
|
|
|
5167
5167
|
|
|
5168
5168
|
@builtins.property
|
|
5169
5169
|
def db_password(self) -> builtins.str:
|
|
5170
|
-
'''
|
|
5170
|
+
'''OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
5171
5171
|
|
|
5172
5172
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-rdsdbinstance.html#cfn-opsworks-stack-rdsdbinstance-dbpassword
|
|
5173
5173
|
'''
|
|
@@ -5230,9 +5230,9 @@ class CfnStack(
|
|
|
5230
5230
|
username: typing.Optional[builtins.str] = None,
|
|
5231
5231
|
) -> None:
|
|
5232
5232
|
'''
|
|
5233
|
-
:param password: When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set ``Password`` to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set ``Password`` to the password. For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ . In responses,
|
|
5234
|
-
:param revision: The application's version.
|
|
5235
|
-
:param ssh_key: The repository's SSH key. For more information, see `Using Git Repository SSH Keys <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html>`_ in the *
|
|
5233
|
+
:param password: When included in a request, the parameter depends on the repository type. - For Amazon S3 bundles, set ``Password`` to the appropriate IAM secret access key. - For HTTP bundles and Subversion repositories, set ``Password`` to the password. For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ . In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
5234
|
+
:param revision: The application's version. OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
|
|
5235
|
+
:param ssh_key: The repository's SSH key. For more information, see `Using Git Repository SSH Keys <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html>`_ in the *OpsWorks User Guide* . To pass in an SSH key as a parameter, see the following example: ``"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...``
|
|
5236
5236
|
:param type: The repository type.
|
|
5237
5237
|
:param url: The source URL. The following is an example of an Amazon S3 source URL: ``https://s3.amazonaws.com/opsworks-demo-bucket/opsworks_cookbook_demo.tar.gz`` .
|
|
5238
5238
|
:param username: This parameter depends on the repository type. - For Amazon S3 bundles, set ``Username`` to the appropriate IAM access key ID. - For HTTP bundles, Git repositories, and Subversion repositories, set ``Username`` to the user name.
|
|
@@ -5286,7 +5286,7 @@ class CfnStack(
|
|
|
5286
5286
|
|
|
5287
5287
|
For more information on how to safely handle IAM credentials, see ` <https://docs.aws.amazon.com/general/latest/gr/aws-access-keys-best-practices.html>`_ .
|
|
5288
5288
|
|
|
5289
|
-
In responses,
|
|
5289
|
+
In responses, OpsWorks Stacks returns ``*****FILTERED*****`` instead of the actual value.
|
|
5290
5290
|
|
|
5291
5291
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-password
|
|
5292
5292
|
'''
|
|
@@ -5297,7 +5297,7 @@ class CfnStack(
|
|
|
5297
5297
|
def revision(self) -> typing.Optional[builtins.str]:
|
|
5298
5298
|
'''The application's version.
|
|
5299
5299
|
|
|
5300
|
-
|
|
5300
|
+
OpsWorks Stacks enables you to easily deploy new versions of an application. One of the simplest approaches is to have branches or revisions in your repository that represent different versions that can potentially be deployed.
|
|
5301
5301
|
|
|
5302
5302
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-opsworks-stack-source.html#cfn-opsworks-stack-source-revision
|
|
5303
5303
|
'''
|
|
@@ -5308,7 +5308,7 @@ class CfnStack(
|
|
|
5308
5308
|
def ssh_key(self) -> typing.Optional[builtins.str]:
|
|
5309
5309
|
'''The repository's SSH key.
|
|
5310
5310
|
|
|
5311
|
-
For more information, see `Using Git Repository SSH Keys <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html>`_ in the *
|
|
5311
|
+
For more information, see `Using Git Repository SSH Keys <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-deploykeys.html>`_ in the *OpsWorks User Guide* . To pass in an SSH key as a parameter, see the following example:
|
|
5312
5312
|
|
|
5313
5313
|
``"Parameters" : { "GitSSHKey" : { "Description" : "Change SSH key newlines to commas.", "Type" : "CommaDelimitedList", "NoEcho" : "true" }, ... "CustomCookbooksSource": { "Revision" : { "Ref": "GitRevision"}, "SshKey" : { "Fn::Join" : [ "\\n", { "Ref": "GitSSHKey"} ] }, "Type": "git", "Url": { "Ref": "GitURL"} } ...``
|
|
5314
5314
|
|
|
@@ -5499,29 +5499,29 @@ class CfnStackProps:
|
|
|
5499
5499
|
|
|
5500
5500
|
:param 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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`_ .
|
|
5501
5501
|
:param name: The stack name. Stack names can be a maximum of 64 characters.
|
|
5502
|
-
:param service_role_arn: The stack's IAM role, which allows
|
|
5503
|
-
:param agent_version: The default
|
|
5502
|
+
:param service_role_arn: The stack's IAM role, which allows 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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`_ .
|
|
5503
|
+
:param agent_version: The default OpsWorks Stacks agent version. You have the following options:. - Auto-update - Set this parameter to ``LATEST`` . 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. 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.
|
|
5504
5504
|
:param attributes: One or more user-defined key-value pairs to be added to the stack attributes.
|
|
5505
5505
|
:param chef_configuration: 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>`_ .
|
|
5506
|
-
:param clone_app_ids: If you're cloning an
|
|
5507
|
-
:param clone_permissions: If you're cloning an
|
|
5506
|
+
:param clone_app_ids: If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.
|
|
5507
|
+
:param clone_permissions: If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.
|
|
5508
5508
|
:param 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.
|
|
5509
5509
|
:param custom_cookbooks_source: Contains the information required to retrieve an app or cookbook from a repository. For more information, see `Adding Apps <https://docs.aws.amazon.com/opsworks/latest/userguide/workingapps-creating.html>`_ or `Cookbooks and Recipes <https://docs.aws.amazon.com/opsworks/latest/userguide/workingcookbook.html>`_ .
|
|
5510
5510
|
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-json.html>`_ .
|
|
5511
5511
|
:param default_availability_zone: The stack's default Availability Zone, which must be in the specified region. For more information, see `Regions and Endpoints <https://docs.aws.amazon.com/general/latest/gr/rande.html>`_ . If you also specify a value for ``DefaultSubnetId`` , the subnet must be in the same zone. For more information, see the ``VpcId`` parameter description.
|
|
5512
|
-
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . 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 `
|
|
5512
|
+
:param 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ . 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 `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ .
|
|
5513
5513
|
:param 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 <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ComponentsAMIs.html#storage-for-the-root-device>`_ .
|
|
5514
|
-
:param default_ssh_key_name: A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name,
|
|
5514
|
+
:param default_ssh_key_name: A default Amazon EC2 key pair name. The default value is none. If you specify a key pair name, 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html>`_ and `Managing SSH Access <https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html>`_ . You can override this setting by specifying a different key pair, or no key pair, when you `create an instance <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html>`_ .
|
|
5515
5515
|
:param 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.
|
|
5516
|
-
:param ecs_cluster_arn: The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the
|
|
5517
|
-
:param elastic_ips: A list of Elastic IP addresses to register with the
|
|
5516
|
+
:param ecs_cluster_arn: The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack. .. epigraph:: If you specify a cluster that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
|
|
5517
|
+
:param elastic_ips: A list of Elastic IP addresses to register with the OpsWorks stack. .. epigraph:: If you specify an IP address that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.
|
|
5518
5518
|
:param 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.
|
|
5519
|
-
:param rds_db_instances: The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the
|
|
5520
|
-
:param source_stack_id: If you're cloning an
|
|
5519
|
+
:param rds_db_instances: The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack. .. epigraph:: If you specify a database instance that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.
|
|
5520
|
+
:param source_stack_id: If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.
|
|
5521
5521
|
:param 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.
|
|
5522
5522
|
:param use_custom_cookbooks: Whether the stack uses custom cookbooks.
|
|
5523
|
-
:param use_opsworks_security_groups: Whether to associate the
|
|
5524
|
-
:param 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,
|
|
5523
|
+
:param use_opsworks_security_groups: Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers. 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 - 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 - 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html>`_ .
|
|
5524
|
+
:param 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, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, 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 OpsWorks Stacks with a VPC, see `Running a Stack in a VPC <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html>`_ . For more information about default VPC and EC2-Classic, see `Supported Platforms <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html>`_ .
|
|
5525
5525
|
|
|
5526
5526
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html
|
|
5527
5527
|
:exampleMetadata: fixture=_generated
|
|
@@ -5694,7 +5694,7 @@ class CfnStackProps:
|
|
|
5694
5694
|
|
|
5695
5695
|
@builtins.property
|
|
5696
5696
|
def service_role_arn(self) -> builtins.str:
|
|
5697
|
-
'''The stack's IAM role, which allows
|
|
5697
|
+
'''The stack's IAM role, which allows OpsWorks Stacks to work with AWS resources on your behalf.
|
|
5698
5698
|
|
|
5699
5699
|
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 <https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html>`_ .
|
|
5700
5700
|
|
|
@@ -5706,10 +5706,10 @@ class CfnStackProps:
|
|
|
5706
5706
|
|
|
5707
5707
|
@builtins.property
|
|
5708
5708
|
def agent_version(self) -> typing.Optional[builtins.str]:
|
|
5709
|
-
'''The default
|
|
5709
|
+
'''The default OpsWorks Stacks agent version. You have the following options:.
|
|
5710
5710
|
|
|
5711
|
-
- Auto-update - Set this parameter to ``LATEST`` .
|
|
5712
|
-
- 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.
|
|
5711
|
+
- Auto-update - Set this parameter to ``LATEST`` . OpsWorks Stacks automatically installs new agent versions on the stack's instances as soon as they are available.
|
|
5712
|
+
- 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. OpsWorks Stacks installs that version on the stack's instances.
|
|
5713
5713
|
|
|
5714
5714
|
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.
|
|
5715
5715
|
.. epigraph::
|
|
@@ -5745,7 +5745,7 @@ class CfnStackProps:
|
|
|
5745
5745
|
|
|
5746
5746
|
@builtins.property
|
|
5747
5747
|
def clone_app_ids(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
5748
|
-
'''If you're cloning an
|
|
5748
|
+
'''If you're cloning an OpsWorks stack, a list of OpsWorks application stack IDs from the source stack to include in the cloned stack.
|
|
5749
5749
|
|
|
5750
5750
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-cloneappids
|
|
5751
5751
|
'''
|
|
@@ -5756,7 +5756,7 @@ class CfnStackProps:
|
|
|
5756
5756
|
def clone_permissions(
|
|
5757
5757
|
self,
|
|
5758
5758
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5759
|
-
'''If you're cloning an
|
|
5759
|
+
'''If you're cloning an OpsWorks stack, indicates whether to clone the source stack's permissions.
|
|
5760
5760
|
|
|
5761
5761
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-clonepermissions
|
|
5762
5762
|
'''
|
|
@@ -5828,7 +5828,7 @@ class CfnStackProps:
|
|
|
5828
5828
|
- 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`` .
|
|
5829
5829
|
- A custom AMI: ``Custom`` . You specify the custom AMI you want to use when you create instances. For more information, see `Using Custom AMIs <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-custom-ami.html>`_ .
|
|
5830
5830
|
|
|
5831
|
-
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 `
|
|
5831
|
+
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 `OpsWorks Stacks Operating Systems <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-os.html>`_ .
|
|
5832
5832
|
|
|
5833
5833
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultos
|
|
5834
5834
|
'''
|
|
@@ -5850,7 +5850,7 @@ class CfnStackProps:
|
|
|
5850
5850
|
def default_ssh_key_name(self) -> typing.Optional[builtins.str]:
|
|
5851
5851
|
'''A default Amazon EC2 key pair name.
|
|
5852
5852
|
|
|
5853
|
-
The default value is none. If you specify a key pair name,
|
|
5853
|
+
The default value is none. If you specify a key pair name, 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 <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-ssh.html>`_ and `Managing SSH Access <https://docs.aws.amazon.com/opsworks/latest/userguide/security-ssh-access.html>`_ . You can override this setting by specifying a different key pair, or no key pair, when you `create an instance <https://docs.aws.amazon.com/opsworks/latest/userguide/workinginstances-add.html>`_ .
|
|
5854
5854
|
|
|
5855
5855
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-defaultsshkeyname
|
|
5856
5856
|
'''
|
|
@@ -5870,11 +5870,11 @@ class CfnStackProps:
|
|
|
5870
5870
|
|
|
5871
5871
|
@builtins.property
|
|
5872
5872
|
def ecs_cluster_arn(self) -> typing.Optional[builtins.str]:
|
|
5873
|
-
'''The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the
|
|
5873
|
+
'''The Amazon Resource Name (ARN) of the Amazon Elastic Container Service ( Amazon ECS ) cluster to register with the OpsWorks stack.
|
|
5874
5874
|
|
|
5875
5875
|
.. epigraph::
|
|
5876
5876
|
|
|
5877
|
-
If you specify a cluster that's registered with another
|
|
5877
|
+
If you specify a cluster that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the cluster.
|
|
5878
5878
|
|
|
5879
5879
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-ecsclusterarn
|
|
5880
5880
|
'''
|
|
@@ -5885,11 +5885,11 @@ class CfnStackProps:
|
|
|
5885
5885
|
def elastic_ips(
|
|
5886
5886
|
self,
|
|
5887
5887
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnStack.ElasticIpProperty]]]]:
|
|
5888
|
-
'''A list of Elastic IP addresses to register with the
|
|
5888
|
+
'''A list of Elastic IP addresses to register with the OpsWorks stack.
|
|
5889
5889
|
|
|
5890
5890
|
.. epigraph::
|
|
5891
5891
|
|
|
5892
|
-
If you specify an IP address that's registered with another
|
|
5892
|
+
If you specify an IP address that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the IP address.
|
|
5893
5893
|
|
|
5894
5894
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-elasticips
|
|
5895
5895
|
'''
|
|
@@ -5925,11 +5925,11 @@ class CfnStackProps:
|
|
|
5925
5925
|
def rds_db_instances(
|
|
5926
5926
|
self,
|
|
5927
5927
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, typing.List[typing.Union[_IResolvable_da3f097b, CfnStack.RdsDbInstanceProperty]]]]:
|
|
5928
|
-
'''The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the
|
|
5928
|
+
'''The Amazon Relational Database Service ( Amazon RDS ) database instance to register with the OpsWorks stack.
|
|
5929
5929
|
|
|
5930
5930
|
.. epigraph::
|
|
5931
5931
|
|
|
5932
|
-
If you specify a database instance that's registered with another
|
|
5932
|
+
If you specify a database instance that's registered with another OpsWorks stack, AWS CloudFormation deregisters the existing association before registering the database instance.
|
|
5933
5933
|
|
|
5934
5934
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-rdsdbinstances
|
|
5935
5935
|
'''
|
|
@@ -5938,7 +5938,7 @@ class CfnStackProps:
|
|
|
5938
5938
|
|
|
5939
5939
|
@builtins.property
|
|
5940
5940
|
def source_stack_id(self) -> typing.Optional[builtins.str]:
|
|
5941
|
-
'''If you're cloning an
|
|
5941
|
+
'''If you're cloning an OpsWorks stack, the stack ID of the source OpsWorks stack to clone.
|
|
5942
5942
|
|
|
5943
5943
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-sourcestackid
|
|
5944
5944
|
'''
|
|
@@ -5975,12 +5975,12 @@ class CfnStackProps:
|
|
|
5975
5975
|
def use_opsworks_security_groups(
|
|
5976
5976
|
self,
|
|
5977
5977
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
5978
|
-
'''Whether to associate the
|
|
5978
|
+
'''Whether to associate the OpsWorks Stacks built-in security groups with the stack's layers.
|
|
5979
5979
|
|
|
5980
|
-
|
|
5980
|
+
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:
|
|
5981
5981
|
|
|
5982
|
-
- True -
|
|
5983
|
-
- False -
|
|
5982
|
+
- True - 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.
|
|
5983
|
+
- False - 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.
|
|
5984
5984
|
|
|
5985
5985
|
For more information, see `Create a New Stack <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-creating.html>`_ .
|
|
5986
5986
|
|
|
@@ -5998,14 +5998,14 @@ class CfnStackProps:
|
|
|
5998
5998
|
- If your account supports EC2-Classic, the default value is ``no VPC`` .
|
|
5999
5999
|
- If your account does not support EC2-Classic, the default value is the default VPC for the specified region.
|
|
6000
6000
|
|
|
6001
|
-
If the VPC ID corresponds to a default VPC and you have specified either the ``DefaultAvailabilityZone`` or the ``DefaultSubnetId`` parameter only,
|
|
6001
|
+
If the VPC ID corresponds to a default VPC and you have specified either the ``DefaultAvailabilityZone`` or the ``DefaultSubnetId`` parameter only, OpsWorks Stacks infers the value of the other parameter. If you specify neither parameter, OpsWorks Stacks sets these parameters to the first valid Availability Zone for the specified region and the corresponding default VPC subnet ID, respectively.
|
|
6002
6002
|
|
|
6003
6003
|
If you specify a nondefault VPC ID, note the following:
|
|
6004
6004
|
|
|
6005
6005
|
- It must belong to a VPC in your account that is in the specified region.
|
|
6006
6006
|
- You must specify a value for ``DefaultSubnetId`` .
|
|
6007
6007
|
|
|
6008
|
-
For more information about how to use
|
|
6008
|
+
For more information about how to use OpsWorks Stacks with a VPC, see `Running a Stack in a VPC <https://docs.aws.amazon.com/opsworks/latest/userguide/workingstacks-vpc.html>`_ . For more information about default VPC and EC2-Classic, see `Supported Platforms <https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-supported-platforms.html>`_ .
|
|
6009
6009
|
|
|
6010
6010
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-opsworks-stack.html#cfn-opsworks-stack-vpcid
|
|
6011
6011
|
'''
|