Package software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose

Interface CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStreamPropsMixin

@Stability(Stable)
public static interface CfnDeliveryStreamPropsMixin.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.cfnpropertymixins.services.kinesisfirehose.*;
 HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfigurationProperty = HttpEndpointDestinationConfigurationProperty.builder()
         .bufferingHints(BufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .endpointConfiguration(HttpEndpointConfigurationProperty.builder()
                 .accessKey("accessKey")
                 .name("name")
                 .url("url")
                 .build())
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .type("type")
                         .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")
         .s3Configuration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .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")
                 .roleArn("roleArn")
                 .build())
         .secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder()
                 .enabled(false)
                 .roleArn("roleArn")
                 .secretArn("secretArn")
                 .build())
         .build();
 

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamPropsMixin.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.
default 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.
default Object	getS3Configuration()	Describes the configuration of a destination in Amazon S3.
default Object	getSecretsManagerConfiguration()	The configuration that defines how you access secrets for HTTP Endpoint destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBufferingHints

@Stability(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.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.BufferingHintsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints

getCloudWatchLoggingOptions

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

Describes the Amazon CloudWatch logging options for your delivery stream.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-cloudwatchloggingoptions

getEndpointConfiguration

@Stability(Stable)
@Nullable
default Object getEndpointConfiguration()

The configuration of the HTTP endpoint selected as the destination.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.HttpEndpointConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-endpointconfiguration

getProcessingConfiguration

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

Describes the data processing configuration.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-processingconfiguration

getRequestConfiguration

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

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

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.HttpEndpointRequestConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-requestconfiguration

getRetryOptions

@Stability(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.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.RetryOptionsProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-retryoptions

getRoleArn

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

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-rolearn

getS3BackupMode

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3backupmode

getS3Configuration

@Stability(Stable)
@Nullable
default Object getS3Configuration()

Describes the configuration of a destination in Amazon S3.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-s3configuration

getSecretsManagerConfiguration

@Stability(Stable)
@Nullable
default Object getSecretsManagerConfiguration()

The configuration that defines how you access secrets for HTTP Endpoint destination.

Returns union: either IResolvable or CfnDeliveryStreamPropsMixin.SecretsManagerConfigurationProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-secretsmanagerconfiguration

builder

@Stability(Stable)
static CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty.Builder of CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty