software.amazon.awscdk.services.kinesisfirehose

Interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

All Known Implementing Classes:

CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Jsii$Proxy

Enclosing class:

CfnDeliveryStream

public static interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty

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

Method Detail

getIndexName

java.lang.String getIndexName()

The Amazon OpenSearch Service index name.

getRoleArn

java.lang.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

java.lang.Object getS3Configuration()

Describes the configuration of a destination in Amazon S3.

getBufferingHints

default java.lang.Object getBufferingHints()

The buffering options.

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

getCloudWatchLoggingOptions

default java.lang.Object getCloudWatchLoggingOptions()

Describes the Amazon CloudWatch logging options for your delivery stream.

getClusterEndpoint

default java.lang.String getClusterEndpoint()

The endpoint to use when communicating with the cluster.

Specify either this ClusterEndpoint or the DomainARN field.

getDomainArn

default java.lang.String getDomainArn()

The ARN of the Amazon OpenSearch Service domain.

getIndexRotationPeriod

default java.lang.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

default java.lang.Object getProcessingConfiguration()

Describes a data processing configuration.

getRetryOptions

default java.lang.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

default java.lang.String getS3BackupMode()

Defines how documents should be delivered to Amazon S3.

getTypeName

default java.lang.String getTypeName()

The Amazon OpenSearch Service type name.

getVpcConfiguration

default java.lang.Object getVpcConfiguration()

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

builder

static CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder builder()

Returns:

a CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder of CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty