CommonDestinationProps¶
-
class
aws_cdk.aws_kinesisfirehose_destinations.
CommonDestinationProps
(*, logging=None, log_group=None, processor=None, role=None, s3_backup=None)¶ Bases:
object
(experimental) Generic properties for defining a delivery stream destination.
- Parameters
logging (
Optional
[bool
]) – (experimental) If true, log errors when data transformation or data delivery fails. IflogGroup
is provided, this will be implicitly set totrue
. Default: true - errors are logged.log_group (
Optional
[ILogGroup
]) – (experimental) The CloudWatch log group where log streams will be created to hold error logs. Default: - iflogging
is set totrue
, a log group will be created for you.processor (
Optional
[IDataProcessor
]) – (experimental) The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.role (
Optional
[IRole
]) – (experimental) The IAM role associated with this destination. Assumed by Kinesis Data Firehose to invoke processors and write to destinations Default: - a role will be created with default permissions.s3_backup (
Optional
[DestinationS3BackupProps
]) – (experimental) The configuration for backing up source records to S3. Default: - source records will not be backed up to S3.
- Stability
experimental
- ExampleMetadata
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_iam as iam import aws_cdk.aws_kinesisfirehose as kinesisfirehose import aws_cdk.aws_kinesisfirehose_destinations as kinesisfirehose_destinations import aws_cdk.aws_kms as kms import aws_cdk.aws_logs as logs import aws_cdk.aws_s3 as s3 import aws_cdk.core as cdk # bucket: s3.Bucket # compression: kinesisfirehose_destinations.Compression # data_processor: kinesisfirehose.IDataProcessor # key: kms.Key # log_group: logs.LogGroup # role: iam.Role # size: cdk.Size common_destination_props = kinesisfirehose_destinations.CommonDestinationProps( logging=False, log_group=log_group, processor=data_processor, role=role, s3_backup=kinesisfirehose_destinations.DestinationS3BackupProps( bucket=bucket, buffering_interval=cdk.Duration.minutes(30), buffering_size=size, compression=compression, data_output_prefix="dataOutputPrefix", encryption_key=key, error_output_prefix="errorOutputPrefix", logging=False, log_group=log_group, mode=kinesisfirehose_destinations.BackupMode.ALL ) )
Attributes
-
log_group
¶ (experimental) The CloudWatch log group where log streams will be created to hold error logs.
- Default
if
logging
is set totrue
, a log group will be created for you.
- Stability
experimental
- Return type
Optional
[ILogGroup
]
-
logging
¶ (experimental) If true, log errors when data transformation or data delivery fails.
If
logGroup
is provided, this will be implicitly set totrue
.- Default
true - errors are logged.
- Stability
experimental
- Return type
Optional
[bool
]
-
processor
¶ (experimental) The data transformation that should be performed on the data before writing to the destination.
- Default
no data transformation will occur.
- Stability
experimental
- Return type
Optional
[IDataProcessor
]
-
role
¶ (experimental) The IAM role associated with this destination.
Assumed by Kinesis Data Firehose to invoke processors and write to destinations
- Default
a role will be created with default permissions.
- Stability
experimental
- Return type
Optional
[IRole
]
-
s3_backup
¶ (experimental) The configuration for backing up source records to S3.
- Default
source records will not be backed up to S3.
- Stability
experimental
- Return type
Optional
[DestinationS3BackupProps
]