interface CfnDeliveryStreamProps
Language | Type name |
---|---|
.NET | Amazon.CDK.AWS.KinesisFirehose.CfnDeliveryStreamProps |
Go | github.com/aws/aws-cdk-go/awscdk/v2/awskinesisfirehose#CfnDeliveryStreamProps |
Java | software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStreamProps |
Python | aws_cdk.aws_kinesisfirehose.CfnDeliveryStreamProps |
TypeScript | aws-cdk-lib » aws_kinesisfirehose » CfnDeliveryStreamProps |
Properties for defining a CfnDeliveryStream
.
Example
const destinationBucket = new s3.Bucket(this, 'Bucket');
const deliveryStreamRole = new iam.Role(this, 'Role', {
assumedBy: new iam.ServicePrincipal('firehose.amazonaws.com'),
});
const stream = new firehose.CfnDeliveryStream(this, 'MyStream', {
deliveryStreamName: 'amazon-apigateway-delivery-stream',
s3DestinationConfiguration: {
bucketArn: destinationBucket.bucketArn,
roleArn: deliveryStreamRole.roleArn,
},
});
const api = new apigateway.RestApi(this, 'books', {
deployOptions: {
accessLogDestination: new apigateway.FirehoseLogDestination(stream),
accessLogFormat: apigateway.AccessLogFormat.jsonWithStandardFields(),
},
});
Properties
Name | Type | Description |
---|---|---|
amazon | IResolvable | Amazon | Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service. |
amazonopensearchservice | IResolvable | Amazonopensearchservice | The destination in Amazon OpenSearch Service. |
delivery | IResolvable | Delivery | Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). |
delivery | string | The name of the delivery stream. |
delivery | string | The delivery stream type. This can be one of the following values:. |
elasticsearch | IResolvable | Elasticsearch | An Amazon ES destination for the delivery stream. |
extended | IResolvable | Extended | An Amazon S3 destination for the delivery stream. |
http | IResolvable | Http | Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. |
iceberg | IResolvable | Iceberg | Specifies the destination configure settings for Apache Iceberg Table. |
kinesis | IResolvable | 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 | IResolvable | MSKSource | The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. |
redshift | IResolvable | Redshift | An Amazon Redshift destination for the delivery stream. |
s3 | IResolvable | S3 | The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. |
snowflake | IResolvable | Snowflake | Configure Snowflake destination. |
splunk | IResolvable | Splunk | The configuration of a destination in Splunk for the delivery stream. |
tags? | Cfn [] | A set of tags to assign to the delivery stream. |
amazonOpenSearchServerlessDestinationConfiguration?
Type:
IResolvable
|
Amazon
(optional)
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
amazonopensearchserviceDestinationConfiguration?
Type:
IResolvable
|
Amazonopensearchservice
(optional)
The destination in Amazon OpenSearch Service.
You can specify only one destination.
deliveryStreamEncryptionConfigurationInput?
Type:
IResolvable
|
Delivery
(optional)
Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
deliveryStreamName?
Type:
string
(optional)
The name of the delivery stream.
deliveryStreamType?
Type:
string
(optional)
The delivery stream type. This can be one of the following values:.
DirectPut
: Provider applications access the delivery stream directly.KinesisStreamAsSource
: The delivery stream uses a Kinesis data stream as a source.
elasticsearchDestinationConfiguration?
Type:
IResolvable
|
Elasticsearch
(optional)
An Amazon ES destination for the delivery stream.
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?
Type:
IResolvable
|
Extended
(optional)
An Amazon S3 destination for the delivery stream.
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?
Type:
IResolvable
|
Http
(optional)
Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
You can specify only one destination.
icebergDestinationConfiguration?
Type:
IResolvable
|
Iceberg
(optional)
Specifies the destination configure settings for Apache Iceberg Table.
Amazon Data Firehose is in preview release and is subject to change.
kinesisStreamSourceConfiguration?
Type:
IResolvable
|
Kinesis
(optional)
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?
Type:
IResolvable
|
MSKSource
(optional)
The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
redshiftDestinationConfiguration?
Type:
IResolvable
|
Redshift
(optional)
An Amazon Redshift destination for the delivery stream.
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?
Type:
IResolvable
|
S3
(optional)
The S3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
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?
Type:
IResolvable
|
Snowflake
(optional)
Configure Snowflake destination.
splunkDestinationConfiguration?
Type:
IResolvable
|
Splunk
(optional)
The configuration of a destination in Splunk for the delivery stream.
tags?
Type:
Cfn
[]
(optional)
A set of tags to assign to the delivery stream.
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 delivery 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 delivery 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 delivery 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.