Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDeliveryStream
@Stability(Stable) public static interface CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty extends software.amazon.jsii.JsiiSerializable
The ElasticsearchDestinationConfiguration property type specifies an Amazon Elasticsearch Service (Amazon ES) domain that Amazon Kinesis Data Firehose (Kinesis Data Firehose) delivers data to.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.kinesisfirehose.*;
 ElasticsearchDestinationConfigurationProperty elasticsearchDestinationConfigurationProperty = ElasticsearchDestinationConfigurationProperty.builder()
         .indexName("indexName")
         .roleArn("roleArn")
         .s3Configuration(S3DestinationConfigurationProperty.builder()
                 .bucketArn("bucketArn")
                 .roleArn("roleArn")
                 // the properties below are optional
                 .bufferingHints(BufferingHintsProperty.builder()
                         .intervalInSeconds(123)
                         .sizeInMBs(123)
                         .build())
                 .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                         .enabled(false)
                         .logGroupName("logGroupName")
                         .logStreamName("logStreamName")
                         .build())
                 .compressionFormat("compressionFormat")
                 .encryptionConfiguration(EncryptionConfigurationProperty.builder()
                         .kmsEncryptionConfig(KMSEncryptionConfigProperty.builder()
                                 .awskmsKeyArn("awskmsKeyArn")
                                 .build())
                         .noEncryptionConfig("noEncryptionConfig")
                         .build())
                 .errorOutputPrefix("errorOutputPrefix")
                 .prefix("prefix")
                 .build())
         // the properties below are optional
         .bufferingHints(ElasticsearchBufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .clusterEndpoint("clusterEndpoint")
         .documentIdOptions(DocumentIdOptionsProperty.builder()
                 .defaultDocumentIdFormat("defaultDocumentIdFormat")
                 .build())
         .domainArn("domainArn")
         .indexRotationPeriod("indexRotationPeriod")
         .processingConfiguration(ProcessingConfigurationProperty.builder()
                 .enabled(false)
                 .processors(List.of(ProcessorProperty.builder()
                         .type("type")
                         // the properties below are optional
                         .parameters(List.of(ProcessorParameterProperty.builder()
                                 .parameterName("parameterName")
                                 .parameterValue("parameterValue")
                                 .build()))
                         .build()))
                 .build())
         .retryOptions(ElasticsearchRetryOptionsProperty.builder()
                 .durationInSeconds(123)
                 .build())
         .s3BackupMode("s3BackupMode")
         .typeName("typeName")
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .roleArn("roleArn")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();

  • Method Details

    • getIndexName

      @Stability(Stable) @NotNull String getIndexName()
      The name of the Elasticsearch index to which Kinesis Data Firehose adds data for indexing.

    • getRoleArn

      @Stability(Stable) @NotNull String getRoleArn()
      The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents.

      For more information, see Controlling Access with Amazon Kinesis Data Firehose .

    • getS3Configuration

      @Stability(Stable) @NotNull Object getS3Configuration()
      The S3 bucket where Kinesis Data Firehose backs up incoming data.

    • getBufferingHints

      @Stability(Stable) @Nullable default Object getBufferingHints()
      Configures how Kinesis Data Firehose buffers incoming data while delivering it to the Amazon ES domain.

    • getCloudWatchLoggingOptions

      @Stability(Stable) @Nullable default Object getCloudWatchLoggingOptions()
      The Amazon CloudWatch Logs logging options for the delivery stream.

    • getClusterEndpoint

      @Stability(Stable) @Nullable default String getClusterEndpoint()
      The endpoint to use when communicating with the cluster.

      Specify either this ClusterEndpoint or the DomainARN field.

    • getDocumentIdOptions

      @Stability(Stable) @Nullable default Object getDocumentIdOptions()
      CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.DocumentIdOptions.

    • getDomainArn

      @Stability(Stable) @Nullable default String getDomainArn()
      The ARN of the Amazon ES domain.

      The IAM role must have permissions for DescribeElasticsearchDomain , DescribeElasticsearchDomains , and DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN .

      Specify either ClusterEndpoint or DomainARN .

    • getIndexRotationPeriod

      @Stability(Stable) @Nullable default String getIndexRotationPeriod()
      The frequency of Elasticsearch index rotation.

      If you enable index rotation, Kinesis Data Firehose appends a portion of the UTC arrival timestamp to the specified index name, and rotates the appended timestamp accordingly. For more information, see Index Rotation for the Amazon ES Destination in the Amazon Kinesis Data Firehose Developer Guide .

    • getProcessingConfiguration

      @Stability(Stable) @Nullable default Object getProcessingConfiguration()
      The data processing configuration for the Kinesis Data Firehose delivery stream.

    • getRetryOptions

      @Stability(Stable) @Nullable default Object getRetryOptions()
      The retry behavior when Kinesis Data Firehose is unable to deliver data to Amazon ES.

    • getS3BackupMode

      @Stability(Stable) @Nullable default String getS3BackupMode()
      The condition under which Kinesis Data Firehose delivers data to Amazon Simple Storage Service (Amazon S3).

      You can send Amazon S3 all documents (all data) or only the documents that Kinesis Data Firehose could not deliver to the Amazon ES destination. For more information and valid values, see the S3BackupMode content for the ElasticsearchDestinationConfiguration data type in the Amazon Kinesis Data Firehose API Reference .

    • getTypeName

      @Stability(Stable) @Nullable default String getTypeName()
      The Elasticsearch type name that Amazon ES adds to documents when indexing data.

    • getVpcConfiguration

      @Stability(Stable) @Nullable default Object getVpcConfiguration()
      The details of the VPC of the Amazon ES destination.

    • builder

      @Stability(Stable) static CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder builder()
      Returns:
      a CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty.Builder of CfnDeliveryStream.ElasticsearchDestinationConfigurationProperty