Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStreamProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStreamProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.89.0 (build 2f74b3e)",
           date="2023-10-26T00:56:09.626Z")
@Stability(Stable)
public interface CfnDeliveryStreamProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnDeliveryStream.

Example:

See Also:

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

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnDeliveryStreamProps.Builder	A builder for CfnDeliveryStreamProps
static final class	CfnDeliveryStreamProps.Jsii$Proxy	An implementation for CfnDeliveryStreamProps

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStreamProps.Builder	builder()
default Object	getAmazonOpenSearchServerlessDestinationConfiguration()	Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
default Object	getAmazonopensearchserviceDestinationConfiguration()	The destination in Amazon OpenSearch Service.
default Object	getDeliveryStreamEncryptionConfigurationInput()	Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).
default String	getDeliveryStreamName()	The name of the delivery stream.
default String	getDeliveryStreamType()	The delivery stream type.
default Object	getElasticsearchDestinationConfiguration()	An Amazon ES destination for the delivery stream.
default Object	getExtendedS3DestinationConfiguration()	An Amazon S3 destination for the delivery stream.
default Object	getHttpEndpointDestinationConfiguration()	Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.
default Object	getKinesisStreamSourceConfiguration()	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.
default Object	getMskSourceConfiguration()	The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.
default Object	getRedshiftDestinationConfiguration()	An Amazon Redshift destination for the delivery stream.
default Object	getS3DestinationConfiguration()	The S3DestinationConfiguration property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.
default Object	getSplunkDestinationConfiguration()	The configuration of a destination in Splunk for the delivery stream.
default List<CfnTag>	getTags()	A set of tags to assign to the delivery stream.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getAmazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getAmazonOpenSearchServerlessDestinationConfiguration()

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

See Also:

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

getAmazonopensearchserviceDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getAmazonopensearchserviceDestinationConfiguration()

The destination in Amazon OpenSearch Service.

You can specify only one destination.

See Also:

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

getDeliveryStreamEncryptionConfigurationInput

@Stability(Stable)
@Nullable
default Object getDeliveryStreamEncryptionConfigurationInput()

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

See Also:

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

getDeliveryStreamName

@Stability(Stable)
@Nullable
default String getDeliveryStreamName()

The name of the delivery stream.

See Also:

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

getDeliveryStreamType

@Stability(Stable)
@Nullable
default String getDeliveryStreamType()

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.

See Also:

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

getElasticsearchDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getElasticsearchDestinationConfiguration()

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 Also:

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

getExtendedS3DestinationConfiguration

@Stability(Stable)
@Nullable
default Object getExtendedS3DestinationConfiguration()

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 Also:

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

getHttpEndpointDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getHttpEndpointDestinationConfiguration()

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

You can specify only one destination.

See Also:

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

getKinesisStreamSourceConfiguration

@Stability(Stable)
@Nullable
default Object getKinesisStreamSourceConfiguration()

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.

See Also:

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

getMskSourceConfiguration

@Stability(Stable)
@Nullable
default Object getMskSourceConfiguration()

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

See Also:

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

getRedshiftDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getRedshiftDestinationConfiguration()

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 Also:

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

getS3DestinationConfiguration

@Stability(Stable)
@Nullable
default Object getS3DestinationConfiguration()

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 Also:

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

getSplunkDestinationConfiguration

@Stability(Stable)
@Nullable
default Object getSplunkDestinationConfiguration()

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

See Also:

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

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

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.

See Also:

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

builder

@Stability(Stable)
static CfnDeliveryStreamProps.Builder builder()

Returns:

a CfnDeliveryStreamProps.Builder of CfnDeliveryStreamProps