Package software.amazon.awscdk.services.kinesisfirehose

Class CfnDeliveryStream.Builder

java.lang.Object
software.amazon.awscdk.services.kinesisfirehose.CfnDeliveryStream.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnDeliveryStream>
Enclosing class:
CfnDeliveryStream
@Stability(Stable) public static final class CfnDeliveryStream.Builder extends Object implements software.amazon.jsii.Builder<CfnDeliveryStream>
A fluent builder for CfnDeliveryStream.

  • Method Details

    • create

      @Stability(Stable) public static CfnDeliveryStream.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnDeliveryStream.Builder.

    • amazonOpenSearchServerlessDestinationConfiguration

      @Stability(Stable) public CfnDeliveryStream.Builder amazonOpenSearchServerlessDestinationConfiguration(CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfiguration)
      AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration.

      Parameters:
      amazonOpenSearchServerlessDestinationConfiguration - AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration. This parameter is required.
      Returns:
      this

    • amazonOpenSearchServerlessDestinationConfiguration

      @Stability(Stable) public CfnDeliveryStream.Builder amazonOpenSearchServerlessDestinationConfiguration(IResolvable amazonOpenSearchServerlessDestinationConfiguration)
      AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration.

      Parameters:
      amazonOpenSearchServerlessDestinationConfiguration - AWS::KinesisFirehose::DeliveryStream.AmazonOpenSearchServerlessDestinationConfiguration. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • 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

    • 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

    • deliveryStreamName

      @Stability(Stable) public CfnDeliveryStream.Builder deliveryStreamName(String deliveryStreamName)
      The name of the delivery stream.

      Parameters:
      deliveryStreamName - The name of the delivery stream. This parameter is required.
      Returns:
      this

    • deliveryStreamType

      @Stability(Stable) public CfnDeliveryStream.Builder deliveryStreamType(String deliveryStreamType)
      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.

      Parameters:
      deliveryStreamType - The delivery stream type. This can be one of the following values:. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • 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

    • s3DestinationConfiguration

      @Stability(Stable) public CfnDeliveryStream.Builder s3DestinationConfiguration(IResolvable 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 .

      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. This parameter is required.
      Returns:
      this

    • s3DestinationConfiguration

      @Stability(Stable) public CfnDeliveryStream.Builder s3DestinationConfiguration(CfnDeliveryStream.S3DestinationConfigurationProperty 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 .

      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. This parameter is required.
      Returns:
      this

    • 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

    • 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

    • tags

      @Stability(Stable) public CfnDeliveryStream.Builder tags(List<? extends CfnTag> 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.

      Parameters:
      tags - A set of tags to assign to the delivery stream. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnDeliveryStream build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnDeliveryStream>
      Returns:
      a newly built instance of CfnDeliveryStream.