Class CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty

Describes the configuration of the HTTP endpoint destination.

Inheritance

object

CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty

Implements

CfnDeliveryStreamPropsMixin.IHttpEndpointDestinationConfigurationProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.CfnPropertyMixins.AWS.KinesisFirehose

Assembly: Amazon.CDK.CfnPropertyMixins.dll

Syntax (csharp)

public class CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty : CfnDeliveryStreamPropsMixin.IHttpEndpointDestinationConfigurationProperty

Syntax (vb)

Public Class CfnDeliveryStreamPropsMixin.HttpEndpointDestinationConfigurationProperty Implements CfnDeliveryStreamPropsMixin.IHttpEndpointDestinationConfigurationProperty

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.KinesisFirehose;

             var httpEndpointDestinationConfigurationProperty = new HttpEndpointDestinationConfigurationProperty {
                 BufferingHints = new BufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 EndpointConfiguration = new HttpEndpointConfigurationProperty {
                     AccessKey = "accessKey",
                     Name = "name",
                     Url = "url"
                 },
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RequestConfiguration = new HttpEndpointRequestConfigurationProperty {
                     CommonAttributes = new [] { new HttpEndpointCommonAttributeProperty {
                         AttributeName = "attributeName",
                         AttributeValue = "attributeValue"
                     } },
                     ContentEncoding = "contentEncoding"
                 },
                 RetryOptions = new RetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 SecretsManagerConfiguration = new SecretsManagerConfigurationProperty {
                     Enabled = false,
                     RoleArn = "roleArn",
                     SecretArn = "secretArn"
                 }
             };

Synopsis

Constructors

HttpEndpointDestinationConfigurationProperty()

Describes the configuration of the HTTP endpoint destination.

Properties

BufferingHints	The buffering options that can be used before data is delivered to the specified destination.
CloudWatchLoggingOptions	Describes the Amazon CloudWatch logging options for your delivery stream.
EndpointConfiguration	The configuration of the HTTP endpoint selected as the destination.
ProcessingConfiguration	Describes the data processing configuration.
RequestConfiguration	The configuration of the request sent to the HTTP endpoint specified as the destination.
RetryOptions	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.
RoleArn	Kinesis Data Firehose uses this IAM role for all the permissions that the delivery stream needs.
S3BackupMode	Describes the S3 bucket backup options for the data that Kinesis Data Firehose delivers to the HTTP endpoint destination.
S3Configuration	Describes the configuration of a destination in Amazon S3.
SecretsManagerConfiguration	The configuration that defines how you access secrets for HTTP Endpoint destination.

Constructors

HttpEndpointDestinationConfigurationProperty()

Describes the configuration of the HTTP endpoint destination.

public HttpEndpointDestinationConfigurationProperty()

Remarks

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

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

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.CfnPropertyMixins.AWS.KinesisFirehose;

             var httpEndpointDestinationConfigurationProperty = new HttpEndpointDestinationConfigurationProperty {
                 BufferingHints = new BufferingHintsProperty {
                     IntervalInSeconds = 123,
                     SizeInMBs = 123
                 },
                 CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                     Enabled = false,
                     LogGroupName = "logGroupName",
                     LogStreamName = "logStreamName"
                 },
                 EndpointConfiguration = new HttpEndpointConfigurationProperty {
                     AccessKey = "accessKey",
                     Name = "name",
                     Url = "url"
                 },
                 ProcessingConfiguration = new ProcessingConfigurationProperty {
                     Enabled = false,
                     Processors = new [] { new ProcessorProperty {
                         Parameters = new [] { new ProcessorParameterProperty {
                             ParameterName = "parameterName",
                             ParameterValue = "parameterValue"
                         } },
                         Type = "type"
                     } }
                 },
                 RequestConfiguration = new HttpEndpointRequestConfigurationProperty {
                     CommonAttributes = new [] { new HttpEndpointCommonAttributeProperty {
                         AttributeName = "attributeName",
                         AttributeValue = "attributeValue"
                     } },
                     ContentEncoding = "contentEncoding"
                 },
                 RetryOptions = new RetryOptionsProperty {
                     DurationInSeconds = 123
                 },
                 RoleArn = "roleArn",
                 S3BackupMode = "s3BackupMode",
                 S3Configuration = new S3DestinationConfigurationProperty {
                     BucketArn = "bucketArn",
                     BufferingHints = new BufferingHintsProperty {
                         IntervalInSeconds = 123,
                         SizeInMBs = 123
                     },
                     CloudWatchLoggingOptions = new CloudWatchLoggingOptionsProperty {
                         Enabled = false,
                         LogGroupName = "logGroupName",
                         LogStreamName = "logStreamName"
                     },
                     CompressionFormat = "compressionFormat",
                     EncryptionConfiguration = new EncryptionConfigurationProperty {
                         KmsEncryptionConfig = new KMSEncryptionConfigProperty {
                             AwskmsKeyArn = "awskmsKeyArn"
                         },
                         NoEncryptionConfig = "noEncryptionConfig"
                     },
                     ErrorOutputPrefix = "errorOutputPrefix",
                     Prefix = "prefix",
                     RoleArn = "roleArn"
                 },
                 SecretsManagerConfiguration = new SecretsManagerConfigurationProperty {
                     Enabled = false,
                     RoleArn = "roleArn",
                     SecretArn = "secretArn"
                 }
             };

Properties

BufferingHints

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

public object? BufferingHints { get; set; }

Property Value

object

Remarks

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: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration.html#cfn-kinesisfirehose-deliverystream-httpendpointdestinationconfiguration-bufferinghints

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IBufferingHintsProperty

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your delivery stream.

public object? CloudWatchLoggingOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.ICloudWatchLoggingOptionsProperty

EndpointConfiguration

The configuration of the HTTP endpoint selected as the destination.

public object? EndpointConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IHttpEndpointConfigurationProperty

ProcessingConfiguration

Describes the data processing configuration.

public object? ProcessingConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IProcessingConfigurationProperty

RequestConfiguration

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

public object? RequestConfiguration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IHttpEndpointRequestConfigurationProperty

RetryOptions

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.

public object? RetryOptions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IRetryOptionsProperty

RoleArn

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

public string? RoleArn { get; set; }

Property Value

string

Remarks

S3BackupMode

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

public string? S3BackupMode { get; set; }

Property Value

string

Remarks

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

S3Configuration

Describes the configuration of a destination in Amazon S3.

public object? S3Configuration { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnDeliveryStreamPropsMixin.IS3DestinationConfigurationProperty

SecretsManagerConfiguration

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

public object? SecretsManagerConfiguration { get; set; }