Interface ICommonDestinationProps
(experimental) Generic properties for defining a delivery stream destination.
Namespace: Amazon.CDK.AWS.KinesisFirehose.Destinations
Assembly: Amazon.CDK.AWS.KinesisFirehose.Destinations.dll
Syntax (csharp)
public interface ICommonDestinationProps
Syntax (vb)
Public Interface ICommonDestinationProps
Remarks
Stability: Experimental
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.IAM;
using Amazon.CDK.AWS.KinesisFirehose;
using Amazon.CDK.AWS.KinesisFirehose.Destinations;
using Amazon.CDK.AWS.KMS;
using Amazon.CDK.AWS.Logs;
using Amazon.CDK.AWS.S3;
using Amazon.CDK;
Bucket bucket;
Compression compression;
IDataProcessor dataProcessor;
Key key;
LogGroup logGroup;
Role role;
Size size;
var commonDestinationProps = new CommonDestinationProps {
Logging = false,
LogGroup = logGroup,
Processor = dataProcessor,
Role = role,
S3Backup = new DestinationS3BackupProps {
Bucket = bucket,
BufferingInterval = Duration.Minutes(30),
BufferingSize = size,
Compression = compression,
DataOutputPrefix = "dataOutputPrefix",
EncryptionKey = key,
ErrorOutputPrefix = "errorOutputPrefix",
Logging = false,
LogGroup = logGroup,
Mode = BackupMode.ALL
}
};
Synopsis
Properties
Logging | (experimental) If true, log errors when data transformation or data delivery fails. |
LogGroup | (experimental) The CloudWatch log group where log streams will be created to hold error logs. |
Processor | (experimental) The data transformation that should be performed on the data before writing to the destination. |
Role | (experimental) The IAM role associated with this destination. |
S3Backup | (experimental) The configuration for backing up source records to S3. |
Properties
Logging
(experimental) If true, log errors when data transformation or data delivery fails.
virtual Nullable<bool> Logging { get; }
Property Value
System.Nullable<System.Boolean>
Remarks
If logGroup
is provided, this will be implicitly set to true
.
Default: true - errors are logged.
Stability: Experimental
LogGroup
(experimental) The CloudWatch log group where log streams will be created to hold error logs.
virtual ILogGroup LogGroup { get; }
Property Value
Remarks
Default: - if logging
is set to true
, a log group will be created for you.
Stability: Experimental
Processor
(experimental) The data transformation that should be performed on the data before writing to the destination.
virtual IDataProcessor Processor { get; }
Property Value
Remarks
Default: - no data transformation will occur.
Stability: Experimental
Role
(experimental) The IAM role associated with this destination.
virtual IRole Role { get; }
Property Value
Remarks
Assumed by Kinesis Data Firehose to invoke processors and write to destinations
Default: - a role will be created with default permissions.
Stability: Experimental
S3Backup
(experimental) The configuration for backing up source records to S3.
virtual IDestinationS3BackupProps S3Backup { get; }
Property Value
Remarks
Default: - source records will not be backed up to S3.
Stability: Experimental