CfnDeliveryStreamProps

class aws_cdk.aws_kinesisfirehose.CfnDeliveryStreamProps(*, amazon_open_search_serverless_destination_configuration=None, amazonopensearchservice_destination_configuration=None, delivery_stream_encryption_configuration_input=None, delivery_stream_name=None, delivery_stream_type=None, elasticsearch_destination_configuration=None, extended_s3_destination_configuration=None, http_endpoint_destination_configuration=None, kinesis_stream_source_configuration=None, msk_source_configuration=None, redshift_destination_configuration=None, s3_destination_configuration=None, snowflake_destination_configuration=None, splunk_destination_configuration=None, tags=None)

Bases: object

Properties for defining a CfnDeliveryStream.

Parameters:
  • amazon_open_search_serverless_destination_configuration (Union[IResolvable, AmazonOpenSearchServerlessDestinationConfigurationProperty, Dict[str, Any], None]) – Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.

  • amazonopensearchservice_destination_configuration (Union[IResolvable, AmazonopensearchserviceDestinationConfigurationProperty, Dict[str, Any], None]) – The destination in Amazon OpenSearch Service. You can specify only one destination.

  • delivery_stream_encryption_configuration_input (Union[IResolvable, DeliveryStreamEncryptionConfigurationInputProperty, Dict[str, Any], None]) – Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).

  • delivery_stream_name (Optional[str]) – The name of the delivery stream.

  • delivery_stream_type (Optional[str]) – 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.

  • elasticsearch_destination_configuration (Union[IResolvable, ElasticsearchDestinationConfigurationProperty, Dict[str, Any], None]) – 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 .

  • extended_s3_destination_configuration (Union[IResolvable, ExtendedS3DestinationConfigurationProperty, Dict[str, Any], None]) –

    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 .

  • http_endpoint_destination_configuration (Union[IResolvable, HttpEndpointDestinationConfigurationProperty, Dict[str, Any], None]) – Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

  • kinesis_stream_source_configuration (Union[IResolvable, KinesisStreamSourceConfigurationProperty, Dict[str, Any], None]) – 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_source_configuration (Union[IResolvable, MSKSourceConfigurationProperty, Dict[str, Any], None]) – The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.

  • redshift_destination_configuration (Union[IResolvable, RedshiftDestinationConfigurationProperty, Dict[str, Any], None]) –

    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 .

  • s3_destination_configuration (Union[IResolvable, S3DestinationConfigurationProperty, Dict[str, Any], None]) –

    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 .

  • snowflake_destination_configuration (Union[IResolvable, SnowflakeDestinationConfigurationProperty, Dict[str, Any], None]) – Configure Snowflake destination.

  • splunk_destination_configuration (Union[IResolvable, SplunkDestinationConfigurationProperty, Dict[str, Any], None]) – The configuration of a destination in Splunk for the delivery stream.

  • tags (Optional[Sequence[Union[CfnTag, Dict[str, Any]]]]) – 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.

See:

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

ExampleMetadata:

infused

Example:

destination_bucket = s3.Bucket(self, "Bucket")
delivery_stream_role = iam.Role(self, "Role",
    assumed_by=iam.ServicePrincipal("firehose.amazonaws.com")
)

stream = firehose.CfnDeliveryStream(self, "MyStream",
    delivery_stream_name="amazon-apigateway-delivery-stream",
    s3_destination_configuration=firehose.CfnDeliveryStream.S3DestinationConfigurationProperty(
        bucket_arn=destination_bucket.bucket_arn,
        role_arn=delivery_stream_role.role_arn
    )
)

api = apigateway.RestApi(self, "books",
    deploy_options=apigateway.StageOptions(
        access_log_destination=apigateway.FirehoseLogDestination(stream),
        access_log_format=apigateway.AccessLogFormat.json_with_standard_fields()
    )
)

Attributes

amazon_open_search_serverless_destination_configuration

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

See:

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

amazonopensearchservice_destination_configuration

The destination in Amazon OpenSearch Service.

You can specify only one destination.

See:

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

delivery_stream_encryption_configuration_input

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

See:

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

delivery_stream_name

The name of the delivery stream.

See:

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

delivery_stream_type

.

  • DirectPut : Provider applications access the delivery stream directly.

  • KinesisStreamAsSource : The delivery stream uses a Kinesis data stream as a source.

See:

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

Type:

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

elasticsearch_destination_configuration

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 .

See:

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

extended_s3_destination_configuration

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 .

See:

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

http_endpoint_destination_configuration

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

You can specify only one destination.

See:

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

kinesis_stream_source_configuration

//docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-kinesisfirehose-deliverystream-kinesisstreamsourceconfiguration.html>`_ containing the Kinesis stream ARN and the role ARN for the source stream.

See:

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

Type:

When a Kinesis stream is used as the source for the delivery stream, a `KinesisStreamSourceConfiguration <https

msk_source_configuration

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

See:

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

redshift_destination_configuration

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 .

See:

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

s3_destination_configuration

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 .

See:

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

snowflake_destination_configuration

Configure Snowflake destination.

See:

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

splunk_destination_configuration

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

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

See:

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