Class CfnDeliveryStreamProps

Properties for defining a CfnDeliveryStream.

Inheritance

object

CfnDeliveryStreamProps

Implements

ICfnDeliveryStreamProps

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.KinesisFirehose

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnDeliveryStreamProps : ICfnDeliveryStreamProps

Syntax (vb)

Public Class CfnDeliveryStreamProps Implements ICfnDeliveryStreamProps

Remarks

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

ExampleMetadata: infused

Examples

var destinationBucket = new Bucket(this, "Bucket");
             var deliveryStreamRole = new Role(this, "Role", new RoleProps {
                 AssumedBy = new ServicePrincipal("firehose.amazonaws.com")
             });

             var stream = new CfnDeliveryStream(this, "MyStream", new CfnDeliveryStreamProps {
                 DeliveryStreamName = "amazon-apigateway-delivery-stream",
                 S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                     BucketArn = destinationBucket.BucketArn,
                     RoleArn = deliveryStreamRole.RoleArn
                 }
             });

             var api = new RestApi(this, "books", new RestApiProps {
                 DeployOptions = new StageOptions {
                     AccessLogDestination = new FirehoseLogDestination(stream),
                     AccessLogFormat = AccessLogFormat.JsonWithStandardFields()
                 }
             });

Synopsis

Constructors

CfnDeliveryStreamProps()

Properties for defining a CfnDeliveryStream.

Properties

AmazonOpenSearchServerlessDestinationConfiguration	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
AmazonopensearchserviceDestinationConfiguration	The destination in Amazon OpenSearch Service.
DatabaseSourceConfiguration	The top level object for configuring streams with database as a source.
DeliveryStreamEncryptionConfigurationInput	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
DeliveryStreamName	The name of the Firehose stream.
DeliveryStreamType	The Firehose stream type. This can be one of the following values:.
DirectPutSourceConfiguration	The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.
ElasticsearchDestinationConfiguration	An Amazon ES destination for the delivery stream.
ExtendedS3DestinationConfiguration	An Amazon S3 destination for the delivery stream.
HttpEndpointDestinationConfiguration	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
IcebergDestinationConfiguration	Specifies the destination configure settings for Apache Iceberg Table.
KinesisStreamSourceConfiguration	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.
MskSourceConfiguration	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
RedshiftDestinationConfiguration	An Amazon Redshift destination for the delivery stream.
S3DestinationConfiguration	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
SnowflakeDestinationConfiguration	Configure Snowflake destination.
SplunkDestinationConfiguration	The configuration of a destination in Splunk for the delivery stream.
Tags	A set of tags to assign to the Firehose stream.

Constructors

CfnDeliveryStreamProps()

Properties for defining a CfnDeliveryStream.

public CfnDeliveryStreamProps()

Remarks

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

ExampleMetadata: infused

Examples

var destinationBucket = new Bucket(this, "Bucket");
             var deliveryStreamRole = new Role(this, "Role", new RoleProps {
                 AssumedBy = new ServicePrincipal("firehose.amazonaws.com")
             });

             var stream = new CfnDeliveryStream(this, "MyStream", new CfnDeliveryStreamProps {
                 DeliveryStreamName = "amazon-apigateway-delivery-stream",
                 S3DestinationConfiguration = new S3DestinationConfigurationProperty {
                     BucketArn = destinationBucket.BucketArn,
                     RoleArn = deliveryStreamRole.RoleArn
                 }
             });

             var api = new RestApi(this, "books", new RestApiProps {
                 DeployOptions = new StageOptions {
                     AccessLogDestination = new FirehoseLogDestination(stream),
                     AccessLogFormat = AccessLogFormat.JsonWithStandardFields()
                 }
             });

Properties

AmazonOpenSearchServerlessDestinationConfiguration

Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

public object? AmazonOpenSearchServerlessDestinationConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchserverlessdestinationconfiguration

AmazonopensearchserviceDestinationConfiguration

The destination in Amazon OpenSearch Service.

public object? AmazonopensearchserviceDestinationConfiguration { get; set; }

Property Value

object

Remarks

You can specify only one destination.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-amazonopensearchservicedestinationconfiguration

DatabaseSourceConfiguration

The top level object for configuring streams with database as a source.

public object? DatabaseSourceConfiguration { get; set; }

Property Value

object

Remarks

Amazon Data Firehose is in preview release and is subject to change.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-databasesourceconfiguration

DeliveryStreamEncryptionConfigurationInput

Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

public object? DeliveryStreamEncryptionConfigurationInput { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamencryptionconfigurationinput

DeliveryStreamName

The name of the Firehose stream.

public string? DeliveryStreamName { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamname

DeliveryStreamType

The Firehose stream type. This can be one of the following values:.

public string? DeliveryStreamType { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-deliverystreamtype

DirectPutSourceConfiguration

The structure that configures parameters such as ThroughputHintInMBs for a stream configured with Direct PUT as a source.

public object? DirectPutSourceConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-directputsourceconfiguration

ElasticsearchDestinationConfiguration

An Amazon ES destination for the delivery stream.

public object? ElasticsearchDestinationConfiguration { get; set; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-elasticsearchdestinationconfiguration

ExtendedS3DestinationConfiguration

An Amazon S3 destination for the delivery stream.

public object? ExtendedS3DestinationConfiguration { get; set; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-extendeds3destinationconfiguration

HttpEndpointDestinationConfiguration

Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.

public object? HttpEndpointDestinationConfiguration { get; set; }

Property Value

object

Remarks

You can specify only one destination.

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

IcebergDestinationConfiguration

Specifies the destination configure settings for Apache Iceberg Table.

public object? IcebergDestinationConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-icebergdestinationconfiguration

KinesisStreamSourceConfiguration

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.

public object? KinesisStreamSourceConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration

MskSourceConfiguration

The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

public object? MskSourceConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-msksourceconfiguration

RedshiftDestinationConfiguration

An Amazon Redshift destination for the delivery stream.

public object? RedshiftDestinationConfiguration { get; set; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-redshiftdestinationconfiguration

S3DestinationConfiguration

The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.

public object? S3DestinationConfiguration { get; set; }

Property Value

object

Remarks

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 .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-s3destinationconfiguration

SnowflakeDestinationConfiguration

Configure Snowflake destination.

public object? SnowflakeDestinationConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-snowflakedestinationconfiguration

SplunkDestinationConfiguration

The configuration of a destination in Splunk for the delivery stream.

public object? SplunkDestinationConfiguration { get; set; }

Property Value

object

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-splunkdestinationconfiguration

Tags

A set of tags to assign to the Firehose stream.

public ICfnTag[]? Tags { get; set; }

Property Value

ICfnTag[]

Remarks

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

If you specify tags in the CreateDeliveryStream action, Amazon Data Firehose performs an additional authorization on the firehose:TagDeliveryStream action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose streams with IAM resource tags will fail with an AccessDeniedException such as following.

AccessDeniedException

User: arn:aws:sts::x:assumed-role/x/x is not authorized to perform: firehose:TagDeliveryStream on resource: arn:aws:firehose:us-east-1:x:deliverystream/x with an explicit deny in an identity-based policy.

For an example IAM policy, see Tag example.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kinesisfirehose-deliverystream.html#cfn-kinesisfirehose-deliverystream-tags

Implements

ICfnDeliveryStreamProps