software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

@Stability(value=Stable)
public static interface CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

Describes the configuration of a destination in the Serverless offering for 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.*;
 AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfigurationProperty = AmazonOpenSearchServerlessDestinationConfigurationProperty.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(AmazonOpenSearchServerlessBufferingHintsProperty.builder()
                 .intervalInSeconds(123)
                 .sizeInMBs(123)
                 .build())
         .cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
                 .enabled(false)
                 .logGroupName("logGroupName")
                 .logStreamName("logStreamName")
                 .build())
         .collectionEndpoint("collectionEndpoint")
         .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(AmazonOpenSearchServerlessRetryOptionsProperty.builder()
                 .durationInSeconds(123)
                 .build())
         .s3BackupMode("s3BackupMode")
         .vpcConfiguration(VpcConfigurationProperty.builder()
                 .roleArn("roleArn")
                 .securityGroupIds(List.of("securityGroupIds"))
                 .subnetIds(List.of("subnetIds"))
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder A builder for CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty
static class	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Jsii$Proxy An implementation for CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

Method Summary

Modifier and Type	Method and Description
static CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	builder()
default Object	getBufferingHints() The buffering options.
default Object	getCloudWatchLoggingOptions() `CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions`.
default String	getCollectionEndpoint() The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
String	getIndexName() The Serverless offering for Amazon OpenSearch Service index name.
default Object	getProcessingConfiguration() `CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration`.
default Object	getRetryOptions() The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.
String	getRoleArn() The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.
default String	getS3BackupMode() Defines how documents should be delivered to Amazon S3.
Object	getS3Configuration() `CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration`.
default Object	getVpcConfiguration() `CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIndexName

@Stability(value=Stable)
 @NotNull
String getIndexName()

The Serverless offering for Amazon OpenSearch Service index name.

getRoleArn

@Stability(value=Stable)
 @NotNull
String getRoleArn()

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.

getS3Configuration

@Stability(value=Stable)
 @NotNull
Object getS3Configuration()

`CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration`.

getBufferingHints

@Stability(value=Stable)
 @Nullable
default Object getBufferingHints()

The buffering options.

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

getCloudWatchLoggingOptions

@Stability(value=Stable)
 @Nullable
default Object getCloudWatchLoggingOptions()

`CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions`.

getCollectionEndpoint

@Stability(value=Stable)
 @Nullable
default String getCollectionEndpoint()

The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.

getProcessingConfiguration

@Stability(value=Stable)
 @Nullable
default Object getProcessingConfiguration()

`CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration`.

getRetryOptions

@Stability(value=Stable)
 @Nullable
default Object getRetryOptions()

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.

The default value is 300 (5 minutes).

getS3BackupMode

@Stability(value=Stable)
 @Nullable
default String getS3BackupMode()

Defines how documents should be delivered to Amazon S3.

When it is set to FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination, with AmazonOpenSearchService-failed/ appended to the key prefix. When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.

getVpcConfiguration

@Stability(value=Stable)
 @Nullable
default Object getVpcConfiguration()

`CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration`.

builder

@Stability(value=Stable)
static CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty