aws-cdk-lib 2.128.0__py3-none-any.whl → 2.129.0__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Potentially problematic release.
This version of aws-cdk-lib might be problematic. Click here for more details.
- aws_cdk/__init__.py +2 -10
- aws_cdk/_jsii/__init__.py +1 -1
- aws_cdk/_jsii/{aws-cdk-lib@2.128.0.jsii.tgz → aws-cdk-lib@2.129.0.jsii.tgz} +0 -0
- aws_cdk/aws_amazonmq/__init__.py +6 -24
- aws_cdk/aws_amplify/__init__.py +1 -2
- aws_cdk/aws_appconfig/__init__.py +0 -16
- aws_cdk/aws_applicationautoscaling/__init__.py +55 -22
- aws_cdk/aws_appstream/__init__.py +14 -14
- aws_cdk/aws_appsync/__init__.py +334 -3
- aws_cdk/aws_autoscaling/__init__.py +11 -7
- aws_cdk/aws_batch/__init__.py +137 -16
- aws_cdk/aws_cleanrooms/__init__.py +1 -2
- aws_cdk/aws_cloudformation/__init__.py +2 -10
- aws_cdk/aws_cloudfront/__init__.py +15 -8
- aws_cdk/aws_cloudfront/experimental/__init__.py +22 -0
- aws_cdk/aws_cloudfront_origins/__init__.py +332 -0
- aws_cdk/aws_cloudtrail/__init__.py +12 -2
- aws_cdk/aws_cloudwatch/__init__.py +4 -0
- aws_cdk/aws_codepipeline/__init__.py +463 -11
- aws_cdk/aws_cognito/__init__.py +0 -9
- aws_cdk/aws_config/__init__.py +2 -2
- aws_cdk/aws_connect/__init__.py +6 -1
- aws_cdk/aws_controltower/__init__.py +527 -7
- aws_cdk/aws_datasync/__init__.py +2 -2
- aws_cdk/aws_directoryservice/__init__.py +2 -3
- aws_cdk/aws_dynamodb/__init__.py +7 -0
- aws_cdk/aws_ec2/__init__.py +117 -210
- aws_cdk/aws_ecs/__init__.py +537 -3
- aws_cdk/aws_eks/__init__.py +1 -1
- aws_cdk/aws_elasticache/__init__.py +27 -20
- aws_cdk/aws_elasticloadbalancingv2/__init__.py +3 -4
- aws_cdk/aws_emr/__init__.py +23 -3
- aws_cdk/aws_events_targets/__init__.py +64 -20
- aws_cdk/aws_fis/__init__.py +4 -4
- aws_cdk/aws_frauddetector/__init__.py +3 -3
- aws_cdk/aws_globalaccelerator/__init__.py +2 -6
- aws_cdk/aws_glue/__init__.py +84 -55
- aws_cdk/aws_groundstation/__init__.py +8 -12
- aws_cdk/aws_guardduty/__init__.py +74 -70
- aws_cdk/aws_iam/__init__.py +16 -23
- aws_cdk/aws_imagebuilder/__init__.py +178 -156
- aws_cdk/aws_internetmonitor/__init__.py +12 -10
- aws_cdk/aws_iot/__init__.py +17 -10
- aws_cdk/aws_iotevents/__init__.py +4 -4
- aws_cdk/aws_iotfleetwise/__init__.py +10 -5
- aws_cdk/aws_iottwinmaker/__init__.py +3 -5
- aws_cdk/aws_iotwireless/__init__.py +35 -23
- aws_cdk/aws_kendra/__init__.py +36 -15
- aws_cdk/aws_kinesisfirehose/__init__.py +155 -114
- aws_cdk/aws_lambda/__init__.py +157 -12
- aws_cdk/aws_lambda_nodejs/__init__.py +22 -0
- aws_cdk/aws_lightsail/__init__.py +14 -18
- aws_cdk/aws_logs/__init__.py +15 -15
- aws_cdk/aws_mediaconnect/__init__.py +5 -3
- aws_cdk/aws_medialive/__init__.py +3 -12
- aws_cdk/aws_mediapackagev2/__init__.py +287 -286
- aws_cdk/aws_mediatailor/__init__.py +2 -2
- aws_cdk/aws_memorydb/__init__.py +2 -2
- aws_cdk/aws_msk/__init__.py +6 -3
- aws_cdk/aws_mwaa/__init__.py +10 -5
- aws_cdk/aws_neptunegraph/__init__.py +84 -66
- aws_cdk/aws_networkfirewall/__init__.py +5 -8
- aws_cdk/aws_networkmanager/__init__.py +3 -3
- aws_cdk/aws_nimblestudio/__init__.py +2 -4
- aws_cdk/aws_opensearchservice/__init__.py +6 -7
- aws_cdk/aws_osis/__init__.py +1 -3
- aws_cdk/aws_pinpoint/__init__.py +5 -5
- aws_cdk/aws_pipes/__init__.py +5 -5
- aws_cdk/aws_quicksight/__init__.py +5 -10
- aws_cdk/aws_rds/__init__.py +38 -21
- aws_cdk/aws_redshift/__init__.py +9 -5
- aws_cdk/aws_redshiftserverless/__init__.py +62 -38
- aws_cdk/aws_rolesanywhere/__init__.py +41 -53
- aws_cdk/aws_route53/__init__.py +532 -6
- aws_cdk/aws_route53recoverycontrol/__init__.py +1 -3
- aws_cdk/aws_route53recoveryreadiness/__init__.py +2 -2
- aws_cdk/aws_route53resolver/__init__.py +1 -4
- aws_cdk/aws_s3/__init__.py +3 -1
- aws_cdk/aws_s3objectlambda/__init__.py +7 -4
- aws_cdk/aws_s3outposts/__init__.py +1 -1
- aws_cdk/aws_sagemaker/__init__.py +111 -11
- aws_cdk/aws_servicecatalogappregistry/__init__.py +3 -3
- aws_cdk/aws_sns/__init__.py +185 -38
- aws_cdk/aws_ssm/__init__.py +16 -16
- aws_cdk/aws_ssmincidents/__init__.py +1 -1
- aws_cdk/aws_synthetics/__init__.py +94 -21
- aws_cdk/aws_verifiedpermissions/__init__.py +1 -2
- aws_cdk/aws_vpclattice/__init__.py +8 -4
- aws_cdk/aws_wafv2/__init__.py +14 -59
- aws_cdk/aws_workspaces/__init__.py +5 -4
- aws_cdk/aws_workspacesweb/__init__.py +6 -12
- aws_cdk/triggers/__init__.py +22 -0
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/METADATA +1 -1
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/RECORD +98 -98
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/LICENSE +0 -0
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/NOTICE +0 -0
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/WHEEL +0 -0
- {aws_cdk_lib-2.128.0.dist-info → aws_cdk_lib-2.129.0.dist-info}/top_level.txt +0 -0
|
@@ -129,7 +129,7 @@ class CfnDeliveryStream(
|
|
|
129
129
|
:param msk_source_configuration: The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
|
|
130
130
|
:param redshift_destination_configuration: An Amazon Redshift destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Redshift 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>`_ .
|
|
131
131
|
: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>`_ .
|
|
132
|
-
:param snowflake_destination_configuration:
|
|
132
|
+
:param snowflake_destination_configuration: Configure Snowflake destination.
|
|
133
133
|
:param splunk_destination_configuration: The configuration of a destination in Splunk for the delivery stream.
|
|
134
134
|
:param tags: A set of tags to assign to the delivery 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 delivery 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 delivery stream.
|
|
135
135
|
'''
|
|
@@ -421,6 +421,7 @@ class CfnDeliveryStream(
|
|
|
421
421
|
def snowflake_destination_configuration(
|
|
422
422
|
self,
|
|
423
423
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SnowflakeDestinationConfigurationProperty"]]:
|
|
424
|
+
'''Configure Snowflake destination.'''
|
|
424
425
|
return typing.cast(typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SnowflakeDestinationConfigurationProperty"]], jsii.get(self, "snowflakeDestinationConfiguration"))
|
|
425
426
|
|
|
426
427
|
@snowflake_destination_configuration.setter
|
|
@@ -577,14 +578,14 @@ class CfnDeliveryStream(
|
|
|
577
578
|
'''Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
|
|
578
579
|
|
|
579
580
|
:param index_name: The Serverless offering for Amazon OpenSearch Service index name.
|
|
580
|
-
:param role_arn: The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
|
581
|
+
:param role_arn: The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
581
582
|
:param s3_configuration:
|
|
582
583
|
:param buffering_hints: The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
|
|
583
584
|
:param cloud_watch_logging_options:
|
|
584
585
|
:param collection_endpoint: The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
|
|
585
586
|
:param processing_configuration:
|
|
586
|
-
:param retry_options: The retry behavior in case
|
|
587
|
-
:param s3_backup_mode: Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
|
|
587
|
+
:param retry_options: The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service. The default value is 300 (5 minutes).
|
|
588
|
+
:param s3_backup_mode: Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
|
588
589
|
:param vpc_configuration:
|
|
589
590
|
|
|
590
591
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html
|
|
@@ -702,7 +703,7 @@ class CfnDeliveryStream(
|
|
|
702
703
|
|
|
703
704
|
@builtins.property
|
|
704
705
|
def role_arn(self) -> builtins.str:
|
|
705
|
-
'''The Amazon Resource Name (ARN) of the IAM role to be assumed by
|
|
706
|
+
'''The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
|
|
706
707
|
|
|
707
708
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-rolearn
|
|
708
709
|
'''
|
|
@@ -767,7 +768,7 @@ class CfnDeliveryStream(
|
|
|
767
768
|
def retry_options(
|
|
768
769
|
self,
|
|
769
770
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.AmazonOpenSearchServerlessRetryOptionsProperty"]]:
|
|
770
|
-
'''The retry behavior in case
|
|
771
|
+
'''The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
|
|
771
772
|
|
|
772
773
|
The default value is 300 (5 minutes).
|
|
773
774
|
|
|
@@ -780,7 +781,7 @@ class CfnDeliveryStream(
|
|
|
780
781
|
def s3_backup_mode(self) -> typing.Optional[builtins.str]:
|
|
781
782
|
'''Defines how documents should be delivered to Amazon S3.
|
|
782
783
|
|
|
783
|
-
When it is set to FailedDocumentsOnly,
|
|
784
|
+
When it is set to FailedDocumentsOnly, Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
|
|
784
785
|
|
|
785
786
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration-s3backupmode
|
|
786
787
|
'''
|
|
@@ -819,9 +820,9 @@ class CfnDeliveryStream(
|
|
|
819
820
|
*,
|
|
820
821
|
duration_in_seconds: typing.Optional[jsii.Number] = None,
|
|
821
822
|
) -> None:
|
|
822
|
-
'''Configures retry behavior in case
|
|
823
|
+
'''Configures retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
|
|
823
824
|
|
|
824
|
-
:param duration_in_seconds: After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which
|
|
825
|
+
:param duration_in_seconds: After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt). After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
|
|
825
826
|
|
|
826
827
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchserverlessretryoptions.html
|
|
827
828
|
:exampleMetadata: fixture=_generated
|
|
@@ -845,7 +846,7 @@ class CfnDeliveryStream(
|
|
|
845
846
|
|
|
846
847
|
@builtins.property
|
|
847
848
|
def duration_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
848
|
-
'''After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which
|
|
849
|
+
'''After an initial failure to deliver to the Serverless offering for Amazon OpenSearch Service, the total amount of time during which Firehose retries delivery (including the first attempt).
|
|
849
850
|
|
|
850
851
|
After this time has elapsed, the failed documents are written to Amazon S3. Default value is 300 seconds (5 minutes). A value of 0 (zero) results in no retries.
|
|
851
852
|
|
|
@@ -989,7 +990,7 @@ class CfnDeliveryStream(
|
|
|
989
990
|
:param buffering_hints: The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
|
|
990
991
|
:param cloud_watch_logging_options: Describes the Amazon CloudWatch logging options for your delivery stream.
|
|
991
992
|
:param cluster_endpoint: The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
|
|
992
|
-
:param document_id_options: Indicates the method for setting up document ID. The supported methods are
|
|
993
|
+
:param document_id_options: Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
|
993
994
|
:param domain_arn: The ARN of the Amazon OpenSearch Service domain.
|
|
994
995
|
:param index_rotation_period: The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
|
|
995
996
|
:param processing_configuration: Describes a data processing configuration.
|
|
@@ -1192,7 +1193,7 @@ class CfnDeliveryStream(
|
|
|
1192
1193
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DocumentIdOptionsProperty"]]:
|
|
1193
1194
|
'''Indicates the method for setting up document ID.
|
|
1194
1195
|
|
|
1195
|
-
The supported methods are
|
|
1196
|
+
The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
|
1196
1197
|
|
|
1197
1198
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration-documentidoptions
|
|
1198
1199
|
'''
|
|
@@ -1705,8 +1706,8 @@ class CfnDeliveryStream(
|
|
|
1705
1706
|
Kinesis Data Firehose uses the serializer and deserializer that you specify, in addition to the column information from the AWS Glue table, to deserialize your input data from JSON and then serialize it to the Parquet or ORC format. For more information, see `Kinesis Data Firehose Record Format Conversion <https://docs.aws.amazon.com/firehose/latest/dev/record-format-conversion.html>`_ .
|
|
1706
1707
|
|
|
1707
1708
|
:param enabled: Defaults to ``true`` . Set it to ``false`` if you want to disable format conversion while preserving the configuration details.
|
|
1708
|
-
:param input_format_configuration: Specifies the deserializer that you want
|
|
1709
|
-
:param output_format_configuration: Specifies the serializer that you want
|
|
1709
|
+
:param input_format_configuration: Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON. This parameter is required if ``Enabled`` is set to true.
|
|
1710
|
+
:param output_format_configuration: Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format. This parameter is required if ``Enabled`` is set to true.
|
|
1710
1711
|
:param schema_configuration: Specifies the AWS Glue Data Catalog table that contains the column information. This parameter is required if ``Enabled`` is set to true.
|
|
1711
1712
|
|
|
1712
1713
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-dataformatconversionconfiguration.html
|
|
@@ -1801,7 +1802,7 @@ class CfnDeliveryStream(
|
|
|
1801
1802
|
def input_format_configuration(
|
|
1802
1803
|
self,
|
|
1803
1804
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.InputFormatConfigurationProperty"]]:
|
|
1804
|
-
'''Specifies the deserializer that you want
|
|
1805
|
+
'''Specifies the deserializer that you want Firehose to use to convert the format of your data from JSON.
|
|
1805
1806
|
|
|
1806
1807
|
This parameter is required if ``Enabled`` is set to true.
|
|
1807
1808
|
|
|
@@ -1814,7 +1815,7 @@ class CfnDeliveryStream(
|
|
|
1814
1815
|
def output_format_configuration(
|
|
1815
1816
|
self,
|
|
1816
1817
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.OutputFormatConfigurationProperty"]]:
|
|
1817
|
-
'''Specifies the serializer that you want
|
|
1818
|
+
'''Specifies the serializer that you want Firehose to use to convert the format of your data to the Parquet or ORC format.
|
|
1818
1819
|
|
|
1819
1820
|
This parameter is required if ``Enabled`` is set to true.
|
|
1820
1821
|
|
|
@@ -1862,7 +1863,7 @@ class CfnDeliveryStream(
|
|
|
1862
1863
|
'''Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
|
1863
1864
|
|
|
1864
1865
|
:param key_type: Indicates the type of customer master key (CMK) to use for encryption. The default setting is ``AWS_OWNED_CMK`` . For more information about CMKs, see `Customer Master Keys (CMKs) <https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#master_keys>`_ . You can use a CMK of type CUSTOMER_MANAGED_CMK to encrypt up to 500 delivery streams. .. epigraph:: To encrypt your delivery stream, use symmetric CMKs. Kinesis Data Firehose doesn't support asymmetric CMKs. For information about symmetric and asymmetric CMKs, see `About Symmetric and Asymmetric CMKs <https://docs.aws.amazon.com/kms/latest/developerguide/symm-asymm-concepts.html>`_ in the AWS Key Management Service developer guide.
|
|
1865
|
-
:param key_arn: If you set ``KeyType`` to ``CUSTOMER_MANAGED_CMK`` , you must specify the Amazon Resource Name (ARN) of the CMK. If you set ``KeyType`` to ``AWS _OWNED_CMK`` ,
|
|
1866
|
+
:param key_arn: If you set ``KeyType`` to ``CUSTOMER_MANAGED_CMK`` , you must specify the Amazon Resource Name (ARN) of the CMK. If you set ``KeyType`` to ``AWS _OWNED_CMK`` , Firehose uses a service-account CMK.
|
|
1866
1867
|
|
|
1867
1868
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html
|
|
1868
1869
|
:exampleMetadata: fixture=_generated
|
|
@@ -1911,7 +1912,7 @@ class CfnDeliveryStream(
|
|
|
1911
1912
|
def key_arn(self) -> typing.Optional[builtins.str]:
|
|
1912
1913
|
'''If you set ``KeyType`` to ``CUSTOMER_MANAGED_CMK`` , you must specify the Amazon Resource Name (ARN) of the CMK.
|
|
1913
1914
|
|
|
1914
|
-
If you set ``KeyType`` to ``AWS _OWNED_CMK`` ,
|
|
1915
|
+
If you set ``KeyType`` to ``AWS _OWNED_CMK`` , Firehose uses a service-account CMK.
|
|
1915
1916
|
|
|
1916
1917
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput-keyarn
|
|
1917
1918
|
'''
|
|
@@ -1948,8 +1949,8 @@ class CfnDeliveryStream(
|
|
|
1948
1949
|
|
|
1949
1950
|
Kinesis Data Firehose then serializes the data to its final format using the ``Serializer`` . Kinesis Data Firehose supports two types of deserializers: the `Apache Hive JSON SerDe <https://docs.aws.amazon.com/https://cwiki.apache.org/confluence/display/Hive/LanguageManual+DDL#LanguageManualDDL-JSON>`_ and the `OpenX JSON SerDe <https://docs.aws.amazon.com/https://github.com/rcongiu/Hive-JSON-Serde>`_ .
|
|
1950
1951
|
|
|
1951
|
-
:param hive_json_ser_de: The native Hive / HCatalog JsonSerDe. Used by
|
|
1952
|
-
:param open_x_json_ser_de: The OpenX SerDe. Used by
|
|
1952
|
+
:param hive_json_ser_de: The native Hive / HCatalog JsonSerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
|
|
1953
|
+
:param open_x_json_ser_de: The OpenX SerDe. Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
|
|
1953
1954
|
|
|
1954
1955
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html
|
|
1955
1956
|
:exampleMetadata: fixture=_generated
|
|
@@ -1989,7 +1990,7 @@ class CfnDeliveryStream(
|
|
|
1989
1990
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.HiveJsonSerDeProperty"]]:
|
|
1990
1991
|
'''The native Hive / HCatalog JsonSerDe.
|
|
1991
1992
|
|
|
1992
|
-
Used by
|
|
1993
|
+
Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
|
|
1993
1994
|
|
|
1994
1995
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-hivejsonserde
|
|
1995
1996
|
'''
|
|
@@ -2002,7 +2003,7 @@ class CfnDeliveryStream(
|
|
|
2002
2003
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.OpenXJsonSerDeProperty"]]:
|
|
2003
2004
|
'''The OpenX SerDe.
|
|
2004
2005
|
|
|
2005
|
-
Used by
|
|
2006
|
+
Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
|
|
2006
2007
|
|
|
2007
2008
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-deserializer.html#cfn-kinesisfirehose-deliverystream-deserializer-openxjsonserde
|
|
2008
2009
|
'''
|
|
@@ -2029,9 +2030,9 @@ class CfnDeliveryStream(
|
|
|
2029
2030
|
def __init__(self, *, default_document_id_format: builtins.str) -> None:
|
|
2030
2031
|
'''Indicates the method for setting up document ID.
|
|
2031
2032
|
|
|
2032
|
-
The supported methods are
|
|
2033
|
+
The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
|
2033
2034
|
|
|
2034
|
-
:param default_document_id_format: When the ``FIREHOSE_DEFAULT`` option is chosen,
|
|
2035
|
+
:param default_document_id_format: When the ``FIREHOSE_DEFAULT`` option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier. The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs. When the ``NO_DOCUMENT_ID`` option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
|
|
2035
2036
|
|
|
2036
2037
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html
|
|
2037
2038
|
:exampleMetadata: fixture=_generated
|
|
@@ -2055,11 +2056,11 @@ class CfnDeliveryStream(
|
|
|
2055
2056
|
|
|
2056
2057
|
@builtins.property
|
|
2057
2058
|
def default_document_id_format(self) -> builtins.str:
|
|
2058
|
-
'''When the ``FIREHOSE_DEFAULT`` option is chosen,
|
|
2059
|
+
'''When the ``FIREHOSE_DEFAULT`` option is chosen, Firehose generates a unique document ID for each record based on a unique internal identifier.
|
|
2059
2060
|
|
|
2060
2061
|
The generated document ID is stable across multiple delivery attempts, which helps prevent the same record from being indexed multiple times with different document IDs.
|
|
2061
2062
|
|
|
2062
|
-
When the ``NO_DOCUMENT_ID`` option is chosen,
|
|
2063
|
+
When the ``NO_DOCUMENT_ID`` option is chosen, Firehose does not include any document IDs in the requests it sends to the Amazon OpenSearch Service. This causes the Amazon OpenSearch Service domain to generate document IDs. In case of multiple delivery attempts, this may cause the same record to be indexed more than once with different document IDs. This option enables write-heavy operations, such as the ingestion of logs and observability data, to consume less resources in the Amazon OpenSearch Service domain, resulting in improved performance.
|
|
2063
2064
|
|
|
2064
2065
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-documentidoptions.html#cfn-kinesisfirehose-deliverystream-documentidoptions-defaultdocumentidformat
|
|
2065
2066
|
'''
|
|
@@ -2282,7 +2283,7 @@ class CfnDeliveryStream(
|
|
|
2282
2283
|
:param buffering_hints: Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.
|
|
2283
2284
|
:param cloud_watch_logging_options: The Amazon CloudWatch Logs logging options for the delivery stream.
|
|
2284
2285
|
:param cluster_endpoint: The endpoint to use when communicating with the cluster. Specify either this ``ClusterEndpoint`` or the ``DomainARN`` field.
|
|
2285
|
-
:param document_id_options: Indicates the method for setting up document ID. The supported methods are
|
|
2286
|
+
:param document_id_options: Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
|
2286
2287
|
:param domain_arn: The ARN of the Amazon ES domain. The IAM role must have permissions for ``DescribeElasticsearchDomain`` , ``DescribeElasticsearchDomains`` , and ``DescribeElasticsearchDomainConfig`` after assuming the role specified in *RoleARN* . Specify either ``ClusterEndpoint`` or ``DomainARN`` .
|
|
2287
2288
|
:param index_rotation_period: The frequency of Elasticsearch index rotation. If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see `Index Rotation for the Amazon ES Destination <https://docs.aws.amazon.com/firehose/latest/dev/basic-deliver.html#es-index-rotation>`_ in the *Amazon Kinesis Data Firehose Developer Guide* .
|
|
2288
2289
|
:param processing_configuration: The data processing configuration for the Kinesis Data Firehose delivery stream.
|
|
@@ -2485,7 +2486,7 @@ class CfnDeliveryStream(
|
|
|
2485
2486
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.DocumentIdOptionsProperty"]]:
|
|
2486
2487
|
'''Indicates the method for setting up document ID.
|
|
2487
2488
|
|
|
2488
|
-
The supported methods are
|
|
2489
|
+
The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
|
|
2489
2490
|
|
|
2490
2491
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration-documentidoptions
|
|
2491
2492
|
'''
|
|
@@ -3108,9 +3109,9 @@ class CfnDeliveryStream(
|
|
|
3108
3109
|
) -> None:
|
|
3109
3110
|
'''The native Hive / HCatalog JsonSerDe.
|
|
3110
3111
|
|
|
3111
|
-
Used by
|
|
3112
|
+
Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the OpenX SerDe.
|
|
3112
3113
|
|
|
3113
|
-
:param timestamp_formats: Indicates how you want
|
|
3114
|
+
:param timestamp_formats: Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON. To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see `Class DateTimeFormat <https://docs.aws.amazon.com/https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html>`_ . You can also use the special value ``millis`` to parse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses ``java.sql.Timestamp::valueOf`` by default.
|
|
3114
3115
|
|
|
3115
3116
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html
|
|
3116
3117
|
:exampleMetadata: fixture=_generated
|
|
@@ -3134,9 +3135,9 @@ class CfnDeliveryStream(
|
|
|
3134
3135
|
|
|
3135
3136
|
@builtins.property
|
|
3136
3137
|
def timestamp_formats(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
3137
|
-
'''Indicates how you want
|
|
3138
|
+
'''Indicates how you want Firehose to parse the date and timestamps that may be present in your input data JSON.
|
|
3138
3139
|
|
|
3139
|
-
To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see `Class DateTimeFormat <https://docs.aws.amazon.com/https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html>`_ . You can also use the special value ``millis`` to parse timestamps in epoch milliseconds. If you don't specify a format,
|
|
3140
|
+
To specify these format strings, follow the pattern syntax of JodaTime's DateTimeFormat format strings. For more information, see `Class DateTimeFormat <https://docs.aws.amazon.com/https://www.joda.org/joda-time/apidocs/org/joda/time/format/DateTimeFormat.html>`_ . You can also use the special value ``millis`` to parse timestamps in epoch milliseconds. If you don't specify a format, Firehose uses ``java.sql.Timestamp::valueOf`` by default.
|
|
3140
3141
|
|
|
3141
3142
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-hivejsonserde.html#cfn-kinesisfirehose-deliverystream-hivejsonserde-timestampformats
|
|
3142
3143
|
'''
|
|
@@ -3976,11 +3977,11 @@ class CfnDeliveryStream(
|
|
|
3976
3977
|
) -> None:
|
|
3977
3978
|
'''The OpenX SerDe.
|
|
3978
3979
|
|
|
3979
|
-
Used by
|
|
3980
|
+
Used by Firehose for deserializing data, which means converting it from the JSON format in preparation for serializing it to the Parquet or ORC format. This is one of two deserializers you can choose, depending on which one offers the functionality you need. The other option is the native Hive / HCatalog JsonSerDe.
|
|
3980
3981
|
|
|
3981
|
-
:param case_insensitive: When set to ``true`` , which is the default,
|
|
3982
|
+
:param case_insensitive: When set to ``true`` , which is the default, Firehose converts JSON keys to lowercase before deserializing them.
|
|
3982
3983
|
:param column_to_json_key_mappings: Maps column names to JSON keys that aren't identical to the column names. This is useful when the JSON contains keys that are Hive keywords. For example, ``timestamp`` is a Hive keyword. If you have a JSON key named ``timestamp`` , set this parameter to ``{"ts": "timestamp"}`` to map this key to a column named ``ts`` .
|
|
3983
|
-
:param convert_dots_in_json_keys_to_underscores: When set to ``true`` , specifies that the names of the keys include dots and that you want
|
|
3984
|
+
:param convert_dots_in_json_keys_to_underscores: When set to ``true`` , specifies that the names of the keys include dots and that you want Firehose to replace them with underscores. This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option. The default is ``false`` .
|
|
3984
3985
|
|
|
3985
3986
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html
|
|
3986
3987
|
:exampleMetadata: fixture=_generated
|
|
@@ -4016,7 +4017,7 @@ class CfnDeliveryStream(
|
|
|
4016
4017
|
def case_insensitive(
|
|
4017
4018
|
self,
|
|
4018
4019
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4019
|
-
'''When set to ``true`` , which is the default,
|
|
4020
|
+
'''When set to ``true`` , which is the default, Firehose converts JSON keys to lowercase before deserializing them.
|
|
4020
4021
|
|
|
4021
4022
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-openxjsonserde.html#cfn-kinesisfirehose-deliverystream-openxjsonserde-caseinsensitive
|
|
4022
4023
|
'''
|
|
@@ -4040,7 +4041,7 @@ class CfnDeliveryStream(
|
|
|
4040
4041
|
def convert_dots_in_json_keys_to_underscores(
|
|
4041
4042
|
self,
|
|
4042
4043
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
4043
|
-
'''When set to ``true`` , specifies that the names of the keys include dots and that you want
|
|
4044
|
+
'''When set to ``true`` , specifies that the names of the keys include dots and that you want Firehose to replace them with underscores.
|
|
4044
4045
|
|
|
4045
4046
|
This is useful because Apache Hive does not allow dots in column names. For example, if the JSON contains a key whose name is "a.b", you can define the column name to be "a_b" when using this option.
|
|
4046
4047
|
|
|
@@ -4097,8 +4098,8 @@ class CfnDeliveryStream(
|
|
|
4097
4098
|
|
|
4098
4099
|
For more information, see `Apache ORC <https://docs.aws.amazon.com/https://orc.apache.org/docs/>`_ .
|
|
4099
4100
|
|
|
4100
|
-
:param block_size_bytes: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB.
|
|
4101
|
-
:param bloom_filter_columns: The column names for which you want
|
|
4101
|
+
:param block_size_bytes: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
|
|
4102
|
+
:param bloom_filter_columns: The column names for which you want Firehose to create bloom filters. The default is ``null`` .
|
|
4102
4103
|
:param bloom_filter_false_positive_probability: The Bloom filter false positive probability (FPP). The lower the FPP, the bigger the Bloom filter. The default value is 0.05, the minimum is 0, and the maximum is 1.
|
|
4103
4104
|
:param compression: The compression code to use over data blocks. The default is ``SNAPPY`` .
|
|
4104
4105
|
:param dictionary_key_threshold: Represents the fraction of the total number of non-null rows. To turn off dictionary encoding, set this fraction to a number that is less than the number of distinct keys in a dictionary. To always use dictionary encoding, set this threshold to 1.
|
|
@@ -4168,7 +4169,7 @@ class CfnDeliveryStream(
|
|
|
4168
4169
|
def block_size_bytes(self) -> typing.Optional[jsii.Number]:
|
|
4169
4170
|
'''The Hadoop Distributed File System (HDFS) block size.
|
|
4170
4171
|
|
|
4171
|
-
This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB.
|
|
4172
|
+
This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
|
|
4172
4173
|
|
|
4173
4174
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-orcserde.html#cfn-kinesisfirehose-deliverystream-orcserde-blocksizebytes
|
|
4174
4175
|
'''
|
|
@@ -4177,7 +4178,7 @@ class CfnDeliveryStream(
|
|
|
4177
4178
|
|
|
4178
4179
|
@builtins.property
|
|
4179
4180
|
def bloom_filter_columns(self) -> typing.Optional[typing.List[builtins.str]]:
|
|
4180
|
-
'''The column names for which you want
|
|
4181
|
+
'''The column names for which you want Firehose to create bloom filters.
|
|
4181
4182
|
|
|
4182
4183
|
The default is ``null`` .
|
|
4183
4184
|
|
|
@@ -4304,7 +4305,7 @@ class CfnDeliveryStream(
|
|
|
4304
4305
|
*,
|
|
4305
4306
|
serializer: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.SerializerProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
4306
4307
|
) -> None:
|
|
4307
|
-
'''Specifies the serializer that you want
|
|
4308
|
+
'''Specifies the serializer that you want Firehose to use to convert the format of your data before it writes it to Amazon S3.
|
|
4308
4309
|
|
|
4309
4310
|
This parameter is required if ``Enabled`` is set to true.
|
|
4310
4311
|
|
|
@@ -4402,7 +4403,7 @@ class CfnDeliveryStream(
|
|
|
4402
4403
|
|
|
4403
4404
|
For more information, see `Apache Parquet <https://docs.aws.amazon.com/https://parquet.apache.org/documentation/latest/>`_ .
|
|
4404
4405
|
|
|
4405
|
-
:param block_size_bytes: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB.
|
|
4406
|
+
:param block_size_bytes: The Hadoop Distributed File System (HDFS) block size. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
|
|
4406
4407
|
:param compression: The compression code to use over data blocks. The possible values are ``UNCOMPRESSED`` , ``SNAPPY`` , and ``GZIP`` , with the default being ``SNAPPY`` . Use ``SNAPPY`` for higher decompression speed. Use ``GZIP`` if the compression ratio is more important than speed.
|
|
4407
4408
|
:param enable_dictionary_compression: Indicates whether to enable dictionary compression.
|
|
4408
4409
|
:param max_padding_bytes: The maximum amount of padding to apply. This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 0.
|
|
@@ -4453,7 +4454,7 @@ class CfnDeliveryStream(
|
|
|
4453
4454
|
def block_size_bytes(self) -> typing.Optional[jsii.Number]:
|
|
4454
4455
|
'''The Hadoop Distributed File System (HDFS) block size.
|
|
4455
4456
|
|
|
4456
|
-
This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB.
|
|
4457
|
+
This is useful if you intend to copy the data from Amazon S3 to HDFS before querying. The default is 256 MiB and the minimum is 64 MiB. Firehose uses this value for padding calculations.
|
|
4457
4458
|
|
|
4458
4459
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-parquetserde.html#cfn-kinesisfirehose-deliverystream-parquetserde-blocksizebytes
|
|
4459
4460
|
'''
|
|
@@ -4807,7 +4808,7 @@ class CfnDeliveryStream(
|
|
|
4807
4808
|
:param username: The Amazon Redshift user that has permission to access the Amazon Redshift cluster. This user must have ``INSERT`` privileges for copying data from the Amazon S3 bucket to the cluster.
|
|
4808
4809
|
:param cloud_watch_logging_options: The CloudWatch logging options for your delivery stream.
|
|
4809
4810
|
:param processing_configuration: The data processing configuration for the Kinesis Data Firehose delivery stream.
|
|
4810
|
-
:param retry_options: The retry behavior in case
|
|
4811
|
+
:param retry_options: The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift. Default value is 3600 (60 minutes).
|
|
4811
4812
|
:param s3_backup_configuration: The configuration for backup in Amazon S3.
|
|
4812
4813
|
:param s3_backup_mode: The Amazon S3 backup mode. After you create a delivery stream, you can update it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't update the delivery stream to disable it.
|
|
4813
4814
|
|
|
@@ -5033,7 +5034,7 @@ class CfnDeliveryStream(
|
|
|
5033
5034
|
def retry_options(
|
|
5034
5035
|
self,
|
|
5035
5036
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.RedshiftRetryOptionsProperty"]]:
|
|
5036
|
-
'''The retry behavior in case
|
|
5037
|
+
'''The retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
|
|
5037
5038
|
|
|
5038
5039
|
Default value is 3600 (60 minutes).
|
|
5039
5040
|
|
|
@@ -5086,9 +5087,9 @@ class CfnDeliveryStream(
|
|
|
5086
5087
|
*,
|
|
5087
5088
|
duration_in_seconds: typing.Optional[jsii.Number] = None,
|
|
5088
5089
|
) -> None:
|
|
5089
|
-
'''Configures retry behavior in case
|
|
5090
|
+
'''Configures retry behavior in case Firehose is unable to deliver documents to Amazon Redshift.
|
|
5090
5091
|
|
|
5091
|
-
:param duration_in_seconds: The length of time during which
|
|
5092
|
+
:param duration_in_seconds: The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt. The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of ``DurationInSeconds`` is 0 (zero) or if the first delivery attempt takes longer than the current value.
|
|
5092
5093
|
|
|
5093
5094
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html
|
|
5094
5095
|
:exampleMetadata: fixture=_generated
|
|
@@ -5112,9 +5113,9 @@ class CfnDeliveryStream(
|
|
|
5112
5113
|
|
|
5113
5114
|
@builtins.property
|
|
5114
5115
|
def duration_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
5115
|
-
'''The length of time during which
|
|
5116
|
+
'''The length of time during which Firehose retries delivery after a failure, starting from the initial request and including the first attempt.
|
|
5116
5117
|
|
|
5117
|
-
The default value is 3600 seconds (60 minutes).
|
|
5118
|
+
The default value is 3600 seconds (60 minutes). Firehose does not retry if the value of ``DurationInSeconds`` is 0 (zero) or if the first delivery attempt takes longer than the current value.
|
|
5118
5119
|
|
|
5119
5120
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-redshiftretryoptions.html#cfn-kinesisfirehose-deliverystream-redshiftretryoptions-durationinseconds
|
|
5120
5121
|
'''
|
|
@@ -5414,16 +5415,16 @@ class CfnDeliveryStream(
|
|
|
5414
5415
|
table_name: typing.Optional[builtins.str] = None,
|
|
5415
5416
|
version_id: typing.Optional[builtins.str] = None,
|
|
5416
5417
|
) -> None:
|
|
5417
|
-
'''Specifies the schema to which you want
|
|
5418
|
+
'''Specifies the schema to which you want Firehose to configure your data before it writes it to Amazon S3.
|
|
5418
5419
|
|
|
5419
5420
|
This parameter is required if ``Enabled`` is set to true.
|
|
5420
5421
|
|
|
5421
5422
|
:param catalog_id: The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.
|
|
5422
5423
|
:param database_name: Specifies the name of the AWS Glue database that contains the schema for the output data. .. epigraph:: If the ``SchemaConfiguration`` request parameter is used as part of invoking the ``CreateDeliveryStream`` API, then the ``DatabaseName`` property is required and its value must be specified.
|
|
5423
5424
|
:param region: If you don't specify an AWS Region, the default is the current Region.
|
|
5424
|
-
:param role_arn: The role that
|
|
5425
|
+
:param role_arn: The role that Firehose can use to access AWS Glue. This role must be in the same account you use for Firehose. Cross-account roles aren't allowed. .. epigraph:: If the ``SchemaConfiguration`` request parameter is used as part of invoking the ``CreateDeliveryStream`` API, then the ``RoleARN`` property is required and its value must be specified.
|
|
5425
5426
|
:param table_name: Specifies the AWS Glue table that contains the column information that constitutes your data schema. .. epigraph:: If the ``SchemaConfiguration`` request parameter is used as part of invoking the ``CreateDeliveryStream`` API, then the ``TableName`` property is required and its value must be specified.
|
|
5426
|
-
:param version_id: Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to ``LATEST`` ,
|
|
5427
|
+
:param version_id: Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to ``LATEST`` , Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
|
|
5427
5428
|
|
|
5428
5429
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html
|
|
5429
5430
|
:exampleMetadata: fixture=_generated
|
|
@@ -5500,9 +5501,9 @@ class CfnDeliveryStream(
|
|
|
5500
5501
|
|
|
5501
5502
|
@builtins.property
|
|
5502
5503
|
def role_arn(self) -> typing.Optional[builtins.str]:
|
|
5503
|
-
'''The role that
|
|
5504
|
+
'''The role that Firehose can use to access AWS Glue.
|
|
5504
5505
|
|
|
5505
|
-
This role must be in the same account you use for
|
|
5506
|
+
This role must be in the same account you use for Firehose. Cross-account roles aren't allowed.
|
|
5506
5507
|
.. epigraph::
|
|
5507
5508
|
|
|
5508
5509
|
If the ``SchemaConfiguration`` request parameter is used as part of invoking the ``CreateDeliveryStream`` API, then the ``RoleARN`` property is required and its value must be specified.
|
|
@@ -5529,7 +5530,7 @@ class CfnDeliveryStream(
|
|
|
5529
5530
|
def version_id(self) -> typing.Optional[builtins.str]:
|
|
5530
5531
|
'''Specifies the table version for the output data schema.
|
|
5531
5532
|
|
|
5532
|
-
If you don't specify this version ID, or if you set it to ``LATEST`` ,
|
|
5533
|
+
If you don't specify this version ID, or if you set it to ``LATEST`` , Firehose uses the most recent version. This means that any updates to the table are automatically picked up.
|
|
5533
5534
|
|
|
5534
5535
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-schemaconfiguration.html#cfn-kinesisfirehose-deliverystream-schemaconfiguration-versionid
|
|
5535
5536
|
'''
|
|
@@ -5559,9 +5560,9 @@ class CfnDeliveryStream(
|
|
|
5559
5560
|
orc_ser_de: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.OrcSerDeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5560
5561
|
parquet_ser_de: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.ParquetSerDeProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5561
5562
|
) -> None:
|
|
5562
|
-
'''The serializer that you want
|
|
5563
|
+
'''The serializer that you want Firehose to use to convert data to the target format before writing it to Amazon S3.
|
|
5563
5564
|
|
|
5564
|
-
|
|
5565
|
+
Firehose supports two types of serializers: the `ORC SerDe <https://docs.aws.amazon.com/https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/orc/OrcSerde.html>`_ and the `Parquet SerDe <https://docs.aws.amazon.com/https://hive.apache.org/javadocs/r1.2.2/api/org/apache/hadoop/hive/ql/io/parquet/serde/ParquetHiveSerDe.html>`_ .
|
|
5565
5566
|
|
|
5566
5567
|
:param orc_ser_de: A serializer to use for converting data to the ORC format before storing it in Amazon S3. For more information, see `Apache ORC <https://docs.aws.amazon.com/https://orc.apache.org/docs/>`_ .
|
|
5567
5568
|
:param parquet_ser_de: A serializer to use for converting data to the Parquet format before storing it in Amazon S3. For more information, see `Apache Parquet <https://docs.aws.amazon.com/https://parquet.apache.org/documentation/latest/>`_ .
|
|
@@ -5692,25 +5693,26 @@ class CfnDeliveryStream(
|
|
|
5692
5693
|
snowflake_role_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.SnowflakeRoleConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5693
5694
|
snowflake_vpc_configuration: typing.Optional[typing.Union[_IResolvable_da3f097b, typing.Union["CfnDeliveryStream.SnowflakeVpcConfigurationProperty", typing.Dict[builtins.str, typing.Any]]]] = None,
|
|
5694
5695
|
) -> None:
|
|
5695
|
-
'''
|
|
5696
|
-
|
|
5697
|
-
:param
|
|
5698
|
-
:param
|
|
5699
|
-
:param
|
|
5696
|
+
'''Configure Snowflake destination.
|
|
5697
|
+
|
|
5698
|
+
:param account_url: URL for accessing your Snowflake account. This URL must include your `account identifier <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-account-identifier>`_ . Note that the protocol (https://) and port number are optional.
|
|
5699
|
+
:param database: All data in Snowflake is maintained in databases.
|
|
5700
|
+
:param private_key: The private key used to encrypt your Snowflake client. For information, see `Using Key Pair Authentication & Key Rotation <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation>`_ .
|
|
5701
|
+
:param role_arn: The Amazon Resource Name (ARN) of the Snowflake role.
|
|
5700
5702
|
:param s3_configuration:
|
|
5701
|
-
:param schema:
|
|
5702
|
-
:param table:
|
|
5703
|
-
:param user:
|
|
5703
|
+
:param schema: Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
|
|
5704
|
+
:param table: All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
|
|
5705
|
+
:param user: User login name for the Snowflake account.
|
|
5704
5706
|
:param cloud_watch_logging_options:
|
|
5705
|
-
:param content_column_name:
|
|
5706
|
-
:param data_loading_option:
|
|
5707
|
-
:param key_passphrase:
|
|
5708
|
-
:param meta_data_column_name:
|
|
5707
|
+
:param content_column_name: The name of the record content column.
|
|
5708
|
+
:param data_loading_option: Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
|
|
5709
|
+
:param key_passphrase: Passphrase to decrypt the private key when the key is encrypted. For information, see `Using Key Pair Authentication & Key Rotation <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation>`_ .
|
|
5710
|
+
:param meta_data_column_name: The name of the record metadata column.
|
|
5709
5711
|
:param processing_configuration:
|
|
5710
|
-
:param retry_options:
|
|
5711
|
-
:param s3_backup_mode:
|
|
5712
|
-
:param snowflake_role_configuration:
|
|
5713
|
-
:param snowflake_vpc_configuration:
|
|
5712
|
+
:param retry_options: The time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
|
5713
|
+
:param s3_backup_mode: Choose an S3 backup mode.
|
|
5714
|
+
:param snowflake_role_configuration: Optionally configure a Snowflake role. Otherwise the default user role will be used.
|
|
5715
|
+
:param snowflake_vpc_configuration: The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see `Amazon PrivateLink & Snowflake <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink>`_
|
|
5714
5716
|
|
|
5715
5717
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html
|
|
5716
5718
|
:exampleMetadata: fixture=_generated
|
|
@@ -5842,7 +5844,10 @@ class CfnDeliveryStream(
|
|
|
5842
5844
|
|
|
5843
5845
|
@builtins.property
|
|
5844
5846
|
def account_url(self) -> builtins.str:
|
|
5845
|
-
'''
|
|
5847
|
+
'''URL for accessing your Snowflake account.
|
|
5848
|
+
|
|
5849
|
+
This URL must include your `account identifier <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-account-identifier>`_ . Note that the protocol (https://) and port number are optional.
|
|
5850
|
+
|
|
5846
5851
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-accounturl
|
|
5847
5852
|
'''
|
|
5848
5853
|
result = self._values.get("account_url")
|
|
@@ -5851,7 +5856,8 @@ class CfnDeliveryStream(
|
|
|
5851
5856
|
|
|
5852
5857
|
@builtins.property
|
|
5853
5858
|
def database(self) -> builtins.str:
|
|
5854
|
-
'''
|
|
5859
|
+
'''All data in Snowflake is maintained in databases.
|
|
5860
|
+
|
|
5855
5861
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-database
|
|
5856
5862
|
'''
|
|
5857
5863
|
result = self._values.get("database")
|
|
@@ -5860,7 +5866,10 @@ class CfnDeliveryStream(
|
|
|
5860
5866
|
|
|
5861
5867
|
@builtins.property
|
|
5862
5868
|
def private_key(self) -> builtins.str:
|
|
5863
|
-
'''
|
|
5869
|
+
'''The private key used to encrypt your Snowflake client.
|
|
5870
|
+
|
|
5871
|
+
For information, see `Using Key Pair Authentication & Key Rotation <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation>`_ .
|
|
5872
|
+
|
|
5864
5873
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-privatekey
|
|
5865
5874
|
'''
|
|
5866
5875
|
result = self._values.get("private_key")
|
|
@@ -5869,7 +5878,8 @@ class CfnDeliveryStream(
|
|
|
5869
5878
|
|
|
5870
5879
|
@builtins.property
|
|
5871
5880
|
def role_arn(self) -> builtins.str:
|
|
5872
|
-
'''
|
|
5881
|
+
'''The Amazon Resource Name (ARN) of the Snowflake role.
|
|
5882
|
+
|
|
5873
5883
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-rolearn
|
|
5874
5884
|
'''
|
|
5875
5885
|
result = self._values.get("role_arn")
|
|
@@ -5889,7 +5899,8 @@ class CfnDeliveryStream(
|
|
|
5889
5899
|
|
|
5890
5900
|
@builtins.property
|
|
5891
5901
|
def schema(self) -> builtins.str:
|
|
5892
|
-
'''
|
|
5902
|
+
'''Each database consists of one or more schemas, which are logical groupings of database objects, such as tables and views.
|
|
5903
|
+
|
|
5893
5904
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-schema
|
|
5894
5905
|
'''
|
|
5895
5906
|
result = self._values.get("schema")
|
|
@@ -5898,7 +5909,8 @@ class CfnDeliveryStream(
|
|
|
5898
5909
|
|
|
5899
5910
|
@builtins.property
|
|
5900
5911
|
def table(self) -> builtins.str:
|
|
5901
|
-
'''
|
|
5912
|
+
'''All data in Snowflake is stored in database tables, logically structured as collections of columns and rows.
|
|
5913
|
+
|
|
5902
5914
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-table
|
|
5903
5915
|
'''
|
|
5904
5916
|
result = self._values.get("table")
|
|
@@ -5907,7 +5919,8 @@ class CfnDeliveryStream(
|
|
|
5907
5919
|
|
|
5908
5920
|
@builtins.property
|
|
5909
5921
|
def user(self) -> builtins.str:
|
|
5910
|
-
'''
|
|
5922
|
+
'''User login name for the Snowflake account.
|
|
5923
|
+
|
|
5911
5924
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-user
|
|
5912
5925
|
'''
|
|
5913
5926
|
result = self._values.get("user")
|
|
@@ -5926,7 +5939,8 @@ class CfnDeliveryStream(
|
|
|
5926
5939
|
|
|
5927
5940
|
@builtins.property
|
|
5928
5941
|
def content_column_name(self) -> typing.Optional[builtins.str]:
|
|
5929
|
-
'''
|
|
5942
|
+
'''The name of the record content column.
|
|
5943
|
+
|
|
5930
5944
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-contentcolumnname
|
|
5931
5945
|
'''
|
|
5932
5946
|
result = self._values.get("content_column_name")
|
|
@@ -5934,7 +5948,8 @@ class CfnDeliveryStream(
|
|
|
5934
5948
|
|
|
5935
5949
|
@builtins.property
|
|
5936
5950
|
def data_loading_option(self) -> typing.Optional[builtins.str]:
|
|
5937
|
-
'''
|
|
5951
|
+
'''Choose to load JSON keys mapped to table column names or choose to split the JSON payload where content is mapped to a record content column and source metadata is mapped to a record metadata column.
|
|
5952
|
+
|
|
5938
5953
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-dataloadingoption
|
|
5939
5954
|
'''
|
|
5940
5955
|
result = self._values.get("data_loading_option")
|
|
@@ -5942,7 +5957,10 @@ class CfnDeliveryStream(
|
|
|
5942
5957
|
|
|
5943
5958
|
@builtins.property
|
|
5944
5959
|
def key_passphrase(self) -> typing.Optional[builtins.str]:
|
|
5945
|
-
'''
|
|
5960
|
+
'''Passphrase to decrypt the private key when the key is encrypted.
|
|
5961
|
+
|
|
5962
|
+
For information, see `Using Key Pair Authentication & Key Rotation <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/data-load-snowpipe-streaming-configuration#using-key-pair-authentication-key-rotation>`_ .
|
|
5963
|
+
|
|
5946
5964
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-keypassphrase
|
|
5947
5965
|
'''
|
|
5948
5966
|
result = self._values.get("key_passphrase")
|
|
@@ -5950,7 +5968,8 @@ class CfnDeliveryStream(
|
|
|
5950
5968
|
|
|
5951
5969
|
@builtins.property
|
|
5952
5970
|
def meta_data_column_name(self) -> typing.Optional[builtins.str]:
|
|
5953
|
-
'''
|
|
5971
|
+
'''The name of the record metadata column.
|
|
5972
|
+
|
|
5954
5973
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-metadatacolumnname
|
|
5955
5974
|
'''
|
|
5956
5975
|
result = self._values.get("meta_data_column_name")
|
|
@@ -5970,7 +5989,8 @@ class CfnDeliveryStream(
|
|
|
5970
5989
|
def retry_options(
|
|
5971
5990
|
self,
|
|
5972
5991
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SnowflakeRetryOptionsProperty"]]:
|
|
5973
|
-
'''
|
|
5992
|
+
'''The time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
|
5993
|
+
|
|
5974
5994
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-retryoptions
|
|
5975
5995
|
'''
|
|
5976
5996
|
result = self._values.get("retry_options")
|
|
@@ -5978,7 +5998,8 @@ class CfnDeliveryStream(
|
|
|
5978
5998
|
|
|
5979
5999
|
@builtins.property
|
|
5980
6000
|
def s3_backup_mode(self) -> typing.Optional[builtins.str]:
|
|
5981
|
-
'''
|
|
6001
|
+
'''Choose an S3 backup mode.
|
|
6002
|
+
|
|
5982
6003
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-s3backupmode
|
|
5983
6004
|
'''
|
|
5984
6005
|
result = self._values.get("s3_backup_mode")
|
|
@@ -5988,7 +6009,10 @@ class CfnDeliveryStream(
|
|
|
5988
6009
|
def snowflake_role_configuration(
|
|
5989
6010
|
self,
|
|
5990
6011
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SnowflakeRoleConfigurationProperty"]]:
|
|
5991
|
-
'''
|
|
6012
|
+
'''Optionally configure a Snowflake role.
|
|
6013
|
+
|
|
6014
|
+
Otherwise the default user role will be used.
|
|
6015
|
+
|
|
5992
6016
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakeroleconfiguration
|
|
5993
6017
|
'''
|
|
5994
6018
|
result = self._values.get("snowflake_role_configuration")
|
|
@@ -5998,7 +6022,10 @@ class CfnDeliveryStream(
|
|
|
5998
6022
|
def snowflake_vpc_configuration(
|
|
5999
6023
|
self,
|
|
6000
6024
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SnowflakeVpcConfigurationProperty"]]:
|
|
6001
|
-
'''
|
|
6025
|
+
'''The VPCE ID for Firehose to privately connect with Snowflake.
|
|
6026
|
+
|
|
6027
|
+
The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see `Amazon PrivateLink & Snowflake <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink>`_
|
|
6028
|
+
|
|
6002
6029
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakedestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration-snowflakevpcconfiguration
|
|
6003
6030
|
'''
|
|
6004
6031
|
result = self._values.get("snowflake_vpc_configuration")
|
|
@@ -6026,8 +6053,11 @@ class CfnDeliveryStream(
|
|
|
6026
6053
|
*,
|
|
6027
6054
|
duration_in_seconds: typing.Optional[jsii.Number] = None,
|
|
6028
6055
|
) -> None:
|
|
6029
|
-
'''
|
|
6030
|
-
|
|
6056
|
+
'''Specify how long Firehose retries sending data to the New Relic HTTP endpoint.
|
|
6057
|
+
|
|
6058
|
+
After sending data, Firehose first waits for an acknowledgment from the HTTP endpoint. If an error occurs or the acknowledgment doesn’t arrive within the acknowledgment timeout period, Firehose starts the retry duration counter. It keeps retrying until the retry duration expires. After that, Firehose considers it a data delivery failure and backs up the data to your Amazon S3 bucket. Every time that Firehose sends data to the HTTP endpoint (either the initial attempt or a retry), it restarts the acknowledgement timeout counter and waits for an acknowledgement from the HTTP endpoint. Even if the retry duration expires, Firehose still waits for the acknowledgment until it receives it or the acknowledgement timeout period is reached. If the acknowledgment times out, Firehose determines whether there's time left in the retry counter. If there is time left, it retries again and repeats the logic until it receives an acknowledgment or determines that the retry time has expired. If you don't want Firehose to retry sending data, set this value to 0.
|
|
6059
|
+
|
|
6060
|
+
:param duration_in_seconds: the time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
|
6031
6061
|
|
|
6032
6062
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.html
|
|
6033
6063
|
:exampleMetadata: fixture=_generated
|
|
@@ -6051,7 +6081,8 @@ class CfnDeliveryStream(
|
|
|
6051
6081
|
|
|
6052
6082
|
@builtins.property
|
|
6053
6083
|
def duration_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6054
|
-
'''
|
|
6084
|
+
'''the time period where Firehose will retry sending data to the chosen HTTP endpoint.
|
|
6085
|
+
|
|
6055
6086
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeretryoptions.html#cfn-kinesisfirehose-deliverystream-snowflakeretryoptions-durationinseconds
|
|
6056
6087
|
'''
|
|
6057
6088
|
result = self._values.get("duration_in_seconds")
|
|
@@ -6080,9 +6111,12 @@ class CfnDeliveryStream(
|
|
|
6080
6111
|
enabled: typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]] = None,
|
|
6081
6112
|
snowflake_role: typing.Optional[builtins.str] = None,
|
|
6082
6113
|
) -> None:
|
|
6083
|
-
'''
|
|
6084
|
-
|
|
6085
|
-
|
|
6114
|
+
'''Optionally configure a Snowflake role.
|
|
6115
|
+
|
|
6116
|
+
Otherwise the default user role will be used.
|
|
6117
|
+
|
|
6118
|
+
:param enabled: Enable Snowflake role.
|
|
6119
|
+
:param snowflake_role: The Snowflake role you wish to configure.
|
|
6086
6120
|
|
|
6087
6121
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html
|
|
6088
6122
|
:exampleMetadata: fixture=_generated
|
|
@@ -6112,7 +6146,8 @@ class CfnDeliveryStream(
|
|
|
6112
6146
|
def enabled(
|
|
6113
6147
|
self,
|
|
6114
6148
|
) -> typing.Optional[typing.Union[builtins.bool, _IResolvable_da3f097b]]:
|
|
6115
|
-
'''
|
|
6149
|
+
'''Enable Snowflake role.
|
|
6150
|
+
|
|
6116
6151
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-enabled
|
|
6117
6152
|
'''
|
|
6118
6153
|
result = self._values.get("enabled")
|
|
@@ -6120,7 +6155,8 @@ class CfnDeliveryStream(
|
|
|
6120
6155
|
|
|
6121
6156
|
@builtins.property
|
|
6122
6157
|
def snowflake_role(self) -> typing.Optional[builtins.str]:
|
|
6123
|
-
'''
|
|
6158
|
+
'''The Snowflake role you wish to configure.
|
|
6159
|
+
|
|
6124
6160
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakeroleconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakeroleconfiguration-snowflakerole
|
|
6125
6161
|
'''
|
|
6126
6162
|
result = self._values.get("snowflake_role")
|
|
@@ -6144,8 +6180,9 @@ class CfnDeliveryStream(
|
|
|
6144
6180
|
)
|
|
6145
6181
|
class SnowflakeVpcConfigurationProperty:
|
|
6146
6182
|
def __init__(self, *, private_link_vpce_id: builtins.str) -> None:
|
|
6147
|
-
'''
|
|
6148
|
-
|
|
6183
|
+
'''Configure a Snowflake VPC.
|
|
6184
|
+
|
|
6185
|
+
:param private_link_vpce_id: The VPCE ID for Firehose to privately connect with Snowflake. The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see `Amazon PrivateLink & Snowflake <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink>`_
|
|
6149
6186
|
|
|
6150
6187
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.html
|
|
6151
6188
|
:exampleMetadata: fixture=_generated
|
|
@@ -6169,7 +6206,10 @@ class CfnDeliveryStream(
|
|
|
6169
6206
|
|
|
6170
6207
|
@builtins.property
|
|
6171
6208
|
def private_link_vpce_id(self) -> builtins.str:
|
|
6172
|
-
'''
|
|
6209
|
+
'''The VPCE ID for Firehose to privately connect with Snowflake.
|
|
6210
|
+
|
|
6211
|
+
The ID format is com.amazonaws.vpce.[region].vpce-svc-<[id]>. For more information, see `Amazon PrivateLink & Snowflake <https://docs.aws.amazon.com/https://docs.snowflake.com/en/user-guide/admin-security-privatelink>`_
|
|
6212
|
+
|
|
6173
6213
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-snowflakevpcconfiguration.html#cfn-kinesisfirehose-deliverystream-snowflakevpcconfiguration-privatelinkvpceid
|
|
6174
6214
|
'''
|
|
6175
6215
|
result = self._values.get("private_link_vpce_id")
|
|
@@ -6299,16 +6339,16 @@ class CfnDeliveryStream(
|
|
|
6299
6339
|
) -> None:
|
|
6300
6340
|
'''The ``SplunkDestinationConfiguration`` property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.
|
|
6301
6341
|
|
|
6302
|
-
:param hec_endpoint: The HTTP Event Collector (HEC) endpoint to which
|
|
6342
|
+
:param hec_endpoint: The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
|
|
6303
6343
|
:param hec_endpoint_type: This type can be either ``Raw`` or ``Event`` .
|
|
6304
6344
|
:param hec_token: This is a GUID that you obtain from your Splunk cluster when you create a new HEC endpoint.
|
|
6305
6345
|
:param s3_configuration: The configuration for the backup Amazon S3 location.
|
|
6306
6346
|
:param buffering_hints: The buffering options. If no value is specified, the default values for Splunk are used.
|
|
6307
6347
|
:param cloud_watch_logging_options: The Amazon CloudWatch logging options for your delivery stream.
|
|
6308
|
-
:param hec_acknowledgment_timeout_in_seconds: The amount of time that
|
|
6348
|
+
:param hec_acknowledgment_timeout_in_seconds: The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data. At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
|
|
6309
6349
|
:param processing_configuration: The data processing configuration.
|
|
6310
|
-
:param retry_options: The retry behavior in case
|
|
6311
|
-
:param s3_backup_mode: Defines how documents should be delivered to Amazon S3. When set to ``FailedEventsOnly`` ,
|
|
6350
|
+
:param retry_options: The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
|
|
6351
|
+
:param s3_backup_mode: Defines how documents should be delivered to Amazon S3. When set to ``FailedEventsOnly`` , Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to ``AllEvents`` , Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is ``FailedEventsOnly`` . You can update this backup mode from ``FailedEventsOnly`` to ``AllEvents`` . You can't update it from ``AllEvents`` to ``FailedEventsOnly`` .
|
|
6312
6352
|
|
|
6313
6353
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html
|
|
6314
6354
|
:exampleMetadata: fixture=_generated
|
|
@@ -6410,7 +6450,7 @@ class CfnDeliveryStream(
|
|
|
6410
6450
|
|
|
6411
6451
|
@builtins.property
|
|
6412
6452
|
def hec_endpoint(self) -> builtins.str:
|
|
6413
|
-
'''The HTTP Event Collector (HEC) endpoint to which
|
|
6453
|
+
'''The HTTP Event Collector (HEC) endpoint to which Firehose sends your data.
|
|
6414
6454
|
|
|
6415
6455
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecendpoint
|
|
6416
6456
|
'''
|
|
@@ -6476,9 +6516,9 @@ class CfnDeliveryStream(
|
|
|
6476
6516
|
|
|
6477
6517
|
@builtins.property
|
|
6478
6518
|
def hec_acknowledgment_timeout_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6479
|
-
'''The amount of time that
|
|
6519
|
+
'''The amount of time that Firehose waits to receive an acknowledgment from Splunk after it sends it data.
|
|
6480
6520
|
|
|
6481
|
-
At the end of the timeout period,
|
|
6521
|
+
At the end of the timeout period, Firehose either tries to send the data again or considers it an error, based on your retry settings.
|
|
6482
6522
|
|
|
6483
6523
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-hecacknowledgmenttimeoutinseconds
|
|
6484
6524
|
'''
|
|
@@ -6500,7 +6540,7 @@ class CfnDeliveryStream(
|
|
|
6500
6540
|
def retry_options(
|
|
6501
6541
|
self,
|
|
6502
6542
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, "CfnDeliveryStream.SplunkRetryOptionsProperty"]]:
|
|
6503
|
-
'''The retry behavior in case
|
|
6543
|
+
'''The retry behavior in case Firehose is unable to deliver data to Splunk, or if it doesn't receive an acknowledgment of receipt from Splunk.
|
|
6504
6544
|
|
|
6505
6545
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration-retryoptions
|
|
6506
6546
|
'''
|
|
@@ -6511,7 +6551,7 @@ class CfnDeliveryStream(
|
|
|
6511
6551
|
def s3_backup_mode(self) -> typing.Optional[builtins.str]:
|
|
6512
6552
|
'''Defines how documents should be delivered to Amazon S3.
|
|
6513
6553
|
|
|
6514
|
-
When set to ``FailedEventsOnly`` ,
|
|
6554
|
+
When set to ``FailedEventsOnly`` , Firehose writes any data that could not be indexed to the configured Amazon S3 destination. When set to ``AllEvents`` , Firehose delivers all incoming records to Amazon S3, and also writes failed documents to Amazon S3. The default value is ``FailedEventsOnly`` .
|
|
6515
6555
|
|
|
6516
6556
|
You can update this backup mode from ``FailedEventsOnly`` to ``AllEvents`` . You can't update it from ``AllEvents`` to ``FailedEventsOnly`` .
|
|
6517
6557
|
|
|
@@ -6544,7 +6584,7 @@ class CfnDeliveryStream(
|
|
|
6544
6584
|
) -> None:
|
|
6545
6585
|
'''The ``SplunkRetryOptions`` property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.
|
|
6546
6586
|
|
|
6547
|
-
:param duration_in_seconds: The total amount of time that
|
|
6587
|
+
:param duration_in_seconds: The total amount of time that Firehose spends on retries. This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.
|
|
6548
6588
|
|
|
6549
6589
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html
|
|
6550
6590
|
:exampleMetadata: fixture=_generated
|
|
@@ -6568,9 +6608,9 @@ class CfnDeliveryStream(
|
|
|
6568
6608
|
|
|
6569
6609
|
@builtins.property
|
|
6570
6610
|
def duration_in_seconds(self) -> typing.Optional[jsii.Number]:
|
|
6571
|
-
'''The total amount of time that
|
|
6611
|
+
'''The total amount of time that Firehose spends on retries.
|
|
6572
6612
|
|
|
6573
|
-
This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which
|
|
6613
|
+
This duration starts after the initial attempt to send data to Splunk fails. It doesn't include the periods during which Firehose waits for acknowledgment from Splunk after each attempt.
|
|
6574
6614
|
|
|
6575
6615
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-splunkretryoptions.html#cfn-kinesisfirehose-deliverystream-splunkretryoptions-durationinseconds
|
|
6576
6616
|
'''
|
|
@@ -6753,7 +6793,7 @@ class CfnDeliveryStreamProps:
|
|
|
6753
6793
|
:param msk_source_configuration: The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
|
|
6754
6794
|
:param redshift_destination_configuration: An Amazon Redshift destination for the delivery stream. Conditional. You must specify only one destination configuration. If you change the delivery stream destination from an Amazon Redshift 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>`_ .
|
|
6755
6795
|
: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>`_ .
|
|
6756
|
-
:param snowflake_destination_configuration:
|
|
6796
|
+
:param snowflake_destination_configuration: Configure Snowflake destination.
|
|
6757
6797
|
:param splunk_destination_configuration: The configuration of a destination in Splunk for the delivery stream.
|
|
6758
6798
|
:param tags: A set of tags to assign to the delivery 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 delivery 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 delivery stream.
|
|
6759
6799
|
|
|
@@ -6986,7 +7026,8 @@ class CfnDeliveryStreamProps:
|
|
|
6986
7026
|
def snowflake_destination_configuration(
|
|
6987
7027
|
self,
|
|
6988
7028
|
) -> typing.Optional[typing.Union[_IResolvable_da3f097b, CfnDeliveryStream.SnowflakeDestinationConfigurationProperty]]:
|
|
6989
|
-
'''
|
|
7029
|
+
'''Configure Snowflake destination.
|
|
7030
|
+
|
|
6990
7031
|
:see: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration
|
|
6991
7032
|
'''
|
|
6992
7033
|
result = self._values.get("snowflake_destination_configuration")
|