@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)", date="2022-09-19T20:26:40.309Z") @Stability(value=Stable) public interface CfnDeliveryStreamProps extends software.amazon.jsii.JsiiSerializable
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()
.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 | Interface and Description |
|---|---|
static class |
CfnDeliveryStreamProps.Builder
A builder for
CfnDeliveryStreamProps |
static class |
CfnDeliveryStreamProps.Jsii$Proxy
An implementation for
CfnDeliveryStreamProps |
| Modifier and Type | Method and Description |
|---|---|
static CfnDeliveryStreamProps.Builder |
builder() |
default Object |
getAmazonopensearchserviceDestinationConfiguration()
The destination in Amazon OpenSearch Service.
|
default Object |
getDeliveryStreamEncryptionConfigurationInput()
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
|
default String |
getDeliveryStreamName()
The name of the delivery stream.
|
default String |
getDeliveryStreamType()
The delivery stream type.
|
default Object |
getElasticsearchDestinationConfiguration()
An Amazon ES destination for the delivery stream.
|
default Object |
getExtendedS3DestinationConfiguration()
An Amazon S3 destination for the delivery stream.
|
default Object |
getHttpEndpointDestinationConfiguration()
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
|
default 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.
|
default Object |
getRedshiftDestinationConfiguration()
An Amazon Redshift destination for the delivery stream.
|
default 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.
|
default Object |
getSplunkDestinationConfiguration()
The configuration of a destination in Splunk for the delivery stream.
|
default List<CfnTag> |
getTags()
A set of tags to assign to the delivery stream.
|
@Stability(value=Stable) @Nullable default Object getAmazonopensearchserviceDestinationConfiguration()
You can specify only one destination.
@Stability(value=Stable) @Nullable default Object getDeliveryStreamEncryptionConfigurationInput()
@Stability(value=Stable) @Nullable default String getDeliveryStreamName()
@Stability(value=Stable) @Nullable default String getDeliveryStreamType()
DirectPut : Provider applications access the delivery stream directly.KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.@Stability(value=Stable) @Nullable default 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 .
@Stability(value=Stable) @Nullable default 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 .
@Stability(value=Stable) @Nullable default Object getHttpEndpointDestinationConfiguration()
You can specify only one destination.
@Stability(value=Stable) @Nullable default Object getKinesisStreamSourceConfiguration()
@Stability(value=Stable) @Nullable default 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 .
@Stability(value=Stable) @Nullable default 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 .
@Stability(value=Stable) @Nullable default Object getSplunkDestinationConfiguration()
@Stability(value=Stable) @Nullable default List<CfnTag> 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.
@Stability(value=Stable) static CfnDeliveryStreamProps.Builder builder()
CfnDeliveryStreamProps.Builder of CfnDeliveryStreamPropsCopyright © 2022. All rights reserved.