Package 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(Stable)
public static interface CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty
extends software.amazon.jsii.JsiiSerializable

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	Description
static final class	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	A builder for CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty
static final class	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Jsii$Proxy	An implementation for CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty

Method Summary

Modifier and Type	Method	Description
static CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder	builder()
default Object	getBufferingHints()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints.
default Object	getCloudWatchLoggingOptions()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions.
default String	getCollectionEndpoint()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint.
String	getIndexName()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName.
default Object	getProcessingConfiguration()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration.
default Object	getRetryOptions()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions.
String	getRoleArn()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN.
default String	getS3BackupMode()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode.
Object	getS3Configuration()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration.
default Object	getVpcConfiguration()	CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getIndexName

@Stability(Stable)
@NotNull
String getIndexName()

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.IndexName.

getRoleArn

@Stability(Stable)
@NotNull
String getRoleArn()

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RoleARN.

getS3Configuration

@Stability(Stable)
@NotNull
Object getS3Configuration()

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3Configuration.

getBufferingHints

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.BufferingHints.

getCloudWatchLoggingOptions

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CloudWatchLoggingOptions.

getCollectionEndpoint

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.CollectionEndpoint.

getProcessingConfiguration

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.ProcessingConfiguration.

getRetryOptions

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.RetryOptions.

getS3BackupMode

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.S3BackupMode.

getVpcConfiguration

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

CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.VpcConfiguration.

builder

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

Returns:

a CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder of CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty