aws-cdk-lib 2.118.0__py3-none-any.whl → 2.119.0__py3-none-any.whl

aws_cdk/aws_iotsitewise/__init__.py

@@ -3816,7 +3816,7 @@ class CfnGateway(
             '''Contains a gateway's platform information.
 
             :param greengrass: A gateway that runs on AWS IoT Greengrass .
-            :param greengrass_v2: A gateway that runs on AWS IoT Greengrass V2.
+            :param greengrass_v2: A gateway that runs on AWS IoT Greengrass V2 .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html
             :exampleMetadata: fixture=_generated
@@ -3861,7 +3861,7 @@ class CfnGateway(
         def greengrass_v2(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnGateway.GreengrassV2Property"]]:
-            '''A gateway that runs on AWS IoT Greengrass V2.
+            '''A gateway that runs on AWS IoT Greengrass V2 .
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotsitewise-gateway-gatewayplatform.html#cfn-iotsitewise-gateway-gatewayplatform-greengrassv2
             '''
@@ -3940,9 +3940,9 @@ class CfnGateway(
     )
     class GreengrassV2Property:
         def __init__(self, *, core_device_thing_name: builtins.str) -> None:
-            '''Contains details for a gateway that runs on AWS IoT Greengrass V2.
+            '''Contains details for a gateway that runs on AWS IoT Greengrass V2 .
 
-            To create a gateway that runs on AWS IoT Greengrass V2, you must deploy the IoT SiteWise Edge component to your gateway device. Your `Greengrass device role <https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html>`_ must use the ``AWSIoTSiteWiseEdgeAccess`` policy. For more information, see `Using AWS IoT SiteWise at the edge <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html>`_ in the *AWS IoT SiteWise User Guide* .
+            To create a gateway that runs on AWS IoT Greengrass V2 , you must deploy the IoT SiteWise Edge component to your gateway device. Your `Greengrass device role <https://docs.aws.amazon.com/greengrass/v2/developerguide/device-service-role.html>`_ must use the ``AWSIoTSiteWiseEdgeAccess`` policy. For more information, see `Using AWS IoT SiteWise at the edge <https://docs.aws.amazon.com/iot-sitewise/latest/userguide/sw-gateways.html>`_ in the *AWS IoT SiteWise User Guide* .
 
             :param core_device_thing_name: The name of the AWS IoT thing for your AWS IoT Greengrass V2 core device.
 

aws_cdk/aws_kendra/__init__.py

@@ -4455,7 +4455,7 @@ class CfnDataSource(
             :param bucket_name: The name of the bucket that contains the documents.
             :param access_control_list_configuration: Provides the path to the S3 bucket that contains the user context filtering files for the data source. For the format of the file, see `Access control for S3 data sources <https://docs.aws.amazon.com/kendra/latest/dg/s3-acl.html>`_ .
             :param documents_metadata_configuration: Specifies document metadata files that contain information such as the document access control information, source URI, document author, and custom attributes. Each metadata file contains metadata about a single document.
-            :param exclusion_patterns: A list of glob patterns for documents that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. Some `examples <https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters>`_ are: - **.png , *.jpg* will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg). - **internal** will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'. - *** /*internal** will exclude all internal-related files in a directory and its subdirectories.
+            :param exclusion_patterns: A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for file names and file types that should not be indexed. If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. Examples of glob patterns include: - ``/myapp/config/*`` - All files inside config directory - ``/** /*.png`` - All .png files in all directories - ``/** /*.{png,ico,md}`` - All .png, .ico or .md files in all directories - ``/myapp/src/** /*.ts`` - All .ts files inside src directory (and all its subdirectories) - ``** /!(*.module).ts`` - All .ts files but not .module.ts - **.png , *.jpg* will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg). - **internal** will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'. - *** /*internal** will exclude all internal-related files in a directory and its subdirectories. For more examples, see `Use of Exclude and Include Filters <https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters>`_ in the AWS CLI Command Reference.
             :param inclusion_patterns: A list of glob patterns for documents that should be indexed. If a document that matches an inclusion pattern also matches an exclusion pattern, the document is not indexed. Some `examples <https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters>`_ are: - **.txt* will include all text files in a directory (files with the extension .txt). - *** /*.txt* will include all text files in a directory and its subdirectories. - **tax** will include all files in a directory that contain 'tax' in the file name, such as 'tax', 'taxes', 'income_tax'.
             :param inclusion_prefixes: A list of S3 prefixes for the documents that should be included in the index.
 
@@ -4543,16 +4543,21 @@ class CfnDataSource(
 
         @builtins.property
         def exclusion_patterns(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''A list of glob patterns for documents that should not be indexed.
+            '''A list of glob patterns (patterns that can expand a wildcard pattern into a list of path names that match the given pattern) for file names and file types that should not be indexed.
 
-            If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed.
-
-            Some `examples <https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters>`_ are:
+            If a document that matches an inclusion prefix or inclusion pattern also matches an exclusion pattern, the document is not indexed. Examples of glob patterns include:
 
+            - ``/myapp/config/*`` - All files inside config directory
+            - ``/** /*.png`` - All .png files in all directories
+            - ``/** /*.{png,ico,md}`` - All .png, .ico or .md files in all directories
+            - ``/myapp/src/** /*.ts`` - All .ts files inside src directory (and all its subdirectories)
+            - ``** /!(*.module).ts`` - All .ts files but not .module.ts
             - **.png , *.jpg* will exclude all PNG and JPEG image files in a directory (files with the extensions .png and .jpg).
             - **internal** will exclude all files in a directory that contain 'internal' in the file name, such as 'internal', 'internal_only', 'company_internal'.
             - *** /*internal** will exclude all internal-related files in a directory and its subdirectories.
 
+            For more examples, see `Use of Exclude and Include Filters <https://docs.aws.amazon.com/cli/latest/reference/s3/#use-of-exclude-and-include-filters>`_ in the AWS CLI Command Reference.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kendra-datasource-s3datasourceconfiguration.html#cfn-kendra-datasource-s3datasourceconfiguration-exclusionpatterns
             '''
             result = self._values.get("exclusion_patterns")

aws_cdk/aws_kinesisfirehose/__init__.py

@@ -5625,6 +5625,85 @@ class CfnDeliveryStream(
                 k + "=" + repr(v) for k, v in self._values.items()
             )
 
+    @jsii.data_type(
+        jsii_type="aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.SplunkBufferingHintsProperty",
+        jsii_struct_bases=[],
+        name_mapping={
+            "interval_in_seconds": "intervalInSeconds",
+            "size_in_m_bs": "sizeInMBs",
+        },
+    )
+    class SplunkBufferingHintsProperty:
+        def __init__(
+            self,
+            *,
+            interval_in_seconds: typing.Optional[jsii.Number] = None,
+            size_in_m_bs: typing.Optional[jsii.Number] = None,
+        ) -> None:
+            '''The buffering options.
+
+            If no value is specified, the default values for Splunk are used.
+
+            :param interval_in_seconds: Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination. The default value is 60 (1 minute).
+            :param size_in_m_bs: Buffer incoming data to the specified size, in MBs, before delivering it to the destination. The default value is 5.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html
+            :exampleMetadata: fixture=_generated
+
+            Example::
+
+                # The code below shows an example of how to instantiate this type.
+                # The values are placeholders you should change.
+                from aws_cdk import aws_kinesisfirehose as kinesisfirehose
+                
+                splunk_buffering_hints_property = kinesisfirehose.CfnDeliveryStream.SplunkBufferingHintsProperty(
+                    interval_in_seconds=123,
+                    size_in_mBs=123
+                )
+            '''
+            if __debug__:
+                type_hints = typing.get_type_hints(_typecheckingstub__60823c61f8aea3242c07551788af8f338bff46b6299ee9aa1d0ff6112c454ecc)
+                check_type(argname="argument interval_in_seconds", value=interval_in_seconds, expected_type=type_hints["interval_in_seconds"])
+                check_type(argname="argument size_in_m_bs", value=size_in_m_bs, expected_type=type_hints["size_in_m_bs"])
+            self._values: typing.Dict[builtins.str, typing.Any] = {}
+            if interval_in_seconds is not None:
+                self._values["interval_in_seconds"] = interval_in_seconds
+            if size_in_m_bs is not None:
+                self._values["size_in_m_bs"] = size_in_m_bs
+
+        @builtins.property
+        def interval_in_seconds(self) -> typing.Optional[jsii.Number]:
+            '''Buffer incoming data for the specified period of time, in seconds, before delivering it to the destination.
+
+            The default value is 60 (1 minute).
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-intervalinseconds
+            '''
+            result = self._values.get("interval_in_seconds")
+            return typing.cast(typing.Optional[jsii.Number], result)
+
+        @builtins.property
+        def size_in_m_bs(self) -> typing.Optional[jsii.Number]:
+            '''Buffer incoming data to the specified size, in MBs, before delivering it to the destination.
+
+            The default value is 5.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkbufferinghints.html#cfn-kinesisfirehose-deliverystream-splunkbufferinghints-sizeinmbs
+            '''
+            result = self._values.get("size_in_m_bs")
+            return typing.cast(typing.Optional[jsii.Number], result)
+
+        def __eq__(self, rhs: typing.Any) -> builtins.bool:
+            return isinstance(rhs, self.__class__) and rhs._values == self._values
+
+        def __ne__(self, rhs: typing.Any) -> builtins.bool:
+            return not (rhs == self)
+
+        def __repr__(self) -> str:
+            return "SplunkBufferingHintsProperty(%s)" % ", ".join(
+                k + "=" + repr(v) for k, v in self._values.items()
+            )
+
     @jsii.data_type(
         jsii_type="aws-cdk-lib.aws_kinesisfirehose.CfnDeliveryStream.SplunkDestinationConfigurationProperty",
         jsii_struct_bases=[],
@@ -5633,6 +5712,7 @@ class CfnDeliveryStream(
             "hec_endpoint_type": "hecEndpointType",
             "hec_token": "hecToken",
             "s3_configuration": "s3Configuration",
+            "buffering_hints": "bufferingHints",
             "cloud_watch_logging_options": "cloudWatchLoggingOptions",
             "hec_acknowledgment_timeout_in_seconds": "hecAcknowledgmentTimeoutInSeconds",
             "processing_configuration": "processingConfiguration",
@@ -5648,6 +5728,7 @@ class CfnDeliveryStream(
             hec_endpoint_type: builtins.str,
             hec_token: builtins.str,
             s3_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.S3DestinationConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
+            buffering_hints: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.SplunkBufferingHintsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
             cloud_watch_logging_options: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.CloudWatchLoggingOptionsProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
             hec_acknowledgment_timeout_in_seconds: typing.Optional[jsii.Number] = None,
             processing_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.ProcessingConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
@@ -5660,6 +5741,7 @@ class CfnDeliveryStream(
             :param hec_endpoint_type: This type can be either ``Raw`` or ``Event`` .
             :param hec_token: This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
             :param s3_configuration: The configuration for the backup Amazon S3 location.
+            :param buffering_hints: The buffering options. If no value is specified, the default values for Splunk are used.
             :param cloud_watch_logging_options: The Amazon CloudWatch logging options for your delivery stream.
             :param hec_acknowledgment_timeout_in_seconds: The amount of time that Kinesis Data Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Kinesis Data Firehose either tries to send the data again or considers it an error, based on your retry settings.
             :param processing_configuration: The data processing configuration.
@@ -5705,6 +5787,10 @@ class CfnDeliveryStream(
                     ),
                 
                     # the properties below are optional
+                    buffering_hints=kinesisfirehose.CfnDeliveryStream.SplunkBufferingHintsProperty(
+                        interval_in_seconds=123,
+                        size_in_mBs=123
+                    ),
                     cloud_watch_logging_options=kinesisfirehose.CfnDeliveryStream.CloudWatchLoggingOptionsProperty(
                         enabled=False,
                         log_group_name="logGroupName",
@@ -5735,6 +5821,7 @@ class CfnDeliveryStream(
                 check_type(argname="argument hec_endpoint_type", value=hec_endpoint_type, expected_type=type_hints["hec_endpoint_type"])
                 check_type(argname="argument hec_token", value=hec_token, expected_type=type_hints["hec_token"])
                 check_type(argname="argument s3_configuration", value=s3_configuration, expected_type=type_hints["s3_configuration"])
+                check_type(argname="argument buffering_hints", value=buffering_hints, expected_type=type_hints["buffering_hints"])
                 check_type(argname="argument cloud_watch_logging_options", value=cloud_watch_logging_options, expected_type=type_hints["cloud_watch_logging_options"])
                 check_type(argname="argument hec_acknowledgment_timeout_in_seconds", value=hec_acknowledgment_timeout_in_seconds, expected_type=type_hints["hec_acknowledgment_timeout_in_seconds"])
                 check_type(argname="argument processing_configuration", value=processing_configuration, expected_type=type_hints["processing_configuration"])
@@ -5746,6 +5833,8 @@ class CfnDeliveryStream(
                 "hec_token": hec_token,
                 "s3_configuration": s3_configuration,
             }
+            if buffering_hints is not None:
+                self._values["buffering_hints"] = buffering_hints
             if cloud_watch_logging_options is not None:
                 self._values["cloud_watch_logging_options"] = cloud_watch_logging_options
             if hec_acknowledgment_timeout_in_seconds is not None:
@@ -5799,6 +5888,19 @@ class CfnDeliveryStream(
             assert result is not None, "Required property 's3_configuration' is missing"
             return typing.cast(typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.S3DestinationConfigurationProperty"], result)
 
+        @builtins.property
+        def buffering_hints(
+            self,
+        ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SplunkBufferingHintsProperty"]]:
+            '''The buffering options.
+
+            If no value is specified, the default values for Splunk are used.
+
+            :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-bufferinghints
+            '''
+            result = self._values.get("buffering_hints")
+            return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SplunkBufferingHintsProperty"]], result)
+
         @builtins.property
         def cloud_watch_logging_options(
             self,
@@ -6887,12 +6989,21 @@ def _typecheckingstub__706925197a1b663cd9be8234e85ce2780b58d7bf71737c801e0c39310
     """Type checking stubs"""
     pass
 
+def _typecheckingstub__60823c61f8aea3242c07551788af8f338bff46b6299ee9aa1d0ff6112c454ecc(
+    *,
+    interval_in_seconds: typing.Optional[jsii.Number] = None,
+    size_in_m_bs: typing.Optional[jsii.Number] = None,
+) -> None:
+    """Type checking stubs"""
+    pass
+
 def _typecheckingstub__be9923ea7818bcdc567ae6e06b529c44c6a3c42b59af06768977f4c55fdd20a6(
     *,
     hec_endpoint: builtins.str,
     hec_endpoint_type: builtins.str,
     hec_token: builtins.str,
     s3_configuration: typing.Union[_IResolvable_da3f097b, typing.Union[CfnDeliveryStream.S3DestinationConfigurationProperty, typing.Dict[builtins.str, typing.Any]]],
+    buffering_hints: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDeliveryStream.SplunkBufferingHintsProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
     cloud_watch_logging_options: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDeliveryStream.CloudWatchLoggingOptionsProperty, typing.Dict[builtins.str, typing.Any]]]] = None,
     hec_acknowledgment_timeout_in_seconds: typing.Optional[jsii.Number] = None,
     processing_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union[CfnDeliveryStream.ProcessingConfigurationProperty, typing.Dict[builtins.str, typing.Any]]]] = None,