aws-cdk-lib 2.105.0__py3-none-any.whl → 2.106.1__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 +59 -69
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.105.0.jsii.tgz → aws-cdk-lib@2.106.1.jsii.tgz} +0 -0
- aws_cdk/aws_amplify/__init__.py +12 -12
- aws_cdk/aws_appconfig/__init__.py +25 -11
- aws_cdk/aws_appintegrations/__init__.py +60 -60
- aws_cdk/aws_apprunner/__init__.py +22 -3
- aws_cdk/aws_appstream/__init__.py +12 -5
- aws_cdk/aws_appsync/__init__.py +4 -4
- aws_cdk/aws_autoscaling/__init__.py +8 -0
- aws_cdk/aws_cloudformation/__init__.py +59 -69
- aws_cdk/aws_codepipeline/__init__.py +3 -0
- aws_cdk/aws_cognito/__init__.py +23 -31
- aws_cdk/aws_config/__init__.py +46 -41
- aws_cdk/aws_datapipeline/__init__.py +54 -54
- aws_cdk/aws_directoryservice/__init__.py +45 -45
- aws_cdk/aws_ec2/__init__.py +163 -21
- aws_cdk/aws_ecs/__init__.py +52 -68
- aws_cdk/aws_eks/__init__.py +55 -9
- aws_cdk/aws_entityresolution/__init__.py +9 -0
- aws_cdk/aws_events/__init__.py +0 -8
- aws_cdk/aws_eventschemas/__init__.py +12 -12
- aws_cdk/aws_gamelift/__init__.py +4 -6
- aws_cdk/aws_internetmonitor/__init__.py +12 -10
- aws_cdk/aws_iot/__init__.py +10 -11
- aws_cdk/aws_lakeformation/__init__.py +8 -5
- aws_cdk/aws_lambda/__init__.py +30 -0
- aws_cdk/aws_msk/__init__.py +3 -3
- aws_cdk/aws_networkmanager/__init__.py +1 -1
- aws_cdk/aws_pinpoint/__init__.py +94 -94
- aws_cdk/aws_quicksight/__init__.py +189 -264
- aws_cdk/aws_rds/__init__.py +267 -36
- aws_cdk/aws_rolesanywhere/__init__.py +53 -41
- aws_cdk/aws_route53/__init__.py +3 -7
- aws_cdk/aws_s3/__init__.py +191 -2
- aws_cdk/aws_sam/__init__.py +42 -47
- aws_cdk/aws_servicecatalogappregistry/__init__.py +2 -4
- aws_cdk/aws_ssm/__init__.py +4 -4
- aws_cdk/aws_stepfunctions_tasks/__init__.py +9 -2
- aws_cdk/aws_vpclattice/__init__.py +2 -6
- aws_cdk/aws_wafv2/__init__.py +21 -8
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/METADATA +3 -3
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/RECORD +47 -47
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.105.0.dist-info → aws_cdk_lib-2.106.1.dist-info}/top_level.txt +0 -0
|
@@ -3254,9 +3254,6 @@ class CfnStack(
|
|
|
3254
3254
|
from aws_cdk import aws_cloudformation as cloudformation
|
|
3255
3255
|
|
|
3256
3256
|
cfn_stack = cloudformation.CfnStack(self, "MyCfnStack",
|
|
3257
|
-
template_url="templateUrl",
|
|
3258
|
-
|
|
3259
|
-
# the properties below are optional
|
|
3260
3257
|
notification_arns=["notificationArns"],
|
|
3261
3258
|
parameters={
|
|
3262
3259
|
"parameters_key": "parameters"
|
|
@@ -3265,6 +3262,7 @@ class CfnStack(
|
|
|
3265
3262
|
key="key",
|
|
3266
3263
|
value="value"
|
|
3267
3264
|
)],
|
|
3265
|
+
template_url="templateUrl",
|
|
3268
3266
|
timeout_in_minutes=123
|
|
3269
3267
|
)
|
|
3270
3268
|
'''
|
|
@@ -3274,19 +3272,19 @@ class CfnStack(
|
|
|
3274
3272
|
scope: _constructs_77d1e7e8.Construct,
|
|
3275
3273
|
id: builtins.str,
|
|
3276
3274
|
*,
|
|
3277
|
-
template_url: builtins.str,
|
|
3278
3275
|
notification_arns: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
3279
3276
|
parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
|
|
3280
3277
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3278
|
+
template_url: typing.Optional[builtins.str] = None,
|
|
3281
3279
|
timeout_in_minutes: typing.Optional[jsii.Number] = None,
|
|
3282
3280
|
) -> None:
|
|
3283
3281
|
'''
|
|
3284
3282
|
:param scope: Scope in which this resource is defined.
|
|
3285
3283
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
3286
|
-
:param template_url: Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3287
3284
|
:param notification_arns: The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
|
|
3288
3285
|
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks. Conditional. Required if the nested stack requires input parameters. Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3289
3286
|
:param tags: Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
|
|
3287
|
+
:param template_url: Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3290
3288
|
:param timeout_in_minutes: The length of time, in minutes, that CloudFormation waits for the nested stack to reach the ``CREATE_COMPLETE`` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the ``CREATE_COMPLETE`` state, it marks the nested stack resource as ``CREATE_COMPLETE`` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches ``CREATE_COMPLETE`` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. Updates aren't supported.
|
|
3291
3289
|
'''
|
|
3292
3290
|
if __debug__:
|
|
@@ -3294,10 +3292,10 @@ class CfnStack(
|
|
|
3294
3292
|
check_type(argname="argument scope", value=scope, expected_type=type_hints["scope"])
|
|
3295
3293
|
check_type(argname="argument id", value=id, expected_type=type_hints["id"])
|
|
3296
3294
|
props = CfnStackProps(
|
|
3297
|
-
template_url=template_url,
|
|
3298
3295
|
notification_arns=notification_arns,
|
|
3299
3296
|
parameters=parameters,
|
|
3300
3297
|
tags=tags,
|
|
3298
|
+
template_url=template_url,
|
|
3301
3299
|
timeout_in_minutes=timeout_in_minutes,
|
|
3302
3300
|
)
|
|
3303
3301
|
|
|
@@ -3424,19 +3422,6 @@ class CfnStack(
|
|
|
3424
3422
|
'''Tag Manager which manages the tags for this resource.'''
|
|
3425
3423
|
return typing.cast(_TagManager_0a598cb3, jsii.get(self, "tags"))
|
|
3426
3424
|
|
|
3427
|
-
@builtins.property
|
|
3428
|
-
@jsii.member(jsii_name="templateUrl")
|
|
3429
|
-
def template_url(self) -> builtins.str:
|
|
3430
|
-
'''Location of file containing the template body.'''
|
|
3431
|
-
return typing.cast(builtins.str, jsii.get(self, "templateUrl"))
|
|
3432
|
-
|
|
3433
|
-
@template_url.setter
|
|
3434
|
-
def template_url(self, value: builtins.str) -> None:
|
|
3435
|
-
if __debug__:
|
|
3436
|
-
type_hints = typing.get_type_hints(_typecheckingstub__3db469b6ac2b6930a53773a7067f28dcbe494d1c4c0aa67dc9ab276d28d07904)
|
|
3437
|
-
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
3438
|
-
jsii.set(self, "templateUrl", value)
|
|
3439
|
-
|
|
3440
3425
|
@builtins.property
|
|
3441
3426
|
@jsii.member(jsii_name="notificationArns")
|
|
3442
3427
|
def notification_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
@@ -3484,6 +3469,19 @@ class CfnStack(
|
|
|
3484
3469
|
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
3485
3470
|
jsii.set(self, "tagsRaw", value)
|
|
3486
3471
|
|
|
3472
|
+
@builtins.property
|
|
3473
|
+
@jsii.member(jsii_name="templateUrl")
|
|
3474
|
+
def template_url(self) -> typing.Optional[builtins.str]:
|
|
3475
|
+
'''Location of file containing the template body.'''
|
|
3476
|
+
return typing.cast(typing.Optional[builtins.str], jsii.get(self, "templateUrl"))
|
|
3477
|
+
|
|
3478
|
+
@template_url.setter
|
|
3479
|
+
def template_url(self, value: typing.Optional[builtins.str]) -> None:
|
|
3480
|
+
if __debug__:
|
|
3481
|
+
type_hints = typing.get_type_hints(_typecheckingstub__3db469b6ac2b6930a53773a7067f28dcbe494d1c4c0aa67dc9ab276d28d07904)
|
|
3482
|
+
check_type(argname="argument value", value=value, expected_type=type_hints["value"])
|
|
3483
|
+
jsii.set(self, "templateUrl", value)
|
|
3484
|
+
|
|
3487
3485
|
@builtins.property
|
|
3488
3486
|
@jsii.member(jsii_name="timeoutInMinutes")
|
|
3489
3487
|
def timeout_in_minutes(self) -> typing.Optional[jsii.Number]:
|
|
@@ -3607,10 +3605,10 @@ class CfnStack(
|
|
|
3607
3605
|
jsii_type="aws-cdk-lib.aws_cloudformation.CfnStackProps",
|
|
3608
3606
|
jsii_struct_bases=[],
|
|
3609
3607
|
name_mapping={
|
|
3610
|
-
"template_url": "templateUrl",
|
|
3611
3608
|
"notification_arns": "notificationArns",
|
|
3612
3609
|
"parameters": "parameters",
|
|
3613
3610
|
"tags": "tags",
|
|
3611
|
+
"template_url": "templateUrl",
|
|
3614
3612
|
"timeout_in_minutes": "timeoutInMinutes",
|
|
3615
3613
|
},
|
|
3616
3614
|
)
|
|
@@ -3618,18 +3616,18 @@ class CfnStackProps:
|
|
|
3618
3616
|
def __init__(
|
|
3619
3617
|
self,
|
|
3620
3618
|
*,
|
|
3621
|
-
template_url: builtins.str,
|
|
3622
3619
|
notification_arns: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
3623
3620
|
parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
|
|
3624
3621
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
3622
|
+
template_url: typing.Optional[builtins.str] = None,
|
|
3625
3623
|
timeout_in_minutes: typing.Optional[jsii.Number] = None,
|
|
3626
3624
|
) -> None:
|
|
3627
3625
|
'''Properties for defining a ``CfnStack``.
|
|
3628
3626
|
|
|
3629
|
-
:param template_url: Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3630
3627
|
:param notification_arns: The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events. You can find your Amazon SNS topic ARNs using the Amazon SNS console or your Command Line Interface (CLI).
|
|
3631
3628
|
:param parameters: The set value pairs that represent the parameters passed to CloudFormation when this nested stack is created. Each parameter has a name corresponding to a parameter defined in the embedded template and a value representing the value that you want to set for the parameter. .. epigraph:: If you use the ``Ref`` function to pass a parameter value to a nested stack, comma-delimited list parameters must be of type ``String`` . In other words, you can't pass values that are of type ``CommaDelimitedList`` to nested stacks. Conditional. Required if the nested stack requires input parameters. Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3632
3629
|
:param tags: Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to the resources created in the stack. A maximum number of 50 tags can be specified.
|
|
3630
|
+
:param template_url: Location of file containing the template body. The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ . Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3633
3631
|
:param timeout_in_minutes: The length of time, in minutes, that CloudFormation waits for the nested stack to reach the ``CREATE_COMPLETE`` state. The default is no timeout. When CloudFormation detects that the nested stack has reached the ``CREATE_COMPLETE`` state, it marks the nested stack resource as ``CREATE_COMPLETE`` in the parent stack and resumes creating the parent stack. If the timeout period expires before the nested stack reaches ``CREATE_COMPLETE`` , CloudFormation marks the nested stack as failed and rolls back both the nested stack and parent stack. Updates aren't supported.
|
|
3634
3632
|
|
|
3635
3633
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html
|
|
@@ -3642,9 +3640,6 @@ class CfnStackProps:
|
|
|
3642
3640
|
from aws_cdk import aws_cloudformation as cloudformation
|
|
3643
3641
|
|
|
3644
3642
|
cfn_stack_props = cloudformation.CfnStackProps(
|
|
3645
|
-
template_url="templateUrl",
|
|
3646
|
-
|
|
3647
|
-
# the properties below are optional
|
|
3648
3643
|
notification_arns=["notificationArns"],
|
|
3649
3644
|
parameters={
|
|
3650
3645
|
"parameters_key": "parameters"
|
|
@@ -3653,42 +3648,29 @@ class CfnStackProps:
|
|
|
3653
3648
|
key="key",
|
|
3654
3649
|
value="value"
|
|
3655
3650
|
)],
|
|
3651
|
+
template_url="templateUrl",
|
|
3656
3652
|
timeout_in_minutes=123
|
|
3657
3653
|
)
|
|
3658
3654
|
'''
|
|
3659
3655
|
if __debug__:
|
|
3660
3656
|
type_hints = typing.get_type_hints(_typecheckingstub__4da59ffe076e92fe1011ac29ca869d93a69d1442f3b7a0d1c765cca951d09b20)
|
|
3661
|
-
check_type(argname="argument template_url", value=template_url, expected_type=type_hints["template_url"])
|
|
3662
3657
|
check_type(argname="argument notification_arns", value=notification_arns, expected_type=type_hints["notification_arns"])
|
|
3663
3658
|
check_type(argname="argument parameters", value=parameters, expected_type=type_hints["parameters"])
|
|
3664
3659
|
check_type(argname="argument tags", value=tags, expected_type=type_hints["tags"])
|
|
3660
|
+
check_type(argname="argument template_url", value=template_url, expected_type=type_hints["template_url"])
|
|
3665
3661
|
check_type(argname="argument timeout_in_minutes", value=timeout_in_minutes, expected_type=type_hints["timeout_in_minutes"])
|
|
3666
|
-
self._values: typing.Dict[builtins.str, typing.Any] = {
|
|
3667
|
-
"template_url": template_url,
|
|
3668
|
-
}
|
|
3662
|
+
self._values: typing.Dict[builtins.str, typing.Any] = {}
|
|
3669
3663
|
if notification_arns is not None:
|
|
3670
3664
|
self._values["notification_arns"] = notification_arns
|
|
3671
3665
|
if parameters is not None:
|
|
3672
3666
|
self._values["parameters"] = parameters
|
|
3673
3667
|
if tags is not None:
|
|
3674
3668
|
self._values["tags"] = tags
|
|
3669
|
+
if template_url is not None:
|
|
3670
|
+
self._values["template_url"] = template_url
|
|
3675
3671
|
if timeout_in_minutes is not None:
|
|
3676
3672
|
self._values["timeout_in_minutes"] = timeout_in_minutes
|
|
3677
3673
|
|
|
3678
|
-
@builtins.property
|
|
3679
|
-
def template_url(self) -> builtins.str:
|
|
3680
|
-
'''Location of file containing the template body.
|
|
3681
|
-
|
|
3682
|
-
The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ .
|
|
3683
|
-
|
|
3684
|
-
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3685
|
-
|
|
3686
|
-
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-templateurl
|
|
3687
|
-
'''
|
|
3688
|
-
result = self._values.get("template_url")
|
|
3689
|
-
assert result is not None, "Required property 'template_url' is missing"
|
|
3690
|
-
return typing.cast(builtins.str, result)
|
|
3691
|
-
|
|
3692
3674
|
@builtins.property
|
|
3693
3675
|
def notification_arns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
3694
3676
|
'''The Amazon Simple Notification Service (Amazon SNS) topic ARNs to publish stack related events.
|
|
@@ -3731,6 +3713,19 @@ class CfnStackProps:
|
|
|
3731
3713
|
result = self._values.get("tags")
|
|
3732
3714
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], result)
|
|
3733
3715
|
|
|
3716
|
+
@builtins.property
|
|
3717
|
+
def template_url(self) -> typing.Optional[builtins.str]:
|
|
3718
|
+
'''Location of file containing the template body.
|
|
3719
|
+
|
|
3720
|
+
The URL must point to a template (max size: 460,800 bytes) that's located in an Amazon S3 bucket. For more information, see `Template anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ .
|
|
3721
|
+
|
|
3722
|
+
Whether an update causes interruptions depends on the resources that are being updated. An update never causes a nested stack to be replaced.
|
|
3723
|
+
|
|
3724
|
+
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stack.html#cfn-cloudformation-stack-templateurl
|
|
3725
|
+
'''
|
|
3726
|
+
result = self._values.get("template_url")
|
|
3727
|
+
return typing.cast(typing.Optional[builtins.str], result)
|
|
3728
|
+
|
|
3734
3729
|
@builtins.property
|
|
3735
3730
|
def timeout_in_minutes(self) -> typing.Optional[jsii.Number]:
|
|
3736
3731
|
'''The length of time, in minutes, that CloudFormation waits for the nested stack to reach the ``CREATE_COMPLETE`` state.
|
|
@@ -3857,7 +3852,7 @@ class CfnStackSet(
|
|
|
3857
3852
|
:param scope: Scope in which this resource is defined.
|
|
3858
3853
|
:param id: Construct identifier for this resource (unique in its scope).
|
|
3859
3854
|
:param permission_model: Describes how the IAM roles required for stack set operations are created. - With ``SELF_MANAGED`` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see `Grant Self-Managed Stack Set Permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ . - With ``SERVICE_MANAGED`` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations .
|
|
3860
|
-
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
3855
|
+
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set. .. epigraph:: The ``StackSetName`` property is required.
|
|
3861
3856
|
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Prerequisites: Granting Permissions for Stack Set Operations <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html>`_ in the *AWS CloudFormation User Guide* . *Minimum* : ``20`` *Maximum* : ``2048``
|
|
3862
3857
|
:param auto_deployment: [ ``Service-managed`` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
|
|
3863
3858
|
:param call_as: [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, ``SELF`` is specified. Use ``SELF`` for stack sets with self-managed permissions. - To create a stack set with service-managed permissions while signed in to the management account, specify ``SELF`` . - To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify ``DELEGATED_ADMIN`` . Your AWS account must be registered as a delegated admin in the management account. For more information, see `Register a delegated administrator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html>`_ in the *AWS CloudFormation User Guide* . Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. *Valid Values* : ``SELF`` | ``DELEGATED_ADMIN``
|
|
@@ -3868,8 +3863,8 @@ class CfnStackSet(
|
|
|
3868
3863
|
:param operation_preferences: The user-specified preferences for how AWS CloudFormation performs a stack set operation.
|
|
3869
3864
|
:param parameters: The input parameters for the stack set template.
|
|
3870
3865
|
:param stack_instances_group: A group of stack instances with parameters in some specific accounts and Regions.
|
|
3871
|
-
:param tags:
|
|
3872
|
-
:param template_body: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. You must include either ``TemplateURL`` or ``TemplateBody`` in a StackSet, but you can't use both. Dynamic references in the ``TemplateBody`` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through ``TemplateUrl`` instead.
|
|
3866
|
+
:param tags: Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
|
|
3867
|
+
:param template_body: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. You must include either ``TemplateURL`` or ``TemplateBody`` in a StackSet, but you can't use both. Dynamic references in the ``TemplateBody`` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through ``TemplateUrl`` instead.
|
|
3873
3868
|
:param template_url: Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to `Template Anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: ``TemplateBody`` , ``TemplateURL`` .
|
|
3874
3869
|
'''
|
|
3875
3870
|
if __debug__:
|
|
@@ -4125,7 +4120,7 @@ class CfnStackSet(
|
|
|
4125
4120
|
@builtins.property
|
|
4126
4121
|
@jsii.member(jsii_name="tagsRaw")
|
|
4127
4122
|
def tags_raw(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
4128
|
-
'''
|
|
4123
|
+
'''Key-value pairs to associate with this stack.'''
|
|
4129
4124
|
return typing.cast(typing.Optional[typing.List[_CfnTag_f6864754]], jsii.get(self, "tagsRaw"))
|
|
4130
4125
|
|
|
4131
4126
|
@tags_raw.setter
|
|
@@ -4813,7 +4808,7 @@ class CfnStackSetProps:
|
|
|
4813
4808
|
'''Properties for defining a ``CfnStackSet``.
|
|
4814
4809
|
|
|
4815
4810
|
:param permission_model: Describes how the IAM roles required for stack set operations are created. - With ``SELF_MANAGED`` permissions, you must create the administrator and execution roles required to deploy to target accounts. For more information, see `Grant Self-Managed Stack Set Permissions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs-self-managed.html>`_ . - With ``SERVICE_MANAGED`` permissions, StackSets automatically creates the IAM roles required to deploy to accounts managed by AWS Organizations .
|
|
4816
|
-
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set.
|
|
4811
|
+
:param stack_set_name: The name to associate with the stack set. The name must be unique in the Region where you create your stack set. .. epigraph:: The ``StackSetName`` property is required.
|
|
4817
4812
|
:param administration_role_arn: The Amazon Resource Number (ARN) of the IAM role to use to create this stack set. Specify an IAM role only if you are using customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. Use customized administrator roles to control which users or groups can manage specific stack sets within the same administrator account. For more information, see `Prerequisites: Granting Permissions for Stack Set Operations <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-prereqs.html>`_ in the *AWS CloudFormation User Guide* . *Minimum* : ``20`` *Maximum* : ``2048``
|
|
4818
4813
|
:param auto_deployment: [ ``Service-managed`` permissions] Describes whether StackSets automatically deploys to AWS Organizations accounts that are added to a target organization or organizational unit (OU).
|
|
4819
4814
|
:param call_as: [Service-managed permissions] Specifies whether you are acting as an account administrator in the organization's management account or as a delegated administrator in a member account. By default, ``SELF`` is specified. Use ``SELF`` for stack sets with self-managed permissions. - To create a stack set with service-managed permissions while signed in to the management account, specify ``SELF`` . - To create a stack set with service-managed permissions while signed in to a delegated administrator account, specify ``DELEGATED_ADMIN`` . Your AWS account must be registered as a delegated admin in the management account. For more information, see `Register a delegated administrator <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/stacksets-orgs-delegated-admin.html>`_ in the *AWS CloudFormation User Guide* . Stack sets with service-managed permissions are created in the management account, including stack sets that are created by delegated administrators. *Valid Values* : ``SELF`` | ``DELEGATED_ADMIN``
|
|
@@ -4824,8 +4819,8 @@ class CfnStackSetProps:
|
|
|
4824
4819
|
:param operation_preferences: The user-specified preferences for how AWS CloudFormation performs a stack set operation.
|
|
4825
4820
|
:param parameters: The input parameters for the stack set template.
|
|
4826
4821
|
:param stack_instances_group: A group of stack instances with parameters in some specific accounts and Regions.
|
|
4827
|
-
:param tags:
|
|
4828
|
-
:param template_body: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. You must include either ``TemplateURL`` or ``TemplateBody`` in a StackSet, but you can't use both. Dynamic references in the ``TemplateBody`` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through ``TemplateUrl`` instead.
|
|
4822
|
+
:param tags: Key-value pairs to associate with this stack. AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags. If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
|
|
4823
|
+
:param template_body: The structure that contains the template body, with a minimum length of 1 byte and a maximum length of 51,200 bytes. You must include either ``TemplateURL`` or ``TemplateBody`` in a StackSet, but you can't use both. Dynamic references in the ``TemplateBody`` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through ``TemplateUrl`` instead.
|
|
4829
4824
|
:param template_url: Location of file containing the template body. The URL must point to a template that's located in an Amazon S3 bucket or a Systems Manager document. For more information, go to `Template Anatomy <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/template-anatomy.html>`_ in the AWS CloudFormation User Guide. Conditional: You must specify only one of the following parameters: ``TemplateBody`` , ``TemplateURL`` .
|
|
4830
4825
|
|
|
4831
4826
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html
|
|
@@ -4955,10 +4950,6 @@ class CfnStackSetProps:
|
|
|
4955
4950
|
'''The name to associate with the stack set.
|
|
4956
4951
|
|
|
4957
4952
|
The name must be unique in the Region where you create your stack set.
|
|
4958
|
-
|
|
4959
|
-
*Maximum* : ``128``
|
|
4960
|
-
|
|
4961
|
-
*Pattern* : ``^[a-zA-Z][a-zA-Z0-9-]{0,127}$``
|
|
4962
4953
|
.. epigraph::
|
|
4963
4954
|
|
|
4964
4955
|
The ``StackSetName`` property is required.
|
|
@@ -5111,9 +5102,11 @@ class CfnStackSetProps:
|
|
|
5111
5102
|
|
|
5112
5103
|
@builtins.property
|
|
5113
5104
|
def tags(self) -> typing.Optional[typing.List[_CfnTag_f6864754]]:
|
|
5114
|
-
'''
|
|
5105
|
+
'''Key-value pairs to associate with this stack.
|
|
5106
|
+
|
|
5107
|
+
AWS CloudFormation also propagates these tags to supported resources in the stack. You can specify a maximum number of 50 tags.
|
|
5115
5108
|
|
|
5116
|
-
|
|
5109
|
+
If you don't specify this parameter, AWS CloudFormation doesn't modify the stack's tags. If you specify an empty value, AWS CloudFormation removes all associated tags.
|
|
5117
5110
|
|
|
5118
5111
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-tags
|
|
5119
5112
|
'''
|
|
@@ -5126,10 +5119,6 @@ class CfnStackSetProps:
|
|
|
5126
5119
|
|
|
5127
5120
|
You must include either ``TemplateURL`` or ``TemplateBody`` in a StackSet, but you can't use both. Dynamic references in the ``TemplateBody`` may not work correctly in all cases. It's recommended to pass templates containing dynamic references through ``TemplateUrl`` instead.
|
|
5128
5121
|
|
|
5129
|
-
*Minimum* : ``1``
|
|
5130
|
-
|
|
5131
|
-
*Maximum* : ``51200``
|
|
5132
|
-
|
|
5133
5122
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-cloudformation-stackset.html#cfn-cloudformation-stackset-templatebody
|
|
5134
5123
|
'''
|
|
5135
5124
|
result = self._values.get("template_body")
|
|
@@ -5977,7 +5966,8 @@ class CfnWaitConditionHandle(
|
|
|
5977
5966
|
@builtins.property
|
|
5978
5967
|
@jsii.member(jsii_name="attrId")
|
|
5979
5968
|
def attr_id(self) -> builtins.str:
|
|
5980
|
-
'''
|
|
5969
|
+
'''A unique identifier for the resource.
|
|
5970
|
+
|
|
5981
5971
|
:cloudformationAttribute: Id
|
|
5982
5972
|
'''
|
|
5983
5973
|
return typing.cast(builtins.str, jsii.get(self, "attrId"))
|
|
@@ -6753,10 +6743,10 @@ def _typecheckingstub__b03b296829d4f2eb356ceeb892ed7d61908e69c4949bd797def9d9980
|
|
|
6753
6743
|
scope: _constructs_77d1e7e8.Construct,
|
|
6754
6744
|
id: builtins.str,
|
|
6755
6745
|
*,
|
|
6756
|
-
template_url: builtins.str,
|
|
6757
6746
|
notification_arns: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6758
6747
|
parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
|
|
6759
6748
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6749
|
+
template_url: typing.Optional[builtins.str] = None,
|
|
6760
6750
|
timeout_in_minutes: typing.Optional[jsii.Number] = None,
|
|
6761
6751
|
) -> None:
|
|
6762
6752
|
"""Type checking stubs"""
|
|
@@ -6774,12 +6764,6 @@ def _typecheckingstub__6d5f666653aae50479803ed71839253ef19c348c5240cb3bebb449b6e
|
|
|
6774
6764
|
"""Type checking stubs"""
|
|
6775
6765
|
pass
|
|
6776
6766
|
|
|
6777
|
-
def _typecheckingstub__3db469b6ac2b6930a53773a7067f28dcbe494d1c4c0aa67dc9ab276d28d07904(
|
|
6778
|
-
value: builtins.str,
|
|
6779
|
-
) -> None:
|
|
6780
|
-
"""Type checking stubs"""
|
|
6781
|
-
pass
|
|
6782
|
-
|
|
6783
6767
|
def _typecheckingstub__d66d5e1fe390793c13ae8f3762505ddcb7c4e44a03b219a7d65987bc8ac48d68(
|
|
6784
6768
|
value: typing.Optional[typing.List[builtins.str]],
|
|
6785
6769
|
) -> None:
|
|
@@ -6798,6 +6782,12 @@ def _typecheckingstub__3dd6f2b6a16bc08db2d10b1a6eff5f64991fe724d61645874b4235a7f
|
|
|
6798
6782
|
"""Type checking stubs"""
|
|
6799
6783
|
pass
|
|
6800
6784
|
|
|
6785
|
+
def _typecheckingstub__3db469b6ac2b6930a53773a7067f28dcbe494d1c4c0aa67dc9ab276d28d07904(
|
|
6786
|
+
value: typing.Optional[builtins.str],
|
|
6787
|
+
) -> None:
|
|
6788
|
+
"""Type checking stubs"""
|
|
6789
|
+
pass
|
|
6790
|
+
|
|
6801
6791
|
def _typecheckingstub__2c9f0cec1de29739b017def3b496f6e5bf888854e8a565ee7e2a8695868506eb(
|
|
6802
6792
|
value: typing.Optional[jsii.Number],
|
|
6803
6793
|
) -> None:
|
|
@@ -6816,10 +6806,10 @@ def _typecheckingstub__a4b95d92bea1984ce15e37fa304b047ed771a4f764d414ffac3281574
|
|
|
6816
6806
|
|
|
6817
6807
|
def _typecheckingstub__4da59ffe076e92fe1011ac29ca869d93a69d1442f3b7a0d1c765cca951d09b20(
|
|
6818
6808
|
*,
|
|
6819
|
-
template_url: builtins.str,
|
|
6820
6809
|
notification_arns: typing.Optional[typing.Sequence[builtins.str]] = None,
|
|
6821
6810
|
parameters: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Mapping[builtins.str, builtins.str]]] = None,
|
|
6822
6811
|
tags: typing.Optional[typing.Sequence[typing.Union[_CfnTag_f6864754, typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
6812
|
+
template_url: typing.Optional[builtins.str] = None,
|
|
6823
6813
|
timeout_in_minutes: typing.Optional[jsii.Number] = None,
|
|
6824
6814
|
) -> None:
|
|
6825
6815
|
"""Type checking stubs"""
|
|
@@ -2138,6 +2138,9 @@ class CfnPipeline(
|
|
|
2138
2138
|
'''The ``AWS::CodePipeline::Pipeline`` resource creates a CodePipeline pipeline that describes how software changes go through a release process.
|
|
2139
2139
|
|
|
2140
2140
|
For more information, see `What Is CodePipeline? <https://docs.aws.amazon.com/codepipeline/latest/userguide/welcome.html>`_ in the *AWS CodePipeline User Guide* .
|
|
2141
|
+
.. epigraph::
|
|
2142
|
+
|
|
2143
|
+
V2 type pipelines, along with triggers on Git tags and pipeline-level variables, are not currently supported for CloudFormation and CDK resources in CodePipeline. For more information about V2 type pipelines, see `Pipeline types <https://docs.aws.amazon.com/codepipeline/latest/userguide/pipeline-types.html>`_ in the *AWS CodePipeline User Guide* .
|
|
2141
2144
|
|
|
2142
2145
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-codepipeline-pipeline.html
|
|
2143
2146
|
:cloudformationResource: AWS::CodePipeline::Pipeline
|
aws_cdk/aws_cognito/__init__.py
CHANGED
|
@@ -6437,14 +6437,6 @@ class CfnUserPoolClient(
|
|
|
6437
6437
|
'''
|
|
6438
6438
|
return typing.cast(builtins.str, jsii.get(self, "attrClientSecret"))
|
|
6439
6439
|
|
|
6440
|
-
@builtins.property
|
|
6441
|
-
@jsii.member(jsii_name="attrId")
|
|
6442
|
-
def attr_id(self) -> builtins.str:
|
|
6443
|
-
'''
|
|
6444
|
-
:cloudformationAttribute: Id
|
|
6445
|
-
'''
|
|
6446
|
-
return typing.cast(builtins.str, jsii.get(self, "attrId"))
|
|
6447
|
-
|
|
6448
6440
|
@builtins.property
|
|
6449
6441
|
@jsii.member(jsii_name="attrName")
|
|
6450
6442
|
def attr_name(self) -> builtins.str:
|
|
@@ -15463,16 +15455,16 @@ class UserPool(
|
|
|
15463
15455
|
:param mfa_second_factor: Configure the MFA types that users can use in this user pool. Ignored if ``mfa`` is set to ``OFF``. Default: - { sms: true, otp: false }, if ``mfa`` is set to ``OPTIONAL`` or ``REQUIRED``. { sms: false, otp: false }, otherwise
|
|
15464
15456
|
:param password_policy: Password policy for this user pool. Default: - see defaults on each property of PasswordPolicy.
|
|
15465
15457
|
:param removal_policy: Policy to apply when the user pool is removed from the stack. Default: RemovalPolicy.RETAIN
|
|
15466
|
-
:param self_sign_up_enabled: Whether self sign
|
|
15458
|
+
:param self_sign_up_enabled: Whether self sign-up should be enabled. To configure self sign-up configuration use the ``userVerification`` property. Default: - false
|
|
15467
15459
|
:param sign_in_aliases: Methods in which a user registers or signs in to a user pool. Allows either username with aliases OR sign in with email, phone, or both. Read the sections on usernames and aliases to learn more - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html To match with 'Option 1' in the above link, with a verified email, this property should be set to ``{ username: true, email: true }``. To match with 'Option 2' in the above link with both a verified email and phone number, this property should be set to ``{ email: true, phone: true }``. Default: { username: true }
|
|
15468
15460
|
:param sign_in_case_sensitive: Whether sign-in aliases should be evaluated with case sensitivity. For example, when this option is set to false, users will be able to sign in using either ``MyUsername`` or ``myusername``. Default: true
|
|
15469
|
-
:param sms_role: The IAM role that Cognito will assume while sending SMS messages. Default: - a new IAM role is created
|
|
15470
|
-
:param sms_role_external_id: The 'ExternalId' that Cognito service must be using when assuming the ``smsRole``, if the role is restricted with an 'sts:ExternalId' conditional. Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html This property will be ignored if ``smsRole`` is not specified. Default: - No external id will be configured
|
|
15471
|
-
:param sns_region: The region to integrate with SNS to send SMS messages. This property will do nothing if SMS configuration is not configured Default: - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
|
|
15461
|
+
:param sms_role: The IAM role that Cognito will assume while sending SMS messages. Default: - a new IAM role is created.
|
|
15462
|
+
:param sms_role_external_id: The 'ExternalId' that Cognito service must be using when assuming the ``smsRole``, if the role is restricted with an 'sts:ExternalId' conditional. Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html This property will be ignored if ``smsRole`` is not specified. Default: - No external id will be configured.
|
|
15463
|
+
:param sns_region: The region to integrate with SNS to send SMS messages. This property will do nothing if SMS configuration is not configured. Default: - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
|
|
15472
15464
|
:param standard_attributes: The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html Default: - All standard attributes are optional and mutable.
|
|
15473
|
-
:param user_invitation: Configuration around admins signing up users into a user pool. Default: - see defaults in UserInvitationConfig
|
|
15474
|
-
:param user_pool_name: Name of the user pool. Default: - automatically generated name by CloudFormation at deploy time
|
|
15475
|
-
:param user_verification: Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the ``selfSignUpEnabled`` property. Default: - see defaults in UserVerificationConfig
|
|
15465
|
+
:param user_invitation: Configuration around admins signing up users into a user pool. Default: - see defaults in UserInvitationConfig.
|
|
15466
|
+
:param user_pool_name: Name of the user pool. Default: - automatically generated name by CloudFormation at deploy time.
|
|
15467
|
+
:param user_verification: Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the ``selfSignUpEnabled`` property. Default: - see defaults in UserVerificationConfig.
|
|
15476
15468
|
'''
|
|
15477
15469
|
if __debug__:
|
|
15478
15470
|
type_hints = typing.get_type_hints(_typecheckingstub__677a8ec9a3f2a22d2dfde6fd6818121e4a071dc4e942f6bbe219e5a9b6675d99)
|
|
@@ -18174,16 +18166,16 @@ class UserPoolProps:
|
|
|
18174
18166
|
:param mfa_second_factor: Configure the MFA types that users can use in this user pool. Ignored if ``mfa`` is set to ``OFF``. Default: - { sms: true, otp: false }, if ``mfa`` is set to ``OPTIONAL`` or ``REQUIRED``. { sms: false, otp: false }, otherwise
|
|
18175
18167
|
:param password_policy: Password policy for this user pool. Default: - see defaults on each property of PasswordPolicy.
|
|
18176
18168
|
:param removal_policy: Policy to apply when the user pool is removed from the stack. Default: RemovalPolicy.RETAIN
|
|
18177
|
-
:param self_sign_up_enabled: Whether self sign
|
|
18169
|
+
:param self_sign_up_enabled: Whether self sign-up should be enabled. To configure self sign-up configuration use the ``userVerification`` property. Default: - false
|
|
18178
18170
|
:param sign_in_aliases: Methods in which a user registers or signs in to a user pool. Allows either username with aliases OR sign in with email, phone, or both. Read the sections on usernames and aliases to learn more - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html To match with 'Option 1' in the above link, with a verified email, this property should be set to ``{ username: true, email: true }``. To match with 'Option 2' in the above link with both a verified email and phone number, this property should be set to ``{ email: true, phone: true }``. Default: { username: true }
|
|
18179
18171
|
:param sign_in_case_sensitive: Whether sign-in aliases should be evaluated with case sensitivity. For example, when this option is set to false, users will be able to sign in using either ``MyUsername`` or ``myusername``. Default: true
|
|
18180
|
-
:param sms_role: The IAM role that Cognito will assume while sending SMS messages. Default: - a new IAM role is created
|
|
18181
|
-
:param sms_role_external_id: The 'ExternalId' that Cognito service must be using when assuming the ``smsRole``, if the role is restricted with an 'sts:ExternalId' conditional. Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html This property will be ignored if ``smsRole`` is not specified. Default: - No external id will be configured
|
|
18182
|
-
:param sns_region: The region to integrate with SNS to send SMS messages. This property will do nothing if SMS configuration is not configured Default: - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
|
|
18172
|
+
:param sms_role: The IAM role that Cognito will assume while sending SMS messages. Default: - a new IAM role is created.
|
|
18173
|
+
:param sms_role_external_id: The 'ExternalId' that Cognito service must be using when assuming the ``smsRole``, if the role is restricted with an 'sts:ExternalId' conditional. Learn more about ExternalId here - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_create_for-user_externalid.html This property will be ignored if ``smsRole`` is not specified. Default: - No external id will be configured.
|
|
18174
|
+
:param sns_region: The region to integrate with SNS to send SMS messages. This property will do nothing if SMS configuration is not configured. Default: - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
|
|
18183
18175
|
:param standard_attributes: The set of attributes that are required for every user in the user pool. Read more on attributes here - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-settings-attributes.html Default: - All standard attributes are optional and mutable.
|
|
18184
|
-
:param user_invitation: Configuration around admins signing up users into a user pool. Default: - see defaults in UserInvitationConfig
|
|
18185
|
-
:param user_pool_name: Name of the user pool. Default: - automatically generated name by CloudFormation at deploy time
|
|
18186
|
-
:param user_verification: Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the ``selfSignUpEnabled`` property. Default: - see defaults in UserVerificationConfig
|
|
18176
|
+
:param user_invitation: Configuration around admins signing up users into a user pool. Default: - see defaults in UserInvitationConfig.
|
|
18177
|
+
:param user_pool_name: Name of the user pool. Default: - automatically generated name by CloudFormation at deploy time.
|
|
18178
|
+
:param user_verification: Configuration around users signing themselves up to the user pool. Enable or disable self sign-up via the ``selfSignUpEnabled`` property. Default: - see defaults in UserVerificationConfig.
|
|
18187
18179
|
|
|
18188
18180
|
:exampleMetadata: infused
|
|
18189
18181
|
|
|
@@ -18470,11 +18462,11 @@ class UserPoolProps:
|
|
|
18470
18462
|
|
|
18471
18463
|
@builtins.property
|
|
18472
18464
|
def self_sign_up_enabled(self) -> typing.Optional[builtins.bool]:
|
|
18473
|
-
'''Whether self sign
|
|
18465
|
+
'''Whether self sign-up should be enabled.
|
|
18474
18466
|
|
|
18475
|
-
|
|
18467
|
+
To configure self sign-up configuration use the ``userVerification`` property.
|
|
18476
18468
|
|
|
18477
|
-
:default: false
|
|
18469
|
+
:default: - false
|
|
18478
18470
|
'''
|
|
18479
18471
|
result = self._values.get("self_sign_up_enabled")
|
|
18480
18472
|
return typing.cast(typing.Optional[builtins.bool], result)
|
|
@@ -18512,7 +18504,7 @@ class UserPoolProps:
|
|
|
18512
18504
|
def sms_role(self) -> typing.Optional[_IRole_235f5d8e]:
|
|
18513
18505
|
'''The IAM role that Cognito will assume while sending SMS messages.
|
|
18514
18506
|
|
|
18515
|
-
:default: - a new IAM role is created
|
|
18507
|
+
:default: - a new IAM role is created.
|
|
18516
18508
|
'''
|
|
18517
18509
|
result = self._values.get("sms_role")
|
|
18518
18510
|
return typing.cast(typing.Optional[_IRole_235f5d8e], result)
|
|
@@ -18525,7 +18517,7 @@ class UserPoolProps:
|
|
|
18525
18517
|
|
|
18526
18518
|
This property will be ignored if ``smsRole`` is not specified.
|
|
18527
18519
|
|
|
18528
|
-
:default: - No external id will be configured
|
|
18520
|
+
:default: - No external id will be configured.
|
|
18529
18521
|
'''
|
|
18530
18522
|
result = self._values.get("sms_role_external_id")
|
|
18531
18523
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
@@ -18534,7 +18526,7 @@ class UserPoolProps:
|
|
|
18534
18526
|
def sns_region(self) -> typing.Optional[builtins.str]:
|
|
18535
18527
|
'''The region to integrate with SNS to send SMS messages.
|
|
18536
18528
|
|
|
18537
|
-
This property will do nothing if SMS configuration is not configured
|
|
18529
|
+
This property will do nothing if SMS configuration is not configured.
|
|
18538
18530
|
|
|
18539
18531
|
:default: - The same region as the user pool, with a few exceptions - https://docs.aws.amazon.com/cognito/latest/developerguide/user-pool-sms-settings.html#user-pool-sms-settings-first-time
|
|
18540
18532
|
'''
|
|
@@ -18556,7 +18548,7 @@ class UserPoolProps:
|
|
|
18556
18548
|
def user_invitation(self) -> typing.Optional[UserInvitationConfig]:
|
|
18557
18549
|
'''Configuration around admins signing up users into a user pool.
|
|
18558
18550
|
|
|
18559
|
-
:default: - see defaults in UserInvitationConfig
|
|
18551
|
+
:default: - see defaults in UserInvitationConfig.
|
|
18560
18552
|
'''
|
|
18561
18553
|
result = self._values.get("user_invitation")
|
|
18562
18554
|
return typing.cast(typing.Optional[UserInvitationConfig], result)
|
|
@@ -18565,7 +18557,7 @@ class UserPoolProps:
|
|
|
18565
18557
|
def user_pool_name(self) -> typing.Optional[builtins.str]:
|
|
18566
18558
|
'''Name of the user pool.
|
|
18567
18559
|
|
|
18568
|
-
:default: - automatically generated name by CloudFormation at deploy time
|
|
18560
|
+
:default: - automatically generated name by CloudFormation at deploy time.
|
|
18569
18561
|
'''
|
|
18570
18562
|
result = self._values.get("user_pool_name")
|
|
18571
18563
|
return typing.cast(typing.Optional[builtins.str], result)
|
|
@@ -18576,7 +18568,7 @@ class UserPoolProps:
|
|
|
18576
18568
|
|
|
18577
18569
|
Enable or disable self sign-up via the ``selfSignUpEnabled`` property.
|
|
18578
18570
|
|
|
18579
|
-
:default: - see defaults in UserVerificationConfig
|
|
18571
|
+
:default: - see defaults in UserVerificationConfig.
|
|
18580
18572
|
'''
|
|
18581
18573
|
result = self._values.get("user_verification")
|
|
18582
18574
|
return typing.cast(typing.Optional["UserVerificationConfig"], result)
|