Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStreamProps.Builder

java.lang.Object

software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStreamProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnDeliveryStreamProps>

Enclosing interface:

CfnDeliveryStreamProps

@Stability(Stable)
public static final class CfnDeliveryStreamProps.Builder
extends Object
implements software.amazon.jsii.Builder<CfnDeliveryStreamProps>

A builder for CfnDeliveryStreamProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
CfnDeliveryStreamProps.Builder	amazonOpenSearchServerlessDestinationConfiguration(IResolvable amazonOpenSearchServerlessDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getAmazonOpenSearchServerlessDestinationConfiguration()
CfnDeliveryStreamProps.Builder	amazonOpenSearchServerlessDestinationConfiguration(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getAmazonOpenSearchServerlessDestinationConfiguration()
CfnDeliveryStreamProps.Builder	amazonopensearchserviceDestinationConfiguration(IResolvable amazonopensearchserviceDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getAmazonopensearchserviceDestinationConfiguration()
CfnDeliveryStreamProps.Builder	amazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty amazonopensearchserviceDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getAmazonopensearchserviceDestinationConfiguration()
CfnDeliveryStreamProps	build()	Builds the configured instance.
CfnDeliveryStreamProps.Builder	deliveryStreamEncryptionConfigurationInput(IResolvable deliveryStreamEncryptionConfigurationInput)	Sets the value of CfnDeliveryStreamProps.getDeliveryStreamEncryptionConfigurationInput()
CfnDeliveryStreamProps.Builder	deliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty deliveryStreamEncryptionConfigurationInput)	Sets the value of CfnDeliveryStreamProps.getDeliveryStreamEncryptionConfigurationInput()
CfnDeliveryStreamProps.Builder	deliveryStreamName(String deliveryStreamName)	Sets the value of CfnDeliveryStreamProps.getDeliveryStreamName()
CfnDeliveryStreamProps.Builder	deliveryStreamType(String deliveryStreamType)	Sets the value of CfnDeliveryStreamProps.getDeliveryStreamType()
CfnDeliveryStreamProps.Builder	elasticsearchDestinationConfiguration(IResolvable elasticsearchDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getElasticsearchDestinationConfiguration()
CfnDeliveryStreamProps.Builder	elasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getElasticsearchDestinationConfiguration()
CfnDeliveryStreamProps.Builder	extendedS3DestinationConfiguration(IResolvable extendedS3DestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getExtendedS3DestinationConfiguration()
CfnDeliveryStreamProps.Builder	extendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty extendedS3DestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getExtendedS3DestinationConfiguration()
CfnDeliveryStreamProps.Builder	httpEndpointDestinationConfiguration(IResolvable httpEndpointDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getHttpEndpointDestinationConfiguration()
CfnDeliveryStreamProps.Builder	httpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getHttpEndpointDestinationConfiguration()
CfnDeliveryStreamProps.Builder	icebergDestinationConfiguration(IResolvable icebergDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getIcebergDestinationConfiguration()
CfnDeliveryStreamProps.Builder	icebergDestinationConfiguration(CfnDeliveryStream.IcebergDestinationConfigurationProperty icebergDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getIcebergDestinationConfiguration()
CfnDeliveryStreamProps.Builder	kinesisStreamSourceConfiguration(IResolvable kinesisStreamSourceConfiguration)	Sets the value of CfnDeliveryStreamProps.getKinesisStreamSourceConfiguration()
CfnDeliveryStreamProps.Builder	kinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty kinesisStreamSourceConfiguration)	Sets the value of CfnDeliveryStreamProps.getKinesisStreamSourceConfiguration()
CfnDeliveryStreamProps.Builder	mskSourceConfiguration(IResolvable mskSourceConfiguration)	Sets the value of CfnDeliveryStreamProps.getMskSourceConfiguration()
CfnDeliveryStreamProps.Builder	mskSourceConfiguration(CfnDeliveryStream.MSKSourceConfigurationProperty mskSourceConfiguration)	Sets the value of CfnDeliveryStreamProps.getMskSourceConfiguration()
CfnDeliveryStreamProps.Builder	redshiftDestinationConfiguration(IResolvable redshiftDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getRedshiftDestinationConfiguration()
CfnDeliveryStreamProps.Builder	redshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty redshiftDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getRedshiftDestinationConfiguration()
CfnDeliveryStreamProps.Builder	s3DestinationConfiguration(IResolvable s3DestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getS3DestinationConfiguration()
CfnDeliveryStreamProps.Builder	s3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty s3DestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getS3DestinationConfiguration()
CfnDeliveryStreamProps.Builder	snowflakeDestinationConfiguration(IResolvable snowflakeDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getSnowflakeDestinationConfiguration()
CfnDeliveryStreamProps.Builder	snowflakeDestinationConfiguration(CfnDeliveryStream.SnowflakeDestinationConfigurationProperty snowflakeDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getSnowflakeDestinationConfiguration()
CfnDeliveryStreamProps.Builder	splunkDestinationConfiguration(IResolvable splunkDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getSplunkDestinationConfiguration()
CfnDeliveryStreamProps.Builder	splunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty splunkDestinationConfiguration)	Sets the value of CfnDeliveryStreamProps.getSplunkDestinationConfiguration()
CfnDeliveryStreamProps.Builder	tags(List<? extends CfnTag> tags)	Sets the value of CfnDeliveryStreamProps.getTags()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

Builder

public Builder()

Method Details

amazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder amazonOpenSearchServerlessDestinationConfiguration(IResolvable amazonOpenSearchServerlessDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getAmazonOpenSearchServerlessDestinationConfiguration()

Parameters:

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

Returns:

this

amazonOpenSearchServerlessDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder amazonOpenSearchServerlessDestinationConfiguration(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getAmazonOpenSearchServerlessDestinationConfiguration()

Parameters:

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

Returns:

this

amazonopensearchserviceDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder amazonopensearchserviceDestinationConfiguration(IResolvable amazonopensearchserviceDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getAmazonopensearchserviceDestinationConfiguration()

Parameters:

amazonopensearchserviceDestinationConfiguration - The destination in Amazon OpenSearch Service. You can specify only one destination.

Returns:

this

amazonopensearchserviceDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder amazonopensearchserviceDestinationConfiguration(CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty amazonopensearchserviceDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getAmazonopensearchserviceDestinationConfiguration()

Parameters:

amazonopensearchserviceDestinationConfiguration - The destination in Amazon OpenSearch Service. You can specify only one destination.

Returns:

this

deliveryStreamEncryptionConfigurationInput

@Stability(Stable)
public CfnDeliveryStreamProps.Builder deliveryStreamEncryptionConfigurationInput(IResolvable deliveryStreamEncryptionConfigurationInput)

Sets the value of CfnDeliveryStreamProps.getDeliveryStreamEncryptionConfigurationInput()

Parameters:

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

Returns:

this

deliveryStreamEncryptionConfigurationInput

@Stability(Stable)
public CfnDeliveryStreamProps.Builder deliveryStreamEncryptionConfigurationInput(CfnDeliveryStream.DeliveryStreamEncryptionConfigurationInputProperty deliveryStreamEncryptionConfigurationInput)

Sets the value of CfnDeliveryStreamProps.getDeliveryStreamEncryptionConfigurationInput()

Parameters:

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

Returns:

this

deliveryStreamName

@Stability(Stable)
public CfnDeliveryStreamProps.Builder deliveryStreamName(String deliveryStreamName)

Sets the value of CfnDeliveryStreamProps.getDeliveryStreamName()

Parameters:

deliveryStreamName - The name of the Firehose stream.

Returns:

this

deliveryStreamType

@Stability(Stable)
public CfnDeliveryStreamProps.Builder deliveryStreamType(String deliveryStreamType)

Sets the value of CfnDeliveryStreamProps.getDeliveryStreamType()

Parameters:

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.

Returns:

this

elasticsearchDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder elasticsearchDestinationConfiguration(IResolvable elasticsearchDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getElasticsearchDestinationConfiguration()

Parameters:

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 .

Returns:

this

elasticsearchDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder elasticsearchDestinationConfiguration(CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getElasticsearchDestinationConfiguration()

Parameters:

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 .

Returns:

this

extendedS3DestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder extendedS3DestinationConfiguration(IResolvable extendedS3DestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getExtendedS3DestinationConfiguration()

Parameters:

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 .

Returns:

this

extendedS3DestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder extendedS3DestinationConfiguration(CfnDeliveryStream.ExtendedS3DestinationConfigurationProperty extendedS3DestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getExtendedS3DestinationConfiguration()

Parameters:

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 .

Returns:

this

httpEndpointDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder httpEndpointDestinationConfiguration(IResolvable httpEndpointDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getHttpEndpointDestinationConfiguration()

Parameters:

httpEndpointDestinationConfiguration - Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Returns:

this

httpEndpointDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder httpEndpointDestinationConfiguration(CfnDeliveryStream.HttpEndpointDestinationConfigurationProperty httpEndpointDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getHttpEndpointDestinationConfiguration()

Parameters:

httpEndpointDestinationConfiguration - Enables configuring Kinesis Firehose to deliver data to any HTTP endpoint destination. You can specify only one destination.

Returns:

this

icebergDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder icebergDestinationConfiguration(IResolvable icebergDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getIcebergDestinationConfiguration()

Parameters:

icebergDestinationConfiguration - Specifies the destination configure settings for Apache Iceberg Table.

Returns:

this

icebergDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder icebergDestinationConfiguration(CfnDeliveryStream.IcebergDestinationConfigurationProperty icebergDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getIcebergDestinationConfiguration()

Parameters:

icebergDestinationConfiguration - Specifies the destination configure settings for Apache Iceberg Table.

Returns:

this

kinesisStreamSourceConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder kinesisStreamSourceConfiguration(IResolvable kinesisStreamSourceConfiguration)

Sets the value of CfnDeliveryStreamProps.getKinesisStreamSourceConfiguration()

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.

Returns:

this

kinesisStreamSourceConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder kinesisStreamSourceConfiguration(CfnDeliveryStream.KinesisStreamSourceConfigurationProperty kinesisStreamSourceConfiguration)

Sets the value of CfnDeliveryStreamProps.getKinesisStreamSourceConfiguration()

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.

Returns:

this

mskSourceConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder mskSourceConfiguration(IResolvable mskSourceConfiguration)

Sets the value of CfnDeliveryStreamProps.getMskSourceConfiguration()

Parameters:

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

Returns:

this

mskSourceConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder mskSourceConfiguration(CfnDeliveryStream.MSKSourceConfigurationProperty mskSourceConfiguration)

Sets the value of CfnDeliveryStreamProps.getMskSourceConfiguration()

Parameters:

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

Returns:

this

redshiftDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder redshiftDestinationConfiguration(IResolvable redshiftDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getRedshiftDestinationConfiguration()

Parameters:

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 .

Returns:

this

redshiftDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder redshiftDestinationConfiguration(CfnDeliveryStream.RedshiftDestinationConfigurationProperty redshiftDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getRedshiftDestinationConfiguration()

Parameters:

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 .

Returns:

this

s3DestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder s3DestinationConfiguration(IResolvable s3DestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getS3DestinationConfiguration()

Parameters:

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

Returns:

this

s3DestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder s3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty s3DestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getS3DestinationConfiguration()

Parameters:

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

Returns:

this

snowflakeDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder snowflakeDestinationConfiguration(IResolvable snowflakeDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getSnowflakeDestinationConfiguration()

Parameters:

snowflakeDestinationConfiguration - Configure Snowflake destination.

Returns:

this

snowflakeDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder snowflakeDestinationConfiguration(CfnDeliveryStream.SnowflakeDestinationConfigurationProperty snowflakeDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getSnowflakeDestinationConfiguration()

Parameters:

snowflakeDestinationConfiguration - Configure Snowflake destination.

Returns:

this

splunkDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder splunkDestinationConfiguration(IResolvable splunkDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getSplunkDestinationConfiguration()

Parameters:

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

Returns:

this

splunkDestinationConfiguration

@Stability(Stable)
public CfnDeliveryStreamProps.Builder splunkDestinationConfiguration(CfnDeliveryStream.SplunkDestinationConfigurationProperty splunkDestinationConfiguration)

Sets the value of CfnDeliveryStreamProps.getSplunkDestinationConfiguration()

Parameters:

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

Returns:

this

tags

@Stability(Stable)
public CfnDeliveryStreamProps.Builder tags(List<? extends CfnTag> tags)

Sets the value of CfnDeliveryStreamProps.getTags()

Parameters:

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

Returns:

this

build

@Stability(Stable)
public CfnDeliveryStreamProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<CfnDeliveryStreamProps>

Returns:

a new instance of CfnDeliveryStreamProps

Throws:

NullPointerException - if any required attribute was not provided