aws-cdk-lib 2.168.0__py3-none-any.whl → 2.169.0__py3-none-any.whl

aws_cdk/aws_kinesisfirehose/__init__.py

@@ -139,7 +139,7 @@ class CfnDeliveryStream(
         :param id: Construct identifier for this resource (unique in its scope).
         :param amazon_open_search_serverless_destination_configuration: Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
         :param amazonopensearchservice_destination_configuration: The destination in Amazon OpenSearch Service. You can specify only one destination.
-        :param database_source_configuration: 
+        :param database_source_configuration: The top level object for configuring streams with database as a source. Amazon Data Firehose is in preview release and is subject to change.
         :param delivery_stream_encryption_configuration_input: Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
         :param delivery_stream_name: The name of the Firehose stream.
         :param delivery_stream_type: The Firehose stream type. This can be one of the following values:. - ``DirectPut`` : Provider applications access the Firehose stream directly. - ``KinesisStreamAsSource`` : The Firehose stream uses a Kinesis data stream as a source.
@@ -153,7 +153,7 @@ class CfnDeliveryStream(
         :param s3_destination_configuration: The ``S3DestinationConfiguration`` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires `some interruptions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt>`_ .
         :param snowflake_destination_configuration: Configure Snowflake destination.
         :param splunk_destination_configuration: The configuration of a destination in Splunk for the delivery stream.
-        :param tags: A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see `Using Cost Allocation Tags <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html>`_ in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a Firehose stream. If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following. *AccessDeniedException* User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy. For an example IAM policy, see `Tag example. <https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples>`_
+        :param tags: A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see `Using Cost Allocation Tags <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html>`_ in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a Firehose stream. If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following. *AccessDeniedException* User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy. For an example IAM policy, see `Tag example. <https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples>`_
         '''
         if __debug__:
             type_hints = typing.get_type_hints(_typecheckingstub__b3cd824a2680c7d043cac684bd1be9ca77e94201f1ba00785d60a50ff43c2288)
@@ -272,6 +272,7 @@ class CfnDeliveryStream(
     def database_source_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseSourceConfigurationProperty"]]:
+        '''The top level object for configuring streams with database as a source.'''
         return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseSourceConfigurationProperty"]], jsii.get(self, "databaseSourceConfiguration"))
 
     @database_source_configuration.setter
@@ -2042,7 +2043,10 @@ class CfnDeliveryStream(
             *,
             secrets_manager_configuration: typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.SecretsManagerConfigurationProperty", typing.Dict[builtins.str, typing.Any]]],
         ) -> None:
-            '''
+            '''The structure to configure the authentication methods for Firehose to connect to source database endpoint.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :param secrets_manager_configuration: 
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceauthenticationconfiguration.html
@@ -2130,20 +2134,23 @@ class CfnDeliveryStream(
             ssl_mode: typing.Optional[builtins.str] = None,
             surrogate_keys: typing.Optional[typing.Sequence[builtins.str]] = None,
         ) -> None:
-            '''
-            :param databases: 
-            :param database_source_authentication_configuration: 
-            :param database_source_vpc_configuration: 
-            :param endpoint: 
-            :param port: 
-            :param snapshot_watermark_table: 
-            :param tables: 
-            :param type: 
-            :param columns: 
+            '''The top level object for configuring streams with database as a source.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
+            :param databases: The list of database patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.
+            :param database_source_authentication_configuration: The structure to configure the authentication methods for Firehose to connect to source database endpoint. Amazon Data Firehose is in preview release and is subject to change.
+            :param database_source_vpc_configuration: The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database. Amazon Data Firehose is in preview release and is subject to change.
+            :param endpoint: The endpoint of the database server. Amazon Data Firehose is in preview release and is subject to change.
+            :param port: The port of the database. This can be one of the following values. - 3306 for MySQL database type - 5432 for PostgreSQL database type Amazon Data Firehose is in preview release and is subject to change.
+            :param snapshot_watermark_table: The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress. Amazon Data Firehose is in preview release and is subject to change.
+            :param tables: The list of table patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.
+            :param type: The type of database engine. This can be one of the following values. - MySQL - PostgreSQL Amazon Data Firehose is in preview release and is subject to change.
+            :param columns: The list of column patterns in source database endpoint for Firehose to read from. Amazon Data Firehose is in preview release and is subject to change.
             :param digest: 
             :param public_certificate: 
-            :param ssl_mode: 
-            :param surrogate_keys: 
+            :param ssl_mode: The mode to enable or disable SSL when Firehose connects to the database endpoint. Amazon Data Firehose is in preview release and is subject to change.
+            :param surrogate_keys: The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured. Amazon Data Firehose is in preview release and is subject to change.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -2231,7 +2238,10 @@ class CfnDeliveryStream(
         def databases(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabasesProperty"]:
-            '''
+            '''The list of database patterns in source database endpoint for Firehose to read from.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databases
             '''
             result = self._values.get("databases")
@@ -2242,7 +2252,10 @@ class CfnDeliveryStream(
         def database_source_authentication_configuration(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseSourceAuthenticationConfigurationProperty"]:
-            '''
+            '''The structure to configure the authentication methods for Firehose to connect to source database endpoint.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourceauthenticationconfiguration
             '''
             result = self._values.get("database_source_authentication_configuration")
@@ -2253,7 +2266,10 @@ class CfnDeliveryStream(
         def database_source_vpc_configuration(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseSourceVPCConfigurationProperty"]:
-            '''
+            '''The details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-databasesourcevpcconfiguration
             '''
             result = self._values.get("database_source_vpc_configuration")
@@ -2262,7 +2278,10 @@ class CfnDeliveryStream(
 
         @builtins.property
         def endpoint(self) -> builtins.str:
-            '''
+            '''The endpoint of the database server.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-endpoint
             '''
             result = self._values.get("endpoint")
@@ -2271,7 +2290,13 @@ class CfnDeliveryStream(
 
         @builtins.property
         def port(self) -> jsii.Number:
-            '''
+            '''The port of the database. This can be one of the following values.
+
+            - 3306 for MySQL database type
+            - 5432 for PostgreSQL database type
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-port
             '''
             result = self._values.get("port")
@@ -2280,7 +2305,10 @@ class CfnDeliveryStream(
 
         @builtins.property
         def snapshot_watermark_table(self) -> builtins.str:
-            '''
+            '''The fully qualified name of the table in source database endpoint that Firehose uses to track snapshot progress.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-snapshotwatermarktable
             '''
             result = self._values.get("snapshot_watermark_table")
@@ -2291,7 +2319,10 @@ class CfnDeliveryStream(
         def tables(
             self,
         ) -> typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseTablesProperty"]:
-            '''
+            '''The list of table patterns in source database endpoint for Firehose to read from.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-tables
             '''
             result = self._values.get("tables")
@@ -2300,7 +2331,13 @@ class CfnDeliveryStream(
 
         @builtins.property
         def type(self) -> builtins.str:
-            '''
+            '''The type of database engine. This can be one of the following values.
+
+            - MySQL
+            - PostgreSQL
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-type
             '''
             result = self._values.get("type")
@@ -2311,7 +2348,10 @@ class CfnDeliveryStream(
         def columns(
             self,
         ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DatabaseColumnsProperty"]]:
-            '''
+            '''The list of column patterns in source database endpoint for Firehose to read from.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-columns
             '''
             result = self._values.get("columns")
@@ -2335,7 +2375,10 @@ class CfnDeliveryStream(
 
         @builtins.property
         def ssl_mode(self) -> typing.Optional[builtins.str]:
-            '''
+            '''The mode to enable or disable SSL when Firehose connects to the database endpoint.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-sslmode
             '''
             result = self._values.get("ssl_mode")
@@ -2343,7 +2386,10 @@ class CfnDeliveryStream(
 
         @builtins.property
         def surrogate_keys(self) -> typing.Optional[typing.List[builtins.str]]:
-            '''
+            '''The optional list of table and column names used as unique key columns when taking snapshot if the tables don’t have primary keys configured.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourceconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration-surrogatekeys
             '''
             result = self._values.get("surrogate_keys")
@@ -2367,8 +2413,11 @@ class CfnDeliveryStream(
     )
     class DatabaseSourceVPCConfigurationProperty:
         def __init__(self, *, vpc_endpoint_service_name: builtins.str) -> None:
-            '''
-            :param vpc_endpoint_service_name: 
+            '''The structure for details of the VPC Endpoint Service which Firehose uses to create a PrivateLink to the database.
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
+            :param vpc_endpoint_service_name: The VPC endpoint service name which Firehose uses to create a PrivateLink to the database. The endpoint service must have the Firehose service principle ``firehose.amazonaws.com`` as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like ``com.amazonaws.vpce.<region>.<vpc-endpoint-service-id>`` . Amazon Data Firehose is in preview release and is subject to change.
 
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.html
             :exampleMetadata: fixture=_generated
@@ -2392,7 +2441,12 @@ class CfnDeliveryStream(
 
         @builtins.property
         def vpc_endpoint_service_name(self) -> builtins.str:
-            '''
+            '''The VPC endpoint service name which Firehose uses to create a PrivateLink to the database.
+
+            The endpoint service must have the Firehose service principle ``firehose.amazonaws.com`` as an allowed principal on the VPC endpoint service. The VPC endpoint service name is a string that looks like ``com.amazonaws.vpce.<region>.<vpc-endpoint-service-id>`` .
+
+            Amazon Data Firehose is in preview release and is subject to change.
+
             :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-databasesourcevpcconfiguration.html#cfn-kinesisfirehose-deliverystream-databasesourcevpcconfiguration-vpcendpointservicename
             '''
             result = self._values.get("vpc_endpoint_service_name")
@@ -8213,7 +8267,7 @@ class CfnDeliveryStreamProps:
 
         :param amazon_open_search_serverless_destination_configuration: Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
         :param amazonopensearchservice_destination_configuration: The destination in Amazon OpenSearch Service. You can specify only one destination.
-        :param database_source_configuration: 
+        :param database_source_configuration: The top level object for configuring streams with database as a source. Amazon Data Firehose is in preview release and is subject to change.
         :param delivery_stream_encryption_configuration_input: Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
         :param delivery_stream_name: The name of the Firehose stream.
         :param delivery_stream_type: The Firehose stream type. This can be one of the following values:. - ``DirectPut`` : Provider applications access the Firehose stream directly. - ``KinesisStreamAsSource`` : The Firehose stream uses a Kinesis data stream as a source.
@@ -8227,7 +8281,7 @@ class CfnDeliveryStreamProps:
         :param s3_destination_configuration: The ``S3DestinationConfiguration`` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon S3 destination to an Amazon ES destination, update requires `some interruptions <https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-some-interrupt>`_ .
         :param snowflake_destination_configuration: Configure Snowflake destination.
         :param splunk_destination_configuration: The configuration of a destination in Splunk for the delivery stream.
-        :param tags: A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see `Using Cost Allocation Tags <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html>`_ in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a Firehose stream. If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following. *AccessDeniedException* User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy. For an example IAM policy, see `Tag example. <https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples>`_
+        :param tags: A set of tags to assign to the Firehose stream. A tag is a key-value pair that you can define and assign to AWS resources. Tags are metadata. For example, you can add friendly names and descriptions or other types of information that can help you distinguish the Firehose stream. For more information about tags, see `Using Cost Allocation Tags <https://docs.aws.amazon.com/awsaccountbilling/latest/aboutv2/cost-alloc-tags.html>`_ in the AWS Billing and Cost Management User Guide. You can specify up to 50 tags when creating a Firehose stream. If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following. *AccessDeniedException* User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy. For an example IAM policy, see `Tag example. <https://docs.aws.amazon.com/firehose/latest/APIReference/API_CreateDeliveryStream.html#API_CreateDeliveryStream_Examples>`_
 
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html
         :exampleMetadata: infused
@@ -8337,7 +8391,10 @@ class CfnDeliveryStreamProps:
     def database_source_configuration(
         self,
     ) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDeliveryStream.DatabaseSourceConfigurationProperty]]:
-        '''
+        '''The top level object for configuring streams with database as a source.
+
+        Amazon Data Firehose is in preview release and is subject to change.
+
         :see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration
         '''
         result = self._values.get("database_source_configuration")
@@ -8511,7 +8568,7 @@ class CfnDeliveryStreamProps:
 
         You can specify up to 50 tags when creating a Firehose stream.
 
-        If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following.
+        If you specify tags in the ``CreateDeliveryStream`` action, Amazon Data Firehose performs an additional authorization on the ``firehose:TagDeliveryStream`` action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an ``AccessDeniedException`` such as following.
 
         *AccessDeniedException*