Class CfnDeliveryStream
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
AWS::KinesisFirehose::DeliveryStream
.
The AWS::KinesisFirehose::DeliveryStream
resource specifies an Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivery stream that delivers real-time streaming data to an Amazon Simple Storage Service (Amazon S3), Amazon Redshift, or Amazon Elasticsearch Service (Amazon ES) destination. For more information, see Creating an Amazon Kinesis Data Firehose Delivery Stream in the Amazon Kinesis Data Firehose Developer Guide .
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.*; CfnDeliveryStream cfnDeliveryStream = CfnDeliveryStream.Builder.create(this, "MyCfnDeliveryStream") .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 TypeClassDescriptionstatic interface
Example:static interface
Example:static interface
Example:static interface
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.static interface
Describes the configuration of a destination in Amazon OpenSearch Service.static interface
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.static interface
TheBufferingHints
property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination.static final class
A fluent builder forCfnDeliveryStream
.static interface
TheCloudWatchLoggingOptions
property type specifies Amazon CloudWatch Logs (CloudWatch Logs) logging options that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses for the delivery stream.static interface
TheCopyCommand
property type configures the Amazon RedshiftCOPY
command that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses to load data into an Amazon Redshift cluster from an Amazon S3 bucket.static interface
Specifies that you want Kinesis Data Firehose to convert data from the JSON format to the Parquet or ORC format before writing it to Amazon S3.static interface
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).static interface
The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON.static interface
Example:static interface
TheDynamicPartitioningConfiguration
property type specifies the configuration of the dynamic partitioning mechanism that creates targeted data sets from the streaming data by partitioning it based on partition keys.static interface
TheElasticsearchBufferingHints
property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination.static interface
TheElasticsearchDestinationConfiguration
property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.static interface
TheElasticsearchRetryOptions
property type configures the retry behavior for when Amazon Kinesis Data Firehose (Kinesis Data Firehose) can't deliver data to Amazon Elasticsearch Service (Amazon ES).static interface
TheEncryptionConfiguration
property type specifies the encryption settings that Amazon Kinesis Data Firehose (Kinesis Data Firehose) uses when delivering data to Amazon Simple Storage Service (Amazon S3).static interface
TheExtendedS3DestinationConfiguration
property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.static interface
The native Hive / HCatalog JsonSerDe.static interface
Describes the metadata that's delivered to the specified HTTP endpoint destination.static interface
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.static interface
Describes the configuration of the HTTP endpoint destination.static interface
The configuration of the HTTP endpoint request.static interface
Specifies the deserializer you want to use to convert the format of the input data.static interface
TheKinesisStreamSourceConfiguration
property type specifies the stream and role Amazon Resource Names (ARNs) for a Kinesis stream used as the source for a delivery stream.static interface
TheKMSEncryptionConfig
property type specifies the AWS Key Management Service ( AWS KMS) encryption key that Amazon Simple Storage Service (Amazon S3) uses to encrypt data delivered by the Amazon Kinesis Data Firehose (Kinesis Data Firehose) stream.static interface
The OpenX SerDe.static interface
A serializer to use for converting data to the ORC format before storing it in Amazon S3.static interface
Specifies the serializer that you want Kinesis Data Firehose to use to convert the format of your data before it writes it to Amazon S3.static interface
A serializer to use for converting data to the Parquet format before storing it in Amazon S3.static interface
TheProcessingConfiguration
property configures data processing for an Amazon Kinesis Data Firehose delivery stream.static interface
TheProcessorParameter
property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.static interface
TheProcessor
property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.static interface
TheRedshiftDestinationConfiguration
property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.static interface
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.static interface
Describes the retry behavior in case Kinesis Data Firehose is unable to deliver data to the specified HTTP endpoint destination, or if it doesn't receive a valid acknowledgment of receipt from the specified HTTP endpoint destination.static interface
TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.static interface
Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.static interface
The serializer that you want Kinesis Data Firehose to use to convert data to the target format before writing it to Amazon S3.static interface
TheSplunkDestinationConfiguration
property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.static interface
TheSplunkRetryOptions
property type specifies retry behavior in case Kinesis Data Firehose is unable to deliver documents to Splunk or if it doesn't receive an acknowledgment from Splunk.static interface
The details of the VPC of the Amazon ES destination.Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
Modifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ModifierConstructorDescriptionCfnDeliveryStream
(Construct scope, String id) Create a newAWS::KinesisFirehose::DeliveryStream
.CfnDeliveryStream
(Construct scope, String id, CfnDeliveryStreamProps props) Create a newAWS::KinesisFirehose::DeliveryStream
.protected
CfnDeliveryStream
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDeliveryStream
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionAWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
.The destination in Amazon OpenSearch Service.The Amazon Resource Name (ARN) of the delivery stream, such asarn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name
.Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).The name of the delivery stream.The delivery stream type.An Amazon ES destination for the delivery stream.An Amazon S3 destination for the delivery stream.Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.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.An Amazon Redshift destination for the delivery stream.TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.The configuration of a destination in Splunk for the delivery stream.getTags()
A set of tags to assign to the delivery stream.void
inspect
(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.renderProperties
(Map<String, Object> props) void
AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
.void
setAmazonOpenSearchServerlessDestinationConfiguration
(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty value) AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
.void
The destination in Amazon OpenSearch Service.void
setAmazonopensearchserviceDestinationConfiguration
(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value) The destination in Amazon OpenSearch Service.void
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).void
setDeliveryStreamEncryptionConfigurationInput
(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).void
setDeliveryStreamName
(String value) The name of the delivery stream.void
setDeliveryStreamType
(String value) The delivery stream type.void
An Amazon ES destination for the delivery stream.void
setElasticsearchDestinationConfiguration
(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value) An Amazon ES destination for the delivery stream.void
An Amazon S3 destination for the delivery stream.void
setExtendedS3DestinationConfiguration
(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value) An Amazon S3 destination for the delivery stream.void
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.void
setHttpEndpointDestinationConfiguration
(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.void
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.void
setKinesisStreamSourceConfiguration
(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value) 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.void
An Amazon Redshift destination for the delivery stream.void
setRedshiftDestinationConfiguration
(CfnDeliveryStream.RedshiftDestinationConfigurationProperty value) An Amazon Redshift destination for the delivery stream.void
TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.void
TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.void
The configuration of a destination in Splunk for the delivery stream.void
The configuration of a destination in Splunk for the delivery stream.Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef
Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Field Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDeliveryStream
protected CfnDeliveryStream(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDeliveryStream
protected CfnDeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDeliveryStream
@Stability(Stable) public CfnDeliveryStream(@NotNull Construct scope, @NotNull String id, @Nullable CfnDeliveryStreamProps props) Create a newAWS::KinesisFirehose::DeliveryStream
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
CfnDeliveryStream
Create a newAWS::KinesisFirehose::DeliveryStream
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getAttrArn
The Amazon Resource Name (ARN) of the delivery stream, such asarn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name
. -
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
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.
-
getAmazonOpenSearchServerlessDestinationConfiguration
AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
. -
setAmazonOpenSearchServerlessDestinationConfiguration
@Stability(Stable) public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty value) AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
. -
setAmazonOpenSearchServerlessDestinationConfiguration
@Stability(Stable) public void setAmazonOpenSearchServerlessDestinationConfiguration(@Nullable IResolvable value) AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration
. -
getAmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.You can specify only one destination.
-
setAmazonopensearchserviceDestinationConfiguration
@Stability(Stable) public void setAmazonopensearchserviceDestinationConfiguration(@Nullable IResolvable value) The destination in Amazon OpenSearch Service.You can specify only one destination.
-
setAmazonopensearchserviceDestinationConfiguration
@Stability(Stable) public void setAmazonopensearchserviceDestinationConfiguration(@Nullable CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value) 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). -
setDeliveryStreamEncryptionConfigurationInput
@Stability(Stable) public void setDeliveryStreamEncryptionConfigurationInput(@Nullable IResolvable value) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). -
setDeliveryStreamEncryptionConfigurationInput
@Stability(Stable) public void setDeliveryStreamEncryptionConfigurationInput(@Nullable CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value) 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. -
setDeliveryStreamName
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.
-
setDeliveryStreamType
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 .
-
setElasticsearchDestinationConfiguration
@Stability(Stable) public void setElasticsearchDestinationConfiguration(@Nullable IResolvable value) 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 .
-
setElasticsearchDestinationConfiguration
@Stability(Stable) public void setElasticsearchDestinationConfiguration(@Nullable CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value) 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 .
-
setExtendedS3DestinationConfiguration
@Stability(Stable) public void setExtendedS3DestinationConfiguration(@Nullable CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value) 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 .
-
setExtendedS3DestinationConfiguration
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.
-
setHttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.You can specify only one destination.
-
setHttpEndpointDestinationConfiguration
@Stability(Stable) public void setHttpEndpointDestinationConfiguration(@Nullable CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value) 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. -
setKinesisStreamSourceConfiguration
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. -
setKinesisStreamSourceConfiguration
@Stability(Stable) public void setKinesisStreamSourceConfiguration(@Nullable CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value) 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 .
-
setRedshiftDestinationConfiguration
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 .
-
setRedshiftDestinationConfiguration
@Stability(Stable) public void setRedshiftDestinationConfiguration(@Nullable CfnDeliveryStream.RedshiftDestinationConfigurationProperty value) 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 .
-
setS3DestinationConfiguration
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 .
-
setS3DestinationConfiguration
@Stability(Stable) public void setS3DestinationConfiguration(@Nullable CfnDeliveryStream.S3DestinationConfigurationProperty value) 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. -
setSplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream. -
setSplunkDestinationConfiguration
@Stability(Stable) public void setSplunkDestinationConfiguration(@Nullable CfnDeliveryStream.SplunkDestinationConfigurationProperty value) The configuration of a destination in Splunk for the delivery stream.
-