Class CfnDeliveryStreamProps
Properties for defining a CfnDeliveryStream.
Inheritance
Implements
Namespace: Amazon.CDK.AWS.KinesisFirehose
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDeliveryStreamProps : Object, ICfnDeliveryStreamPropsSyntax (vb)
Public Class CfnDeliveryStreamProps
Inherits Object
Implements ICfnDeliveryStreamPropsRemarks
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
| Cfn |
Properties
| Amazon |
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service. |
| Amazonopensearchservice |
The destination in Amazon OpenSearch Service. |
| Database |
The top level object for configuring streams with database as a source. |
| Delivery |
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). |
| Delivery |
The name of the Firehose stream. |
| Delivery |
The Firehose stream type. This can be one of the following values:. |
| Direct |
The structure that configures parameters such as |
| Elasticsearch |
An Amazon ES destination for the delivery stream. |
| Extended |
An Amazon S3 destination for the delivery stream. |
| Http |
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. |
| Iceberg |
Specifies the destination configure settings for Apache Iceberg Table. |
| Kinesis |
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. |
| Msk |
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. |
| Redshift |
An Amazon Redshift destination for the delivery stream. |
| S3Destination |
The |
| Snowflake |
Configure Snowflake destination. |
| Splunk |
The configuration of a destination in Splunk for the delivery stream. |
| Tags | A set of tags to assign to the Firehose stream. |
Constructors
CfnDeliveryStreamProps()
public CfnDeliveryStreamProps()Properties
AmazonOpenSearchServerlessDestinationConfiguration
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
public object AmazonOpenSearchServerlessDestinationConfiguration { get; set; }Property Value
System.
Remarks
AmazonopensearchserviceDestinationConfiguration
The destination in Amazon OpenSearch Service.
public object AmazonopensearchserviceDestinationConfiguration { get; set; }Property Value
System.
Remarks
DatabaseSourceConfiguration
The top level object for configuring streams with database as a source.
public object DatabaseSourceConfiguration { get; set; }Property Value
System.
Remarks
Amazon Data Firehose is in preview release and is subject to change.
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
System.
Remarks
DeliveryStreamName
The name of the Firehose stream.
public string DeliveryStreamName { get; set; }Property Value
System.
Remarks
DeliveryStreamType
The Firehose stream type. This can be one of the following values:.
public string DeliveryStreamType { get; set; }Property Value
System.
Remarks
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
System.
Remarks
ElasticsearchDestinationConfiguration
An Amazon ES destination for the delivery stream.
public object ElasticsearchDestinationConfiguration { get; set; }Property Value
System.
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 .
ExtendedS3DestinationConfiguration
An Amazon S3 destination for the delivery stream.
public object ExtendedS3DestinationConfiguration { get; set; }Property Value
System.
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 .
HttpEndpointDestinationConfiguration
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
public object HttpEndpointDestinationConfiguration { get; set; }Property Value
System.
Remarks
IcebergDestinationConfiguration
Specifies the destination configure settings for Apache Iceberg Table.
public object IcebergDestinationConfiguration { get; set; }Property Value
System.
Remarks
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
System.
Remarks
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
System.
Remarks
RedshiftDestinationConfiguration
An Amazon Redshift destination for the delivery stream.
public object RedshiftDestinationConfiguration { get; set; }Property Value
System.
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 .
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
System.
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 .
SnowflakeDestinationConfiguration
Configure Snowflake destination.
public object SnowflakeDestinationConfiguration { get; set; }Property Value
System.
Remarks
SplunkDestinationConfiguration
The configuration of a destination in Splunk for the delivery stream.
public object SplunkDestinationConfiguration { get; set; }Property Value
System.
Remarks
Tags
A set of tags to assign to the Firehose stream.
public ICfnTag[] Tags { get; set; }Property Value
ICfn
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.