CommonDestinationProps

class aws_cdk.aws_kinesisfirehose.CommonDestinationProps(*, logging_config=None, processor=None, role=None, s3_backup=None)

Bases: object

Generic properties for defining a delivery stream destination.

Parameters:

  • logging_config (Optional[ILoggingConfig]) – Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs. Default: - errors will be logged and a log group will be created for you.

  • processor (Optional[IDataProcessor]) – The data transformation that should be performed on the data before writing to the destination. Default: - no data transformation will occur.

  • role (Optional[IRole]) – The IAM role associated with this destination. Assumed by Amazon Data Firehose to invoke processors and write to destinations Default: - a role will be created with default permissions.

  • s3_backup (Union[DestinationS3BackupProps, Dict[str, Any], None]) – The configuration for backing up source records to S3. Default: - source records will not be backed up to S3.

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 as cdk
from aws_cdk import aws_iam as iam
from aws_cdk import aws_kinesisfirehose as kinesisfirehose
from aws_cdk import aws_kms as kms
from aws_cdk import aws_s3 as s3

# bucket: s3.Bucket
# compression: kinesisfirehose.Compression
# data_processor: kinesisfirehose.IDataProcessor
# key: kms.Key
# logging_config: kinesisfirehose.ILoggingConfig
# role: iam.Role
# size: cdk.Size

common_destination_props = kinesisfirehose.CommonDestinationProps(
    logging_config=logging_config,
    processor=data_processor,
    role=role,
    s3_backup=kinesisfirehose.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_config=logging_config,
        mode=kinesisfirehose.BackupMode.ALL
    )
)

Attributes

logging_config

Configuration that determines whether to log errors during data transformation or delivery failures, and specifies the CloudWatch log group for storing error logs.

Default:

  • errors will be logged and a log group will be created for you.

processor

The data transformation that should be performed on the data before writing to the destination.

Default:

  • no data transformation will occur.

role

The IAM role associated with this destination.

Assumed by Amazon Data Firehose to invoke processors and write to destinations

Default:

  • a role will be created with default permissions.

s3_backup

The configuration for backing up source records to S3.

Default:

  • source records will not be backed up to S3.