Package software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

All Superinterfaces:
software.amazon.jsii.JsiiSerializable
All Known Implementing Classes:
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Jsii$Proxy
Enclosing class:
CfnDeliveryStream
@Stability(Stable) public static interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty extends software.amazon.jsii.JsiiSerializable
Describes the configuration of a destination in Amazon OpenSearch Service.

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.*;
 AmazonopensearchserviceDestinationConfigurationProperty amazonopensearchserviceDestinationConfigurationProperty = AmazonopensearchserviceDestinationConfigurationProperty.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(AmazonopensearchserviceBufferingHintsProperty.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(AmazonopensearchserviceRetryOptionsProperty.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 Amazon OpenSearch Service index name.

    • 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 OpenSearch Service Configuration API and for indexing documents.

    • getS3Configuration

      @Stability(Stable) @NotNull Object getS3Configuration()
      Describes the configuration of a destination in Amazon S3.

    • getBufferingHints

      @Stability(Stable) @Nullable default Object getBufferingHints()
      The buffering options.

      If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.

    • getCloudWatchLoggingOptions

      @Stability(Stable) @Nullable default Object getCloudWatchLoggingOptions()
      Describes the Amazon CloudWatch logging options for your 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.AmazonopensearchserviceDestinationConfigurationProperty.DocumentIdOptions.

    • getDomainArn

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

    • getIndexRotationPeriod

      @Stability(Stable) @Nullable default String getIndexRotationPeriod()
      The Amazon OpenSearch Service index rotation period.

      Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.

    • getProcessingConfiguration

      @Stability(Stable) @Nullable default Object getProcessingConfiguration()
      Describes a data processing configuration.

    • getRetryOptions

      @Stability(Stable) @Nullable default Object getRetryOptions()
      The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.

      The default value is 300 (5 minutes).

    • getS3BackupMode

      @Stability(Stable) @Nullable default String getS3BackupMode()
      Defines how documents should be delivered to Amazon S3.

    • getTypeName

      @Stability(Stable) @Nullable default String getTypeName()
      The Amazon OpenSearch Service type name.

    • getVpcConfiguration

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

    • builder

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