aws-cdk-lib 2.184.1__py3-none-any.whl → 2.186.0__py3-none-any.whl

aws_cdk/__init__.py

@@ -10562,14 +10562,16 @@ class ContextProvider(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.ContextPro
         *,
         dummy_value: typing.Any,
         ignore_error_on_missing_context: typing.Optional[builtins.bool] = None,
+        must_exist: typing.Optional[builtins.bool] = None,
         provider: builtins.str,
         include_environment: typing.Optional[builtins.bool] = None,
         props: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
     ) -> "GetContextValueResult":
         '''
         :param scope: -
-        :param dummy_value: The value to return if the context value was not found and a missing context is reported.
-        :param ignore_error_on_missing_context: When True, the context provider will not throw an error if missing context is reported. Default: false
+        :param dummy_value: The value to return if the lookup has not yet been performed. Upon first synthesis, the lookups has not yet been performed. The ``getValue()`` operation returns this value instead, so that synthesis can proceed. After synthesis completes the first time, the actual lookup will be performed and synthesis will run again with the *real* value. Dummy values should preferably have valid shapes so that downstream consumers of lookup values don't throw validation exceptions if they encounter a dummy value (or all possible downstream consumers need to effectively check for the well-known shape of the dummy value); throwing an exception would error out the synthesis operation and prevent the lookup and the second, real, synthesis from happening. Connection to mustExist ``dummyValue`` is also used as the official value to return if the lookup has failed and ``mustExist == false``.
+        :param ignore_error_on_missing_context: (deprecated) Ignore a lookup failure and return the ``dummyValue`` instead. ``mustExist`` is the recommended alias for this deprecated property (note that its value is reversed). Default: false
+        :param must_exist: Whether the resource must exist. If this is set (the default), the query fails if the value or resource we tried to look up doesn't exist. If this is ``false`` and the value we tried to look up could not be found, the failure is suppressed and ``dummyValue`` is officially returned instead. When this happens, ``dummyValue`` is encoded into cached context and it will never be refreshed anymore until the user runs ``cdk context --reset <key>``. Note that it is not possible for the CDK app code to make a distinction between "the lookup has not been performed yet" and "the lookup didn't find anything and we returned a default value instead". Context providers This feature must explicitly be supported by context providers. It is currently supported by: - KMS key provider - SSM parameter provider Note to implementors The dummy value should not be returned for all SDK lookup failures. For example, "no network" or "no credentials" or "malformed query" should not lead to the dummy value being returned. Only the case of "no such resource" should. Default: true
         :param provider: The context provider to query.
         :param include_environment: Whether to include the stack's account and region automatically. Default: true
         :param props: Provider-specific properties.
@@ -10580,6 +10582,7 @@ class ContextProvider(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.ContextPro
         options = GetContextValueOptions(
             dummy_value=dummy_value,
             ignore_error_on_missing_context=ignore_error_on_missing_context,
+            must_exist=must_exist,
             provider=provider,
             include_environment=include_environment,
             props=props,
@@ -13033,26 +13036,21 @@ class Duration(metaclass=jsii.JSIIMeta, jsii_type="aws-cdk-lib.Duration"):
 
     Example::
 
-        import aws_cdk.aws_ecs as ecs
-        
-        # cluster: ecs.ICluster
-        # task_definition: ecs.TaskDefinition
-        
+        # my_role: iam.Role
         
-        rule = events.Rule(self, "Rule",
-            schedule=events.Schedule.rate(cdk.Duration.hours(1))
+        cr.AwsCustomResource(self, "Customized",
+            role=my_role,  # must be assumable by the `lambda.amazonaws.com` service principal
+            timeout=Duration.minutes(10),  # defaults to 2 minutes
+            memory_size=1025,  # defaults to 512 if installLatestAwsSdk is true
+            log_group=logs.LogGroup(self, "AwsCustomResourceLogs",
+                retention=logs.RetentionDays.ONE_DAY
+            ),
+            function_name="my-custom-name",  # defaults to a CloudFormation generated name
+            removal_policy=RemovalPolicy.RETAIN,  # defaults to `RemovalPolicy.DESTROY`
+            policy=cr.AwsCustomResourcePolicy.from_sdk_calls(
+                resources=cr.AwsCustomResourcePolicy.ANY_RESOURCE
+            )
         )
-        
-        rule.add_target(targets.EcsTask(
-            cluster=cluster,
-            task_definition=task_definition,
-            task_count=1,
-            container_overrides=[targets.ContainerOverride(
-                container_name="TheContainer",
-                command=["echo", events.EventField.from_path("$.detail.event")]
-            )],
-            enable_execute_command=True
-        ))
     '''
 
     @jsii.member(jsii_name="days")
@@ -15219,6 +15217,7 @@ class GetContextKeyResult:
         "props": "props",
         "dummy_value": "dummyValue",
         "ignore_error_on_missing_context": "ignoreErrorOnMissingContext",
+        "must_exist": "mustExist",
     },
 )
 class GetContextValueOptions(GetContextKeyOptions):
@@ -15230,13 +15229,15 @@ class GetContextValueOptions(GetContextKeyOptions):
         props: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
         dummy_value: typing.Any,
         ignore_error_on_missing_context: typing.Optional[builtins.bool] = None,
+        must_exist: typing.Optional[builtins.bool] = None,
     ) -> None:
         '''
         :param provider: The context provider to query.
         :param include_environment: Whether to include the stack's account and region automatically. Default: true
         :param props: Provider-specific properties.
-        :param dummy_value: The value to return if the context value was not found and a missing context is reported.
-        :param ignore_error_on_missing_context: When True, the context provider will not throw an error if missing context is reported. Default: false
+        :param dummy_value: The value to return if the lookup has not yet been performed. Upon first synthesis, the lookups has not yet been performed. The ``getValue()`` operation returns this value instead, so that synthesis can proceed. After synthesis completes the first time, the actual lookup will be performed and synthesis will run again with the *real* value. Dummy values should preferably have valid shapes so that downstream consumers of lookup values don't throw validation exceptions if they encounter a dummy value (or all possible downstream consumers need to effectively check for the well-known shape of the dummy value); throwing an exception would error out the synthesis operation and prevent the lookup and the second, real, synthesis from happening. Connection to mustExist ``dummyValue`` is also used as the official value to return if the lookup has failed and ``mustExist == false``.
+        :param ignore_error_on_missing_context: (deprecated) Ignore a lookup failure and return the ``dummyValue`` instead. ``mustExist`` is the recommended alias for this deprecated property (note that its value is reversed). Default: false
+        :param must_exist: Whether the resource must exist. If this is set (the default), the query fails if the value or resource we tried to look up doesn't exist. If this is ``false`` and the value we tried to look up could not be found, the failure is suppressed and ``dummyValue`` is officially returned instead. When this happens, ``dummyValue`` is encoded into cached context and it will never be refreshed anymore until the user runs ``cdk context --reset <key>``. Note that it is not possible for the CDK app code to make a distinction between "the lookup has not been performed yet" and "the lookup didn't find anything and we returned a default value instead". Context providers This feature must explicitly be supported by context providers. It is currently supported by: - KMS key provider - SSM parameter provider Note to implementors The dummy value should not be returned for all SDK lookup failures. For example, "no network" or "no credentials" or "malformed query" should not lead to the dummy value being returned. Only the case of "no such resource" should. Default: true
 
         :exampleMetadata: fixture=_generated
 
@@ -15256,6 +15257,7 @@ class GetContextValueOptions(GetContextKeyOptions):
                 # the properties below are optional
                 ignore_error_on_missing_context=False,
                 include_environment=False,
+                must_exist=False,
                 props={
                     "props_key": props
                 }
@@ -15268,6 +15270,7 @@ class GetContextValueOptions(GetContextKeyOptions):
             check_type(argname="argument props", value=props, expected_type=type_hints["props"])
             check_type(argname="argument dummy_value", value=dummy_value, expected_type=type_hints["dummy_value"])
             check_type(argname="argument ignore_error_on_missing_context", value=ignore_error_on_missing_context, expected_type=type_hints["ignore_error_on_missing_context"])
+            check_type(argname="argument must_exist", value=must_exist, expected_type=type_hints["must_exist"])
         self._values: typing.Dict[builtins.str, typing.Any] = {
             "provider": provider,
             "dummy_value": dummy_value,
@@ -15278,6 +15281,8 @@ class GetContextValueOptions(GetContextKeyOptions):
             self._values["props"] = props
         if ignore_error_on_missing_context is not None:
             self._values["ignore_error_on_missing_context"] = ignore_error_on_missing_context
+        if must_exist is not None:
+            self._values["must_exist"] = must_exist
 
     @builtins.property
     def provider(self) -> builtins.str:
@@ -15303,20 +15308,86 @@ class GetContextValueOptions(GetContextKeyOptions):
 
     @builtins.property
     def dummy_value(self) -> typing.Any:
-        '''The value to return if the context value was not found and a missing context is reported.'''
+        '''The value to return if the lookup has not yet been performed.
+
+        Upon first synthesis, the lookups has not yet been performed. The
+        ``getValue()`` operation returns this value instead, so that synthesis can
+        proceed. After synthesis completes the first time, the actual lookup will
+        be performed and synthesis will run again with the *real* value.
+
+        Dummy values should preferably have valid shapes so that downstream
+        consumers of lookup values don't throw validation exceptions if they
+        encounter a dummy value (or all possible downstream consumers need to
+        effectively check for the well-known shape of the dummy value); throwing an
+        exception would error out the synthesis operation and prevent the lookup
+        and the second, real, synthesis from happening.
+
+
+        Connection to mustExist
+
+        ``dummyValue`` is also used as the official value to return if the lookup has
+        failed and ``mustExist == false``.
+        '''
         result = self._values.get("dummy_value")
         assert result is not None, "Required property 'dummy_value' is missing"
         return typing.cast(typing.Any, result)
 
     @builtins.property
     def ignore_error_on_missing_context(self) -> typing.Optional[builtins.bool]:
-        '''When True, the context provider will not throw an error if missing context is reported.
+        '''(deprecated) Ignore a lookup failure and return the ``dummyValue`` instead.
+
+        ``mustExist`` is the recommended alias for this deprecated
+        property (note that its value is reversed).
 
         :default: false
+
+        :deprecated: Use mustExist instead
+
+        :stability: deprecated
         '''
         result = self._values.get("ignore_error_on_missing_context")
         return typing.cast(typing.Optional[builtins.bool], result)
 
+    @builtins.property
+    def must_exist(self) -> typing.Optional[builtins.bool]:
+        '''Whether the resource must exist.
+
+        If this is set (the default), the query fails if the value or resource we
+        tried to look up doesn't exist.
+
+        If this is ``false`` and the value we tried to look up could not be found, the
+        failure is suppressed and ``dummyValue`` is officially returned instead.
+
+        When this happens, ``dummyValue`` is encoded into cached context and it will
+        never be refreshed anymore until the user runs ``cdk context --reset <key>``.
+
+        Note that it is not possible for the CDK app code to make a distinction
+        between "the lookup has not been performed yet" and "the lookup didn't
+        find anything and we returned a default value instead".
+
+
+        Context providers
+
+        This feature must explicitly be supported by context providers. It is
+        currently supported by:
+
+        - KMS key provider
+        - SSM parameter provider
+
+
+
+        Note to implementors
+
+        The dummy value should not be returned for all SDK lookup failures. For
+        example, "no network" or "no credentials" or "malformed query" should
+        not lead to the dummy value being returned. Only the case of "no such
+        resource" should.
+
+        :default: true
+        '''
+        result = self._values.get("must_exist")
+        return typing.cast(typing.Optional[builtins.bool], result)
+
     def __eq__(self, rhs: typing.Any) -> builtins.bool:
         return isinstance(rhs, self.__class__) and rhs._values == self._values
 
@@ -33558,7 +33629,7 @@ class CfnStackSet(
             :param max_concurrent_count: The maximum number of accounts in which to perform this operation at one time. This is dependent on the value of ``FailureToleranceCount`` . ``MaxConcurrentCount`` is at most one more than the ``FailureToleranceCount`` . Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either ``MaxConcurrentCount`` or ``MaxConcurrentPercentage`` , but not both.
             :param max_concurrent_percentage: The maximum percentage of accounts in which to perform this operation at one time. When calculating the number of accounts based on the specified percentage, CloudFormation rounds down to the next whole number. This is true except in cases where rounding down would result is zero. In this case, CloudFormation sets the number as one instead. Note that this setting lets you specify the *maximum* for operations. For large deployments, under certain circumstances the actual number of accounts acted upon concurrently may be lower due to service throttling. Conditional: You must specify either ``MaxConcurrentCount`` or ``MaxConcurrentPercentage`` , but not both.
             :param region_concurrency_type: The concurrency type of deploying StackSets operations in Regions, could be in parallel or one Region at a time.
-            :param region_order: The order of the Regions where you want to perform the stack operation. .. epigraph:: ``RegionOrder`` isn't followed if ``AutoDeployment`` is enabled.
+            :param region_order: The order of the Regions where you want to perform the stack operation.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html
             :exampleMetadata: fixture=_generated
@@ -33690,10 +33761,6 @@ class CfnStackSet(
         def region_order(self) -> typing.Optional[typing.List[builtins.str]]:
             '''The order of the Regions where you want to perform the stack operation.
 
-            .. epigraph::
-
-               ``RegionOrder`` isn't followed if ``AutoDeployment`` is enabled.
-
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-cloudformation-stackset-operationpreferences.html#cfn-cloudformation-stackset-operationpreferences-regionorder
             '''
             result = self._values.get("region_order")
@@ -37057,6 +37124,7 @@ __all__ = [
     "aws_codestarconnections",
     "aws_codestarnotifications",
     "aws_cognito",
+    "aws_cognito_identitypool",
     "aws_comprehend",
     "aws_config",
     "aws_connect",
@@ -37235,6 +37303,7 @@ __all__ = [
     "aws_sagemaker",
     "aws_sam",
     "aws_scheduler",
+    "aws_scheduler_targets",
     "aws_sdb",
     "aws_secretsmanager",
     "aws_securityhub",
@@ -37351,6 +37420,7 @@ from . import aws_codestar
 from . import aws_codestarconnections
 from . import aws_codestarnotifications
 from . import aws_cognito
+from . import aws_cognito_identitypool
 from . import aws_comprehend
 from . import aws_config
 from . import aws_connect
@@ -37529,6 +37599,7 @@ from . import aws_s3tables
 from . import aws_sagemaker
 from . import aws_sam
 from . import aws_scheduler
+from . import aws_scheduler_targets
 from . import aws_sdb
 from . import aws_secretsmanager
 from . import aws_securityhub
@@ -38621,6 +38692,7 @@ def _typecheckingstub__cbcd83febe5237c988f26712b8a838ca5d2e34ea47490d008757c21a6
     *,
     dummy_value: typing.Any,
     ignore_error_on_missing_context: typing.Optional[builtins.bool] = None,
+    must_exist: typing.Optional[builtins.bool] = None,
     provider: builtins.str,
     include_environment: typing.Optional[builtins.bool] = None,
     props: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
@@ -39275,6 +39347,7 @@ def _typecheckingstub__16ea3024419c210903405ca05f7de1bb3fad517c101a7a84926fb5e09
     props: typing.Optional[typing.Mapping[builtins.str, typing.Any]] = None,
     dummy_value: typing.Any,
     ignore_error_on_missing_context: typing.Optional[builtins.bool] = None,
+    must_exist: typing.Optional[builtins.bool] = None,
 ) -> None:
     """Type checking stubs"""
     pass

aws_cdk/_jsii/__init__.py

@@ -34,7 +34,7 @@ import aws_cdk.cloud_assembly_schema._jsii
 import constructs._jsii
 
 __jsii_assembly__ = jsii.JSIIAssembly.load(
-    "aws-cdk-lib", "2.184.1", __name__[0:-6], "aws-cdk-lib@2.184.1.jsii.tgz"
+    "aws-cdk-lib", "2.186.0", __name__[0:-6], "aws-cdk-lib@2.186.0.jsii.tgz"
 )
 
 __all__ = [

aws_cdk/aws_amazonmq/__init__.py

@@ -1382,7 +1382,7 @@ class CfnBroker(
             :param username: The username of the broker user. For Amazon MQ for ActiveMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). For Amazon MQ for RabbitMQ brokers, this value can contain only alphanumeric characters, dashes, periods, underscores (- . _). This value must not contain a tilde (~) character. Amazon MQ prohibts using guest as a valid usename. This value must be 2-100 characters long. .. epigraph:: Do not add personally identifiable information (PII) or other confidential or sensitive information in broker usernames. Broker usernames are accessible to other AWS services, including CloudWatch Logs . Broker usernames are not intended to be used for private or sensitive data.
             :param console_access: Enables access to the ActiveMQ web console for the ActiveMQ user. Does not apply to RabbitMQ brokers.
             :param groups: The list of groups (20 maximum) to which the ActiveMQ user belongs. This value can contain only alphanumeric characters, dashes, periods, underscores, and tildes (- . _ ~). This value must be 2-100 characters long. Does not apply to RabbitMQ brokers.
-            :param jolokia_api_access: 
+            :param jolokia_api_access: Turn on Jolokia access for your ActiveMQ broker user (Does not apply to RabbitMQ brokers).
             :param replication_user: Defines if this user is intended for CRDR replication purposes.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html
@@ -1479,7 +1479,8 @@ class CfnBroker(
 
         @builtins.property
         def jolokia_api_access(self) -> typing.Optional[builtins.str]:
-            '''
+            '''Turn on Jolokia access for your ActiveMQ broker user (Does not apply to RabbitMQ brokers).
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-amazonmq-broker-user.html#cfn-amazonmq-broker-user-jolokiaapiaccess
             '''
             result = self._values.get("jolokia_api_access")

aws_cdk/aws_apigateway/__init__.py

@@ -1585,7 +1585,7 @@ api = apigateway.RestApi(self, "books",
 
 **Note:** The delivery stream name must start with `amazon-apigateway-`.
 
-> Visit [Logging API calls to Kinesis Data Firehose](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-logging-to-kinesis.html) for more details.
+> Visit [Logging API calls to Amazon Data Firehose](https://docs.aws.amazon.com/apigateway/latest/developerguide/apigateway-logging-to-kinesis.html) for more details.
 
 ## Cross Origin Resource Sharing (CORS)
 

aws_cdk/aws_apigatewayv2/__init__.py

@@ -4044,6 +4044,15 @@ class CfnDomainName(
         '''The CloudFormation resource type name for this resource class.'''
         return typing.cast(builtins.str, jsii.sget(cls, "CFN_RESOURCE_TYPE_NAME"))
 
+    @builtins.property
+    @jsii.member(jsii_name="attrDomainNameArn")
+    def attr_domain_name_arn(self) -> builtins.str:
+        '''Represents an Amazon Resource Name (ARN).
+
+        :cloudformationAttribute: DomainNameArn
+        '''
+        return typing.cast(builtins.str, jsii.get(self, "attrDomainNameArn"))
+
     @builtins.property
     @jsii.member(jsii_name="attrRegionalDomainName")
     def attr_regional_domain_name(self) -> builtins.str:

aws_cdk/aws_appconfig/__init__.py

@@ -1418,7 +1418,7 @@ class CfnConfigurationProfile(
         :param deletion_protection_check: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
         :param description: A description of the configuration profile.
         :param kms_key_identifier: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
-        :param retrieval_role_arn: The ARN of an IAM role with permission to access the configuration at the specified ``LocationUri`` . .. epigraph:: A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
+        :param retrieval_role_arn: The ARN of an IAM role with permission to access the configuration at the specified ``LocationUri`` . .. epigraph:: A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
         :param tags: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
         :param type: The type of configurations contained in the profile. AWS AppConfig supports ``feature flags`` and ``freeform`` configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for ``Type`` : ``AWS.AppConfig.FeatureFlags`` ``AWS.Freeform``
         :param validators: A list of methods for validating the configuration.
@@ -1753,7 +1753,7 @@ class CfnConfigurationProfileProps:
         :param deletion_protection_check: On resource deletion this controls whether the Deletion Protection check should be applied, bypassed, or (the default) whether the behavior should be controlled by the account-level Deletion Protection setting. See https://docs.aws.amazon.com/appconfig/latest/userguide/deletion-protection.html
         :param description: A description of the configuration profile.
         :param kms_key_identifier: The AWS Key Management Service key identifier (key ID, key alias, or key ARN) provided when the resource was created or updated.
-        :param retrieval_role_arn: The ARN of an IAM role with permission to access the configuration at the specified ``LocationUri`` . .. epigraph:: A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
+        :param retrieval_role_arn: The ARN of an IAM role with permission to access the configuration at the specified ``LocationUri`` . .. epigraph:: A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
         :param tags: Metadata to assign to the configuration profile. Tags help organize and categorize your AWS AppConfig resources. Each tag consists of a key and an optional value, both of which you define.
         :param type: The type of configurations contained in the profile. AWS AppConfig supports ``feature flags`` and ``freeform`` configurations. We recommend you create feature flag configurations to enable or disable new features and freeform configurations to distribute configurations to an application. When calling this API, enter one of the following values for ``Type`` : ``AWS.AppConfig.FeatureFlags`` ``AWS.Freeform``
         :param validators: A list of methods for validating the configuration.
@@ -1892,7 +1892,7 @@ class CfnConfigurationProfileProps:
 
         .. epigraph::
 
-           A retrieval role ARN is not required for configurations stored in the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
+           A retrieval role ARN is not required for configurations stored in AWS CodePipeline or the AWS AppConfig hosted configuration store. It is required for all other sources that store your configuration.
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appconfig-configurationprofile.html#cfn-appconfig-configurationprofile-retrievalrolearn
         '''