Class CfnDeliveryStream.Builder
- All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStream>
- Enclosing class:
CfnDeliveryStream
CfnDeliveryStream
.-
Method Summary
Modifier and TypeMethodDescriptionamazonOpenSearchServerlessDestinationConfiguration
(IResolvable amazonOpenSearchServerlessDestinationConfiguration) Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.amazonOpenSearchServerlessDestinationConfiguration
(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfiguration) Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.amazonopensearchserviceDestinationConfiguration
(IResolvable amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.amazonopensearchserviceDestinationConfiguration
(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.build()
static CfnDeliveryStream.Builder
deliveryStreamEncryptionConfigurationInput
(IResolvable deliveryStreamEncryptionConfigurationInput) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).deliveryStreamEncryptionConfigurationInput
(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty deliveryStreamEncryptionConfigurationInput) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).deliveryStreamName
(String deliveryStreamName) The name of the Firehose stream.deliveryStreamType
(String deliveryStreamType) The Firehose stream type.elasticsearchDestinationConfiguration
(IResolvable elasticsearchDestinationConfiguration) An Amazon ES destination for the delivery stream.elasticsearchDestinationConfiguration
(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfiguration) An Amazon ES destination for the delivery stream.extendedS3DestinationConfiguration
(IResolvable extendedS3DestinationConfiguration) An Amazon S3 destination for the delivery stream.extendedS3DestinationConfiguration
(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty extendedS3DestinationConfiguration) An Amazon S3 destination for the delivery stream.httpEndpointDestinationConfiguration
(IResolvable httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.httpEndpointDestinationConfiguration
(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.icebergDestinationConfiguration
(IResolvable icebergDestinationConfiguration) Specifies the destination configure settings for Apache Iceberg Table.icebergDestinationConfiguration
(CfnDeliveryStream.IcebergDestinationConfigurationProperty icebergDestinationConfiguration) Specifies the destination configure settings for Apache Iceberg Table.kinesisStreamSourceConfiguration
(IResolvable 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.kinesisStreamSourceConfiguration
(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty 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
(IResolvable mskSourceConfiguration) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.mskSourceConfiguration
(CfnDeliveryStream.MSKSourceConfigurationProperty mskSourceConfiguration) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.redshiftDestinationConfiguration
(IResolvable redshiftDestinationConfiguration) An Amazon Redshift destination for the delivery stream.redshiftDestinationConfiguration
(CfnDeliveryStream.RedshiftDestinationConfigurationProperty redshiftDestinationConfiguration) An Amazon Redshift destination for the delivery stream.s3DestinationConfiguration
(IResolvable s3DestinationConfiguration) TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.s3DestinationConfiguration
(CfnDeliveryStream.S3DestinationConfigurationProperty s3DestinationConfiguration) TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data.snowflakeDestinationConfiguration
(IResolvable snowflakeDestinationConfiguration) Configure Snowflake destination.snowflakeDestinationConfiguration
(CfnDeliveryStream.SnowflakeDestinationConfigurationProperty snowflakeDestinationConfiguration) Configure Snowflake destination.splunkDestinationConfiguration
(IResolvable splunkDestinationConfiguration) The configuration of a destination in Splunk for the delivery stream.splunkDestinationConfiguration
(CfnDeliveryStream.SplunkDestinationConfigurationProperty splunkDestinationConfiguration) The configuration of a destination in Splunk for the delivery stream.A set of tags to assign to the Firehose stream.
-
Method Details
-
create
@Stability(Stable) public static CfnDeliveryStream.Builder create(software.constructs.Construct scope, String id) - Parameters:
scope
- Scope in which this resource is defined. This parameter is required.id
- Construct identifier for this resource (unique in its scope). This parameter is required.- Returns:
- a new instance of
CfnDeliveryStream.Builder
.
-
amazonOpenSearchServerlessDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder amazonOpenSearchServerlessDestinationConfiguration(IResolvable amazonOpenSearchServerlessDestinationConfiguration) Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.- Parameters:
amazonOpenSearchServerlessDestinationConfiguration
- Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service. This parameter is required.- Returns:
this
- See Also:
-
amazonOpenSearchServerlessDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder amazonOpenSearchServerlessDestinationConfiguration(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfiguration) Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.- Parameters:
amazonOpenSearchServerlessDestinationConfiguration
- Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service. This parameter is required.- Returns:
this
- See Also:
-
amazonopensearchserviceDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder amazonopensearchserviceDestinationConfiguration(IResolvable amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.You can specify only one destination.
- Parameters:
amazonopensearchserviceDestinationConfiguration
- The destination in Amazon OpenSearch Service. This parameter is required.- Returns:
this
- See Also:
-
amazonopensearchserviceDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder amazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty amazonopensearchserviceDestinationConfiguration) The destination in Amazon OpenSearch Service.You can specify only one destination.
- Parameters:
amazonopensearchserviceDestinationConfiguration
- The destination in Amazon OpenSearch Service. This parameter is required.- Returns:
this
- See Also:
-
deliveryStreamEncryptionConfigurationInput
@Stability(Stable) public CfnDeliveryStream.Builder deliveryStreamEncryptionConfigurationInput(IResolvable deliveryStreamEncryptionConfigurationInput) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).- Parameters:
deliveryStreamEncryptionConfigurationInput
- Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). This parameter is required.- Returns:
this
- See Also:
-
deliveryStreamEncryptionConfigurationInput
@Stability(Stable) public CfnDeliveryStream.Builder deliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty deliveryStreamEncryptionConfigurationInput) Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE).- Parameters:
deliveryStreamEncryptionConfigurationInput
- Specifies the type and Amazon Resource Name (ARN) of the CMK to use for Server-Side Encryption (SSE). This parameter is required.- Returns:
this
- See Also:
-
deliveryStreamName
The name of the Firehose stream.- Parameters:
deliveryStreamName
- The name of the Firehose stream. This parameter is required.- Returns:
this
- See Also:
-
deliveryStreamType
The Firehose stream type. This can be one of the following values:.DirectPut
: Provider applications access the Firehose stream directly.KinesisStreamAsSource
: The Firehose stream uses a Kinesis data stream as a source.
- Parameters:
deliveryStreamType
- The Firehose stream type. This can be one of the following values:. This parameter is required.- Returns:
this
- See Also:
-
elasticsearchDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder elasticsearchDestinationConfiguration(IResolvable elasticsearchDestinationConfiguration) 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 .
- Parameters:
elasticsearchDestinationConfiguration
- An Amazon ES destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
elasticsearchDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder elasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfiguration) 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 .
- Parameters:
elasticsearchDestinationConfiguration
- An Amazon ES destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
extendedS3DestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder extendedS3DestinationConfiguration(IResolvable extendedS3DestinationConfiguration) 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 .
- Parameters:
extendedS3DestinationConfiguration
- An Amazon S3 destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
extendedS3DestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder extendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty extendedS3DestinationConfiguration) 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 .
- Parameters:
extendedS3DestinationConfiguration
- An Amazon S3 destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
httpEndpointDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder httpEndpointDestinationConfiguration(IResolvable httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.You can specify only one destination.
- Parameters:
httpEndpointDestinationConfiguration
- Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. This parameter is required.- Returns:
this
- See Also:
-
httpEndpointDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder httpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfiguration) Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination.You can specify only one destination.
- Parameters:
httpEndpointDestinationConfiguration
- Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. This parameter is required.- Returns:
this
- See Also:
-
icebergDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder icebergDestinationConfiguration(IResolvable icebergDestinationConfiguration) Specifies the destination configure settings for Apache Iceberg Table.- Parameters:
icebergDestinationConfiguration
- Specifies the destination configure settings for Apache Iceberg Table. This parameter is required.- Returns:
this
- See Also:
-
icebergDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder icebergDestinationConfiguration(CfnDeliveryStream.IcebergDestinationConfigurationProperty icebergDestinationConfiguration) Specifies the destination configure settings for Apache Iceberg Table.- Parameters:
icebergDestinationConfiguration
- Specifies the destination configure settings for Apache Iceberg Table. This parameter is required.- Returns:
this
- See Also:
-
kinesisStreamSourceConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder kinesisStreamSourceConfiguration(IResolvable 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.- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
kinesisStreamSourceConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder kinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty 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.- Parameters:
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. This parameter is required.- Returns:
this
- See Also:
-
mskSourceConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder mskSourceConfiguration(IResolvable mskSourceConfiguration) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.- Parameters:
mskSourceConfiguration
- The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. This parameter is required.- Returns:
this
- See Also:
-
mskSourceConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder mskSourceConfiguration(CfnDeliveryStream.MSKSourceConfigurationProperty mskSourceConfiguration) The configuration for the Amazon MSK cluster to be used as the source for a delivery stream.- Parameters:
mskSourceConfiguration
- The configuration for the Amazon MSK cluster to be used as the source for a delivery stream. This parameter is required.- Returns:
this
- See Also:
-
redshiftDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder redshiftDestinationConfiguration(IResolvable redshiftDestinationConfiguration) 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 .
- Parameters:
redshiftDestinationConfiguration
- An Amazon Redshift destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
redshiftDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder redshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty redshiftDestinationConfiguration) 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 .
- Parameters:
redshiftDestinationConfiguration
- An Amazon Redshift destination for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
s3DestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder s3DestinationConfiguration(IResolvable s3DestinationConfiguration) TheS3DestinationConfiguration
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 .
- Parameters:
s3DestinationConfiguration
- TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. This parameter is required.- Returns:
this
- See Also:
-
s3DestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder s3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty s3DestinationConfiguration) TheS3DestinationConfiguration
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 .
- Parameters:
s3DestinationConfiguration
- TheS3DestinationConfiguration
property type specifies an Amazon Simple Storage Service (Amazon S3) destination to which Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data. This parameter is required.- Returns:
this
- See Also:
-
snowflakeDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder snowflakeDestinationConfiguration(IResolvable snowflakeDestinationConfiguration) Configure Snowflake destination.- Parameters:
snowflakeDestinationConfiguration
- Configure Snowflake destination. This parameter is required.- Returns:
this
- See Also:
-
snowflakeDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder snowflakeDestinationConfiguration(CfnDeliveryStream.SnowflakeDestinationConfigurationProperty snowflakeDestinationConfiguration) Configure Snowflake destination.- Parameters:
snowflakeDestinationConfiguration
- Configure Snowflake destination. This parameter is required.- Returns:
this
- See Also:
-
splunkDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder splunkDestinationConfiguration(IResolvable splunkDestinationConfiguration) The configuration of a destination in Splunk for the delivery stream.- Parameters:
splunkDestinationConfiguration
- The configuration of a destination in Splunk for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
splunkDestinationConfiguration
@Stability(Stable) public CfnDeliveryStream.Builder splunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty splunkDestinationConfiguration) The configuration of a destination in Splunk for the delivery stream.- Parameters:
splunkDestinationConfiguration
- The configuration of a destination in Splunk for the delivery stream. This parameter is required.- Returns:
this
- See Also:
-
tags
A set of tags to assign to the Firehose 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 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 thefirehose:TagDeliveryStream
action to verify if users have permissions to create tags. If you do not provide this permission, requests to create new Firehose Firehose streams with IAM resource tags will fail with anAccessDeniedException
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.
- Parameters:
tags
- A set of tags to assign to the Firehose stream. This parameter is required.- Returns:
this
- See Also:
-
build
- Specified by:
build
in interfacesoftware.amazon.jsii.Builder<CfnDeliveryStream>
- Returns:
- a newly built instance of
CfnDeliveryStream
.
-