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
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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The buffering options.default Object
default String
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.The Serverless offering for Amazon OpenSearch Service index name.default Object
default Object
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.default String
Defines how documents should be delivered to Amazon S3.default Object
Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIndexName
The Serverless offering for Amazon OpenSearch Service index name.- See Also:
-
getRoleArn
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Serverless offering for Amazon OpenSearch Service Configuration API and for indexing documents.- See Also:
-
getS3Configuration
- See Also:
-
getBufferingHints
The buffering options.If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- See Also:
-
getCloudWatchLoggingOptions
- See Also:
-
getCollectionEndpoint
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.- See Also:
-
getProcessingConfiguration
- See Also:
-
getRetryOptions
The retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.The default value is 300 (5 minutes).
- See Also:
-
getS3BackupMode
Defines how documents should be delivered to Amazon S3.When it is set to FailedDocumentsOnly, 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, Firehose delivers all incoming records to Amazon S3, and also writes failed documents with AmazonOpenSearchService-failed/ appended to the prefix.
- See Also:
-
getVpcConfiguration
- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder builder()
-