software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(value=Stable)
public static interface CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the configuration of the HTTP endpoint destination.

Kinesis Firehose supports any custom HTTP endpoint or HTTP endpoints owned by supported third-party service providers, including Datadog, MongoDB, and New Relic.

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.*;
 HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfigurationProperty = 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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Builder A builder for CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty
static class	CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Jsii$Proxy An implementation for CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Builder	builder()
default Object	getBufferingHints() The buffering options that can be used before data is delivered to the specified destination.
default Object	getCloudWatchLoggingOptions() Describes the Amazon CloudWatch logging options for your delivery stream.
Object	getEndpointConfiguration() The configuration of the HTTP endpoint selected as the destination.
default Object	getProcessingConfiguration() Describes the data processing configuration.
default Object	getRequestConfiguration() The configuration of the request sent to the HTTP endpoint specified as the destination.
default Object	getRetryOptions() 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.
default String	getRoleArn() Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
default String	getS3BackupMode() Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.
Object	getS3Configuration() Describes the configuration of a destination in Amazon S3.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getEndpointConfiguration

@Stability(value=Stable)
 @NotNull
Object getEndpointConfiguration()

The configuration of the HTTP endpoint selected as the destination.

getS3Configuration

@Stability(value=Stable)
 @NotNull
Object getS3Configuration()

Describes the configuration of a destination in Amazon S3.

getBufferingHints

@Stability(value=Stable)
 @Nullable
default Object getBufferingHints()

The buffering options that can be used before data is delivered to the specified destination.

Kinesis Data Firehose treats these options as hints, and it might choose to use more optimal values. The SizeInMBs and IntervalInSeconds parameters are optional. However, if you specify a value for one of them, you must also provide a value for the other.

getCloudWatchLoggingOptions

@Stability(value=Stable)
 @Nullable
default Object getCloudWatchLoggingOptions()

Describes the Amazon CloudWatch logging options for your delivery stream.

getProcessingConfiguration

@Stability(value=Stable)
 @Nullable
default Object getProcessingConfiguration()

Describes the data processing configuration.

getRequestConfiguration

@Stability(value=Stable)
 @Nullable
default Object getRequestConfiguration()

The configuration of the request sent to the HTTP endpoint specified as the destination.

getRetryOptions

@Stability(value=Stable)
 @Nullable
default Object getRetryOptions()

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.

getRoleArn

@Stability(value=Stable)
 @Nullable
default String getRoleArn()

Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.

getS3BackupMode

@Stability(value=Stable)
 @Nullable
default String getS3BackupMode()

Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.

You can back up all documents (AllData) or only the documents that Kinesis Data Firehose could not deliver to the specified HTTP endpoint destination (FailedDataOnly).

builder

@Stability(value=Stable)
static CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Builder of CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty