Interface ICfnDeliveryStreamProps
Properties for defining a CfnDeliveryStream
.
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.AWS.KinesisFirehose.dll
Syntax (csharp)
public interface ICfnDeliveryStreamProps
Syntax (vb)
Public Interface ICfnDeliveryStreamProps
Remarks
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.KinesisFirehose;
var cfnDeliveryStreamProps = new CfnDeliveryStreamProps {
AmazonOpenSearchServerlessDestinationConfiguration = new AmazonOpenSearchServerlessDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
BufferingHints = new AmazonOpenSearchServerlessBufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CollectionEndpoint = "collectionEndpoint",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new AmazonOpenSearchServerlessRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
AmazonopensearchserviceDestinationConfiguration = new AmazonopensearchserviceDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
BufferingHints = new AmazonopensearchserviceBufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ClusterEndpoint = "clusterEndpoint",
DocumentIdOptions = new DocumentIdOptionsProperty {
DefaultDocumentIdFormat = "defaultDocumentIdFormat"
},
DomainArn = "domainArn",
IndexRotationPeriod = "indexRotationPeriod",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new AmazonopensearchserviceRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
TypeName = "typeName",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
DeliveryStreamEncryptionConfigurationInput = new DeliveryStreamEncryptionConfigurationInputProperty {
KeyType = "keyType",
// the properties below are optional
KeyArn = "keyArn"
},
DeliveryStreamName = "deliveryStreamName",
DeliveryStreamType = "deliveryStreamType",
ElasticsearchDestinationConfiguration = new ElasticsearchDestinationConfigurationProperty {
IndexName = "indexName",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
BufferingHints = new ElasticsearchBufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ClusterEndpoint = "clusterEndpoint",
DocumentIdOptions = new DocumentIdOptionsProperty {
DefaultDocumentIdFormat = "defaultDocumentIdFormat"
},
DomainArn = "domainArn",
IndexRotationPeriod = "indexRotationPeriod",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new ElasticsearchRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode",
TypeName = "typeName",
VpcConfiguration = new VpcConfigurationProperty {
RoleArn = "roleArn",
SecurityGroupIds = new [] { "securityGroupIds" },
SubnetIds = new [] { "subnetIds" }
}
},
ExtendedS3DestinationConfiguration = new ExtendedS3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
DataFormatConversionConfiguration = new DataFormatConversionConfigurationProperty {
Enabled = false,
InputFormatConfiguration = new InputFormatConfigurationProperty {
Deserializer = new DeserializerProperty {
HiveJsonSerDe = new HiveJsonSerDeProperty {
TimestampFormats = new [] { "timestampFormats" }
},
OpenXJsonSerDe = new OpenXJsonSerDeProperty {
CaseInsensitive = false,
ColumnToJsonKeyMappings = new Dictionary<string, string> {
{ "columnToJsonKeyMappingsKey", "columnToJsonKeyMappings" }
},
ConvertDotsInJsonKeysToUnderscores = false
}
}
},
OutputFormatConfiguration = new OutputFormatConfigurationProperty {
Serializer = new SerializerProperty {
OrcSerDe = new OrcSerDeProperty {
BlockSizeBytes = 123,
BloomFilterColumns = new [] { "bloomFilterColumns" },
BloomFilterFalsePositiveProbability = 123,
Compression = "compression",
DictionaryKeyThreshold = 123,
EnablePadding = false,
FormatVersion = "formatVersion",
PaddingTolerance = 123,
RowIndexStride = 123,
StripeSizeBytes = 123
},
ParquetSerDe = new ParquetSerDeProperty {
BlockSizeBytes = 123,
Compression = "compression",
EnableDictionaryCompression = false,
MaxPaddingBytes = 123,
PageSizeBytes = 123,
WriterVersion = "writerVersion"
}
}
},
SchemaConfiguration = new SchemaConfigurationProperty {
CatalogId = "catalogId",
DatabaseName = "databaseName",
Region = "region",
RoleArn = "roleArn",
TableName = "tableName",
VersionId = "versionId"
}
},
DynamicPartitioningConfiguration = new DynamicPartitioningConfigurationProperty {
Enabled = false,
RetryOptions = new RetryOptionsProperty {
DurationInSeconds = 123
}
},
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix",
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
S3BackupConfiguration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
S3BackupMode = "s3BackupMode"
},
HttpEndpointDestinationConfiguration = new HttpEndpointDestinationConfigurationProperty {
EndpointConfiguration = new HttpEndpointConfigurationProperty {
Url = "url",
// the properties below are optional
AccessKey = "accessKey",
Name = "name"
},
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RequestConfiguration = new HttpEndpointRequestConfigurationProperty {
CommonAttributes = new [] { new HttpEndpointCommonAttributeProperty {
AttributeName = "attributeName",
AttributeValue = "attributeValue"
} },
ContentEncoding = "contentEncoding"
},
RetryOptions = new RetryOptionsProperty {
DurationInSeconds = 123
},
RoleArn = "roleArn",
S3BackupMode = "s3BackupMode"
},
KinesisStreamSourceConfiguration = new KinesisStreamSourceConfigurationProperty {
KinesisStreamArn = "kinesisStreamArn",
RoleArn = "roleArn"
},
RedshiftDestinationConfiguration = new RedshiftDestinationConfigurationProperty {
ClusterJdbcurl = "clusterJdbcurl",
CopyCommand = new CopyCommandProperty {
DataTableName = "dataTableName",
// the properties below are optional
CopyOptions = "copyOptions",
DataTableColumns = "dataTableColumns"
},
Password = "password",
RoleArn = "roleArn",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
Username = "username",
// the properties below are optional
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new RedshiftRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupConfiguration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
S3BackupMode = "s3BackupMode"
},
S3DestinationConfiguration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
SplunkDestinationConfiguration = new SplunkDestinationConfigurationProperty {
HecEndpoint = "hecEndpoint",
HecEndpointType = "hecEndpointType",
HecToken = "hecToken",
S3Configuration = new S3DestinationConfigurationProperty {
BucketArn = "bucketArn",
RoleArn = "roleArn",
// the properties below are optional
BufferingHints = new BufferingHintsProperty {
IntervalInSeconds = 123,
SizeInMBs = 123
},
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
CompressionFormat = "compressionFormat",
EncryptionConfiguration = new EncryptionConfigurationProperty {
KmsEncryptionConfig = new KMSEncryptionConfigProperty {
AwskmsKeyArn = "awskmsKeyArn"
},
NoEncryptionConfig = "noEncryptionConfig"
},
ErrorOutputPrefix = "errorOutputPrefix",
Prefix = "prefix"
},
// the properties below are optional
CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
Enabled = false,
LogGroupName = "logGroupName",
LogStreamName = "logStreamName"
},
HecAcknowledgmentTimeoutInSeconds = 123,
ProcessingConfiguration = new ProcessingConfigurationProperty {
Enabled = false,
Processors = new [] { new ProcessorProperty {
Type = "type",
// the properties below are optional
Parameters = new [] { new ProcessorParameterProperty {
ParameterName = "parameterName",
ParameterValue = "parameterValue"
} }
} }
},
RetryOptions = new SplunkRetryOptionsProperty {
DurationInSeconds = 123
},
S3BackupMode = "s3BackupMode"
},
Tags = new [] { new CfnTag {
Key = "key",
Value = "value"
} }
};
Synopsis
Properties
AmazonOpenSearchServerlessDestinationConfiguration |
|
AmazonopensearchserviceDestinationConfiguration | The destination in Amazon OpenSearch Service. |
DeliveryStreamEncryptionConfigurationInput | Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). |
DeliveryStreamName | The name of the delivery stream. |
DeliveryStreamType | The delivery stream type. This can be one of the following values:. |
ElasticsearchDestinationConfiguration | An Amazon ES destination for the delivery stream. |
ExtendedS3DestinationConfiguration | An Amazon S3 destination for the delivery stream. |
HttpEndpointDestinationConfiguration | Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. |
KinesisStreamSourceConfiguration | When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream. |
RedshiftDestinationConfiguration | An Amazon Redshift destination for the delivery stream. |
S3DestinationConfiguration | The |
SplunkDestinationConfiguration | The configuration of a destination in Splunk for the delivery stream. |
Tags | A set of tags to assign to the delivery stream. |
Properties
AmazonOpenSearchServerlessDestinationConfiguration
AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
.
virtual object AmazonOpenSearchServerlessDestinationConfiguration { get; }
Property Value
System.Object
Remarks
AmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.
virtual object AmazonopensearchserviceDestinationConfiguration { get; }
Property Value
System.Object
Remarks
DeliveryStreamEncryptionConfigurationInput
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
virtual object DeliveryStreamEncryptionConfigurationInput { get; }
Property Value
System.Object
Remarks
DeliveryStreamName
The name of the delivery stream.
virtual string DeliveryStreamName { get; }
Property Value
System.String
Remarks
DeliveryStreamType
The delivery stream type. This can be one of the following values:.
virtual string DeliveryStreamType { get; }
Property Value
System.String
Remarks
ElasticsearchDestinationConfiguration
An Amazon ES destination for the delivery stream.
virtual object ElasticsearchDestinationConfiguration { get; }
Property Value
System.Object
Remarks
Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon ES destination to an Amazon S3 or Amazon Redshift destination, update requires some interruptions .
ExtendedS3DestinationConfiguration
An Amazon S3 destination for the delivery stream.
virtual object ExtendedS3DestinationConfiguration { get; }
Property Value
System.Object
Remarks
Conditional. You must specify only one destination configuration.
If you change the delivery stream destination from an Amazon Extended S3 destination to an Amazon ES destination, update requires some interruptions .
HttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
virtual object HttpEndpointDestinationConfiguration { get; }
Property Value
System.Object
Remarks
KinesisStreamSourceConfiguration
When a Kinesis stream is used as the source for the delivery stream, a KinesisStreamSourceConfiguration containing the Kinesis stream ARN and the role ARN for the source stream.
virtual object KinesisStreamSourceConfiguration { get; }
Property Value
System.Object
Remarks
RedshiftDestinationConfiguration
An Amazon Redshift destination for the delivery stream.
virtual object RedshiftDestinationConfiguration { get; }
Property Value
System.Object
Remarks
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 .
S3DestinationConfiguration
The S3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
virtual object S3DestinationConfiguration { get; }
Property Value
System.Object
Remarks
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 .
SplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream.
virtual object SplunkDestinationConfiguration { get; }
Property Value
System.Object
Remarks
Tags
A set of tags to assign to the delivery stream.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
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 in the AWS Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a delivery stream.