Interface CfnDeliveryStreamProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStreamProps.Jsii$Proxy
CfnDeliveryStream
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.kinesisfirehose.*; CfnDeliveryStreamProps cfnDeliveryStreamProps = CfnDeliveryStreamProps.builder() .amazonOpenSearchServerlessDestinationConfiguration(AmazonOpenSearchServerlessDestinationConfigurationProperty.builder() .indexName("indexName") .roleArn("roleArn") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .bufferingHints(AmazonOpenSearchServerlessBufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .collectionEndpoint("collectionEndpoint") .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(AmazonOpenSearchServerlessRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupMode("s3BackupMode") .vpcConfiguration(VpcConfigurationProperty.builder() .roleArn("roleArn") .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .amazonopensearchserviceDestinationConfiguration(AmazonopensearchserviceDestinationConfigurationProperty.builder() .indexName("indexName") .roleArn("roleArn") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .bufferingHints(AmazonopensearchserviceBufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .clusterEndpoint("clusterEndpoint") .documentIdOptions(DocumentIdOptionsProperty.builder() .defaultDocumentIdFormat("defaultDocumentIdFormat") .build()) .domainArn("domainArn") .indexRotationPeriod("indexRotationPeriod") .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(AmazonopensearchserviceRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupMode("s3BackupMode") .typeName("typeName") .vpcConfiguration(VpcConfigurationProperty.builder() .roleArn("roleArn") .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .deliveryStreamEncryptionConfigurationInput(DeliveryStreamEncryptionConfigurationInputProperty.builder() .keyType("keyType") // the properties below are optional .keyArn("keyArn") .build()) .deliveryStreamName("deliveryStreamName") .deliveryStreamType("deliveryStreamType") .elasticsearchDestinationConfiguration(ElasticsearchDestinationConfigurationProperty.builder() .indexName("indexName") .roleArn("roleArn") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .bufferingHints(ElasticsearchBufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .clusterEndpoint("clusterEndpoint") .documentIdOptions(DocumentIdOptionsProperty.builder() .defaultDocumentIdFormat("defaultDocumentIdFormat") .build()) .domainArn("domainArn") .indexRotationPeriod("indexRotationPeriod") .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(ElasticsearchRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupMode("s3BackupMode") .typeName("typeName") .vpcConfiguration(VpcConfigurationProperty.builder() .roleArn("roleArn") .securityGroupIds(List.of("securityGroupIds")) .subnetIds(List.of("subnetIds")) .build()) .build()) .extendedS3DestinationConfiguration(ExtendedS3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .dataFormatConversionConfiguration(DataFormatConversionConfigurationProperty.builder() .enabled(false) .inputFormatConfiguration(InputFormatConfigurationProperty.builder() .deserializer(DeserializerProperty.builder() .hiveJsonSerDe(HiveJsonSerDeProperty.builder() .timestampFormats(List.of("timestampFormats")) .build()) .openXJsonSerDe(OpenXJsonSerDeProperty.builder() .caseInsensitive(false) .columnToJsonKeyMappings(Map.of( "columnToJsonKeyMappingsKey", "columnToJsonKeyMappings")) .convertDotsInJsonKeysToUnderscores(false) .build()) .build()) .build()) .outputFormatConfiguration(OutputFormatConfigurationProperty.builder() .serializer(SerializerProperty.builder() .orcSerDe(OrcSerDeProperty.builder() .blockSizeBytes(123) .bloomFilterColumns(List.of("bloomFilterColumns")) .bloomFilterFalsePositiveProbability(123) .compression("compression") .dictionaryKeyThreshold(123) .enablePadding(false) .formatVersion("formatVersion") .paddingTolerance(123) .rowIndexStride(123) .stripeSizeBytes(123) .build()) .parquetSerDe(ParquetSerDeProperty.builder() .blockSizeBytes(123) .compression("compression") .enableDictionaryCompression(false) .maxPaddingBytes(123) .pageSizeBytes(123) .writerVersion("writerVersion") .build()) .build()) .build()) .schemaConfiguration(SchemaConfigurationProperty.builder() .catalogId("catalogId") .databaseName("databaseName") .region("region") .roleArn("roleArn") .tableName("tableName") .versionId("versionId") .build()) .build()) .dynamicPartitioningConfiguration(DynamicPartitioningConfigurationProperty.builder() .enabled(false) .retryOptions(RetryOptionsProperty.builder() .durationInSeconds(123) .build()) .build()) .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .s3BackupConfiguration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) .s3BackupMode("s3BackupMode") .build()) .httpEndpointDestinationConfiguration(HttpEndpointDestinationConfigurationProperty.builder() .endpointConfiguration(HttpEndpointConfigurationProperty.builder() .url("url") // the properties below are optional .accessKey("accessKey") .name("name") .build()) .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .requestConfiguration(HttpEndpointRequestConfigurationProperty.builder() .commonAttributes(List.of(HttpEndpointCommonAttributeProperty.builder() .attributeName("attributeName") .attributeValue("attributeValue") .build())) .contentEncoding("contentEncoding") .build()) .retryOptions(RetryOptionsProperty.builder() .durationInSeconds(123) .build()) .roleArn("roleArn") .s3BackupMode("s3BackupMode") .build()) .kinesisStreamSourceConfiguration(KinesisStreamSourceConfigurationProperty.builder() .kinesisStreamArn("kinesisStreamArn") .roleArn("roleArn") .build()) .redshiftDestinationConfiguration(RedshiftDestinationConfigurationProperty.builder() .clusterJdbcurl("clusterJdbcurl") .copyCommand(CopyCommandProperty.builder() .dataTableName("dataTableName") // the properties below are optional .copyOptions("copyOptions") .dataTableColumns("dataTableColumns") .build()) .password("password") .roleArn("roleArn") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) .username("username") // the properties below are optional .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(RedshiftRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupConfiguration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) .s3BackupMode("s3BackupMode") .build()) .s3DestinationConfiguration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) .splunkDestinationConfiguration(SplunkDestinationConfigurationProperty.builder() .hecEndpoint("hecEndpoint") .hecEndpointType("hecEndpointType") .hecToken("hecToken") .s3Configuration(S3DestinationConfigurationProperty.builder() .bucketArn("bucketArn") .roleArn("roleArn") // the properties below are optional .bufferingHints(BufferingHintsProperty.builder() .intervalInSeconds(123) .sizeInMBs(123) .build()) .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .compressionFormat("compressionFormat") .encryptionConfiguration(EncryptionConfigurationProperty.builder() .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder() .awskmsKeyArn("awskmsKeyArn") .build()) .noEncryptionConfig("noEncryptionConfig") .build()) .errorOutputPrefix("errorOutputPrefix") .prefix("prefix") .build()) // the properties below are optional .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder() .enabled(false) .logGroupName("logGroupName") .logStreamName("logStreamName") .build()) .hecAcknowledgmentTimeoutInSeconds(123) .processingConfiguration(ProcessingConfigurationProperty.builder() .enabled(false) .processors(List.of(ProcessorProperty.builder() .type("type") // the properties below are optional .parameters(List.of(ProcessorParameterProperty.builder() .parameterName("parameterName") .parameterValue("parameterValue") .build())) .build())) .build()) .retryOptions(SplunkRetryOptionsProperty.builder() .durationInSeconds(123) .build()) .s3BackupMode("s3BackupMode") .build()) .tags(List.of(CfnTag.builder() .key("key") .value("value") .build())) .build();
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnDeliveryStreamProps
static final class
An implementation forCfnDeliveryStreamProps
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
.default Object
The destination in Amazon OpenSearch Service.default Object
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).default String
The name of the delivery stream.default String
The delivery stream type.default Object
An Amazon ES destination for the delivery stream.default Object
An Amazon S3 destination for the delivery stream.default Object
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.default Object
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.default Object
An Amazon Redshift destination for the delivery stream.default Object
TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.default Object
The configuration of a destination in Splunk for the delivery stream.getTags()
A set of tags to assign to the delivery stream.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getAmazonOpenSearchServerlessDestinationConfiguration
AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
. -
getAmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.You can specify only one destination.
-
getDeliveryStreamEncryptionConfigurationInput
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). -
getDeliveryStreamName
The name of the delivery stream. -
getDeliveryStreamType
The delivery stream type. This can be one of the following values:.DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
-
getElasticsearchDestinationConfiguration
An Amazon ES destination for the delivery stream.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 .
-
getExtendedS3DestinationConfiguration
An Amazon S3 destination for the delivery stream.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 .
-
getHttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.You can specify only one destination.
-
getKinesisStreamSourceConfiguration
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. -
getRedshiftDestinationConfiguration
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 .
-
getS3DestinationConfiguration
TheS3DestinationConfiguration
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 .
-
getSplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream. -
getTags
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 in the AWS Billing and Cost Management User Guide.
You can specify up to 50 tags when creating a delivery stream.
-
builder
- Returns:
- a
CfnDeliveryStreamProps.Builder
ofCfnDeliveryStreamProps
-