Class CfnDeliveryStream

java.lang.Object
software.amazon.jsii.JsiiObject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:40.982Z") @Stability(Stable) public class CfnDeliveryStream extends CfnResource implements IInspectable
A CloudFormation 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();
 
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 new AWS::KinesisFirehose::DeliveryStream.

      Parameters:
      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.
    • CfnDeliveryStream

      @Stability(Stable) public CfnDeliveryStream(@NotNull Construct scope, @NotNull String id)
      Create a new AWS::KinesisFirehose::DeliveryStream.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector -
      • tree inspector to collect and process attributes.
      This parameter is required.
    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.
    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the delivery stream, such as arn:aws:firehose:us-east-2:123456789012:deliverystream/delivery-stream-name .
    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getTags

      @Stability(Stable) @NotNull public TagManager 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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) @Nullable public String getDeliveryStreamName()
      The name of the delivery stream.
    • setDeliveryStreamName

      @Stability(Stable) public void setDeliveryStreamName(@Nullable String value)
      The name of the delivery stream.
    • getDeliveryStreamType

      @Stability(Stable) @Nullable public String 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

      @Stability(Stable) public void setDeliveryStreamType(@Nullable String value)
      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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) public void setExtendedS3DestinationConfiguration(@Nullable IResolvable 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 .

    • getHttpEndpointDestinationConfiguration

      @Stability(Stable) @Nullable public Object getHttpEndpointDestinationConfiguration()
      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 IResolvable value)
      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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) public void setKinesisStreamSourceConfiguration(@Nullable IResolvable 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.
    • 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

      @Stability(Stable) @Nullable public Object 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

      @Stability(Stable) public void setRedshiftDestinationConfiguration(@Nullable IResolvable 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 .

    • 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

      @Stability(Stable) @Nullable public 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.

      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 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.

      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)
      The S3DestinationConfiguration 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

      @Stability(Stable) @Nullable public Object getSplunkDestinationConfiguration()
      The configuration of a destination in Splunk for the delivery stream.
    • setSplunkDestinationConfiguration

      @Stability(Stable) public void setSplunkDestinationConfiguration(@Nullable IResolvable value)
      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.