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(value=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")
         .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();
 

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
static CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder	builder()
default Object	getBufferingHints() The buffering options.
default Object	getCloudWatchLoggingOptions() Describes the Amazon CloudWatch logging options for your delivery stream.
default String	getClusterEndpoint() The endpoint to use when communicating with the cluster.
default String	getDomainArn() The ARN of the Amazon OpenSearch Service domain.
String	getIndexName() The Amazon OpenSearch Service index name.
default String	getIndexRotationPeriod() The Amazon OpenSearch Service index rotation period.
default Object	getProcessingConfiguration() Describes a data processing configuration.
default Object	getRetryOptions() The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.
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.
default String	getS3BackupMode() Defines how documents should be delivered to Amazon S3.
Object	getS3Configuration() Describes the configuration of a destination in Amazon S3.
default String	getTypeName() The Amazon OpenSearch Service type name.
default Object	getVpcConfiguration() The details of the VPC of the Amazon OpenSearch Service destination.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getIndexName

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

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

getS3Configuration

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

Describes the configuration of a destination in Amazon S3.

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()

Describes the Amazon CloudWatch logging options for your delivery stream.

getClusterEndpoint

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

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

getDomainArn

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

The ARN of the Amazon OpenSearch Service domain.

getIndexRotationPeriod

@Stability(value=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(value=Stable)
 @Nullable
default Object getProcessingConfiguration()

Describes a data processing configuration.

getRetryOptions

@Stability(value=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(value=Stable)
 @Nullable
default String getS3BackupMode()

Defines how documents should be delivered to Amazon S3.

getTypeName

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

The Amazon OpenSearch Service type name.

getVpcConfiguration

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

The details of the VPC of the Amazon OpenSearch Service destination.

builder

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

Returns:

a CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty