Interface CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
@Stability(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") .secretsManagerConfiguration(SecretsManagerConfigurationProperty.builder() .enabled(false) // the properties below are optional .roleArn("roleArn") .secretArn("secretArn") .build()) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnDeliveryStream.HttpEndpointDestinationConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The buffering options that can be used before data is delivered to the specified destination.default Object
Describes the Amazon CloudWatch logging options for your delivery stream.The configuration of the HTTP endpoint selected as the destination.default Object
Describes the data processing configuration.default Object
The configuration of the request sent to the HTTP endpoint specified as the destination.default Object
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
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.default String
Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.Describes the configuration of a destination in Amazon S3.default Object
The configuration that defines how you access secrets for HTTP Endpoint destination.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getEndpointConfiguration
The configuration of the HTTP endpoint selected as the destination.- See Also:
-
getS3Configuration
Describes the configuration of a destination in Amazon S3.- See Also:
-
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.
- See Also:
-
getCloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.- See Also:
-
getProcessingConfiguration
Describes the data processing configuration.- See Also:
-
getRequestConfiguration
The configuration of the request sent to the HTTP endpoint specified as the destination.- See Also:
-
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.- See Also:
-
getRoleArn
Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.- See Also:
-
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:
-
getSecretsManagerConfiguration
The configuration that defines how you access secrets for HTTP Endpoint destination.- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty.Builder builder()
-