@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
date="2022-11-29T04:32:21.968Z")
public class CfnDeliveryStream
extends CfnResource
implements IInspectable
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")
.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")
.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")
.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();
| Modifier and Type | Class and Description |
|---|---|
static interface |
CfnDeliveryStream.AmazonopensearchserviceBufferingHintsProperty
Describes the buffering to perform before delivering data to the Amazon OpenSearch Service destination.
|
static interface |
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
Describes the configuration of a destination in Amazon OpenSearch Service.
|
static interface |
CfnDeliveryStream.AmazonopensearchserviceRetryOptionsProperty
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
|
static interface |
CfnDeliveryStream.BufferingHintsProperty
The `BufferingHints` property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data before delivering it to the destination.
|
static class |
CfnDeliveryStream.Builder
A fluent builder for
CfnDeliveryStream. |
static interface |
CfnDeliveryStream.CloudWatchLoggingOptionsProperty
The `CloudWatchLoggingOptions` 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 |
CfnDeliveryStream.CopyCommandProperty
The `CopyCommand` property type configures the Amazon Redshift `COPY` 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 |
CfnDeliveryStream.DataFormatConversionConfigurationProperty
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 |
CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
static interface |
CfnDeliveryStream.DeserializerProperty
The deserializer you want Kinesis Data Firehose to use for converting the input data from JSON.
|
static interface |
CfnDeliveryStream.DynamicPartitioningConfigurationProperty
The `DynamicPartitioningConfiguration` 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 |
CfnDeliveryStream.ElasticsearchBufferingHintsProperty
The `ElasticsearchBufferingHints` property type specifies how Amazon Kinesis Data Firehose (Kinesis Data Firehose) buffers incoming data while delivering it to the destination.
|
static interface |
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty
The `ElasticsearchDestinationConfiguration` property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.
|
static interface |
CfnDeliveryStream.ElasticsearchRetryOptionsProperty
The `ElasticsearchRetryOptions` 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 |
CfnDeliveryStream.EncryptionConfigurationProperty
The `EncryptionConfiguration` 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 |
CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty
The `ExtendedS3DestinationConfiguration` property type configures an Amazon S3 destination for an Amazon Kinesis Data Firehose delivery stream.
|
static interface |
CfnDeliveryStream.HiveJsonSerDeProperty
The native Hive / HCatalog JsonSerDe.
|
static interface |
CfnDeliveryStream.HttpEndpointCommonAttributeProperty
Describes the metadata that's delivered to the specified HTTP endpoint destination.
|
static interface |
CfnDeliveryStream.HttpEndpointConfigurationProperty
Describes the configuration of the HTTP endpoint to which Kinesis Firehose delivers data.
|
static interface |
CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty
Describes the configuration of the HTTP endpoint destination.
|
static interface |
CfnDeliveryStream.HttpEndpointRequestConfigurationProperty
The configuration of the HTTP endpoint request.
|
static interface |
CfnDeliveryStream.InputFormatConfigurationProperty
Specifies the deserializer you want to use to convert the format of the input data.
|
static interface |
CfnDeliveryStream.KinesisStreamSourceConfigurationProperty
The `KinesisStreamSourceConfiguration` 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 |
CfnDeliveryStream.KMSEncryptionConfigProperty
The `KMSEncryptionConfig` 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 |
CfnDeliveryStream.OpenXJsonSerDeProperty
The OpenX SerDe.
|
static interface |
CfnDeliveryStream.OrcSerDeProperty
A serializer to use for converting data to the ORC format before storing it in Amazon S3.
|
static interface |
CfnDeliveryStream.OutputFormatConfigurationProperty
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 |
CfnDeliveryStream.ParquetSerDeProperty
A serializer to use for converting data to the Parquet format before storing it in Amazon S3.
|
static interface |
CfnDeliveryStream.ProcessingConfigurationProperty
The `ProcessingConfiguration` property configures data processing for an Amazon Kinesis Data Firehose delivery stream.
|
static interface |
CfnDeliveryStream.ProcessorParameterProperty
The `ProcessorParameter` property specifies a processor parameter in a data processor for an Amazon Kinesis Data Firehose delivery stream.
|
static interface |
CfnDeliveryStream.ProcessorProperty
The `Processor` property specifies a data processor for an Amazon Kinesis Data Firehose delivery stream.
|
static interface |
CfnDeliveryStream.RedshiftDestinationConfigurationProperty
The `RedshiftDestinationConfiguration` property type specifies an Amazon Redshift cluster to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
|
static interface |
CfnDeliveryStream.RedshiftRetryOptionsProperty
Configures retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon Redshift.
|
static interface |
CfnDeliveryStream.RetryOptionsProperty
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 |
CfnDeliveryStream.S3DestinationConfigurationProperty
The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
|
static interface |
CfnDeliveryStream.SchemaConfigurationProperty
Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.
|
static interface |
CfnDeliveryStream.SerializerProperty
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 |
CfnDeliveryStream.SplunkDestinationConfigurationProperty
The `SplunkDestinationConfiguration` property type specifies the configuration of a destination in Splunk for a Kinesis Data Firehose delivery stream.
|
static interface |
CfnDeliveryStream.SplunkRetryOptionsProperty
The `SplunkRetryOptions` 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 |
CfnDeliveryStream.VpcConfigurationProperty
The details of the VPC of the Amazon ES destination.
|
IInspectable.Jsii$Default, IInspectable.Jsii$ProxyIConstruct.Jsii$Default| Modifier and Type | Field and Description |
|---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
| Modifier | Constructor and Description |
|---|---|
|
CfnDeliveryStream(Construct scope,
java.lang.String id)
Create a new `AWS::KinesisFirehose::DeliveryStream`.
|
|
CfnDeliveryStream(Construct scope,
java.lang.String id,
CfnDeliveryStreamProps props)
Create a new `AWS::KinesisFirehose::DeliveryStream`.
|
protected |
CfnDeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) |
protected |
CfnDeliveryStream(software.amazon.jsii.JsiiObjectRef objRef) |
| Modifier and Type | Method and Description |
|---|---|
java.lang.Object |
getAmazonopensearchserviceDestinationConfiguration()
The destination in Amazon OpenSearch Service.
|
java.lang.String |
getAttrArn()
The Amazon Resource Name (ARN) of the delivery stream, such as `arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name` .
|
protected java.util.Map<java.lang.String,java.lang.Object> |
getCfnProperties() |
java.lang.Object |
getDeliveryStreamEncryptionConfigurationInput()
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
java.lang.String |
getDeliveryStreamName()
The name of the delivery stream.
|
java.lang.String |
getDeliveryStreamType()
The delivery stream type.
|
java.lang.Object |
getElasticsearchDestinationConfiguration()
An Amazon ES destination for the delivery stream.
|
java.lang.Object |
getExtendedS3DestinationConfiguration()
An Amazon S3 destination for the delivery stream.
|
java.lang.Object |
getHttpEndpointDestinationConfiguration()
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
java.lang.Object |
getKinesisStreamSourceConfiguration()
When a Kinesis stream is used as the source for the delivery stream, a [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role ARN for the source stream.
|
java.lang.Object |
getRedshiftDestinationConfiguration()
An Amazon Redshift destination for the delivery stream.
|
java.lang.Object |
getS3DestinationConfiguration()
The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
|
java.lang.Object |
getSplunkDestinationConfiguration()
The configuration of a destination in Splunk for the delivery stream.
|
TagManager |
getTags()
A set of tags to assign to the delivery stream.
|
void |
inspect(TreeInspector inspector)
Examines the CloudFormation resource and discloses attributes.
|
protected java.util.Map<java.lang.String,java.lang.Object> |
renderProperties(java.util.Map<java.lang.String,java.lang.Object> props) |
void |
setAmazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value)
The destination in Amazon OpenSearch Service.
|
void |
setAmazonopensearchserviceDestinationConfiguration(IResolvable value)
The destination in Amazon OpenSearch Service.
|
void |
setDeliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value)
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
void |
setDeliveryStreamEncryptionConfigurationInput(IResolvable value)
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
void |
setDeliveryStreamName(java.lang.String value)
The name of the delivery stream.
|
void |
setDeliveryStreamType(java.lang.String value)
The delivery stream type.
|
void |
setElasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value)
An Amazon ES destination for the delivery stream.
|
void |
setElasticsearchDestinationConfiguration(IResolvable value)
An Amazon ES destination for the delivery stream.
|
void |
setExtendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value)
An Amazon S3 destination for the delivery stream.
|
void |
setExtendedS3DestinationConfiguration(IResolvable value)
An Amazon S3 destination for the delivery stream.
|
void |
setHttpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value)
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
void |
setHttpEndpointDestinationConfiguration(IResolvable value)
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
void |
setKinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value)
When a Kinesis stream is used as the source for the delivery stream, a [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role ARN for the source stream.
|
void |
setKinesisStreamSourceConfiguration(IResolvable value)
When a Kinesis stream is used as the source for the delivery stream, a [KinesisStreamSourceConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html) containing the Kinesis stream ARN and the role ARN for the source stream.
|
void |
setRedshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty value)
An Amazon Redshift destination for the delivery stream.
|
void |
setRedshiftDestinationConfiguration(IResolvable value)
An Amazon Redshift destination for the delivery stream.
|
void |
setS3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty value)
The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
|
void |
setS3DestinationConfiguration(IResolvable value)
The `S3DestinationConfiguration` property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
|
void |
setSplunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty value)
The configuration of a destination in Splunk for the delivery stream.
|
void |
setSplunkDestinationConfiguration(IResolvable value)
The configuration of a destination in Splunk for the delivery stream.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validatePropertiesgetRefgetCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalIdgetNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validatepublic static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDeliveryStream(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDeliveryStream(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDeliveryStream(Construct scope, java.lang.String id, CfnDeliveryStreamProps props)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.props - - resource properties.public CfnDeliveryStream(Construct scope, java.lang.String id)
scope - - scope in which this resource is defined. This parameter is required.id - - scoped id of the resource. This parameter is required.public void inspect(TreeInspector inspector)
inspect in interface IInspectableinspector - - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties in class CfnResourceprops - This parameter is required.public java.lang.String getAttrArn()
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties in class CfnResourcepublic TagManager getTags()
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.
public java.lang.Object getAmazonopensearchserviceDestinationConfiguration()
You can specify only one destination.
public void setAmazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty value)
You can specify only one destination.
public void setAmazonopensearchserviceDestinationConfiguration(IResolvable value)
You can specify only one destination.
public java.lang.Object getDeliveryStreamEncryptionConfigurationInput()
public void setDeliveryStreamEncryptionConfigurationInput(IResolvable value)
public void setDeliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty value)
public java.lang.String getDeliveryStreamName()
public void setDeliveryStreamName(java.lang.String value)
public java.lang.String getDeliveryStreamType()
DirectPut : Provider applications access the delivery stream directly.KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.public void setDeliveryStreamType(java.lang.String value)
DirectPut : Provider applications access the delivery stream directly.KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.public java.lang.Object getElasticsearchDestinationConfiguration()
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 .
public void setElasticsearchDestinationConfiguration(IResolvable value)
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 .
public void setElasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty value)
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 .
public java.lang.Object getExtendedS3DestinationConfiguration()
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 .
public void setExtendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty value)
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 .
public void setExtendedS3DestinationConfiguration(IResolvable value)
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 .
public java.lang.Object getHttpEndpointDestinationConfiguration()
You can specify only one destination.
public void setHttpEndpointDestinationConfiguration(IResolvable value)
You can specify only one destination.
public void setHttpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty value)
You can specify only one destination.
public java.lang.Object getKinesisStreamSourceConfiguration()
public void setKinesisStreamSourceConfiguration(IResolvable value)
public void setKinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty value)
public java.lang.Object getRedshiftDestinationConfiguration()
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 .
public void setRedshiftDestinationConfiguration(IResolvable value)
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 .
public void setRedshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty value)
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 .
public java.lang.Object getS3DestinationConfiguration()
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 .
public void setS3DestinationConfiguration(IResolvable value)
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 .
public void setS3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty value)
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 .
public java.lang.Object getSplunkDestinationConfiguration()
public void setSplunkDestinationConfiguration(IResolvable value)
public void setSplunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty value)