Interface CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStreamPropsMixin
Example:
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.cfnpropertymixins.services.kinesisfirehose.*;
AmazonOpenSearchServerlessDestinationConfigurationProperty amazonOpenSearchServerlessDestinationConfigurationProperty = AmazonOpenSearchServerlessDestinationConfigurationProperty.builder()
.bufferingHints(AmazonOpenSearchServerlessBufferingHintsProperty.builder()
.intervalInSeconds(123)
.sizeInMBs(123)
.build())
.cloudWatchLoggingOptions(CloudWatchLoggingOptionsProperty.builder()
.enabled(false)
.logGroupName("logGroupName")
.logStreamName("logStreamName")
.build())
.collectionEndpoint("collectionEndpoint")
.indexName("indexName")
.processingConfiguration(ProcessingConfigurationProperty.builder()
.enabled(false)
.processors(List.of(ProcessorProperty.builder()
.parameters(List.of(ProcessorParameterProperty.builder()
.parameterName("parameterName")
.parameterValue("parameterValue")
.build()))
.type("type")
.build()))
.build())
.retryOptions(AmazonOpenSearchServerlessRetryOptionsProperty.builder()
.durationInSeconds(123)
.build())
.roleArn("roleArn")
.s3BackupMode("s3BackupMode")
.s3Configuration(S3DestinationConfigurationProperty.builder()
.bucketArn("bucketArn")
.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")
.roleArn("roleArn")
.build())
.vpcConfiguration(VpcConfigurationProperty.builder()
.roleArn("roleArn")
.securityGroupIds(List.of("securityGroupIds"))
.subnetIds(List.of("subnetIds"))
.build())
.build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final classstatic final classAn implementation forCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty -
Method Summary
Modifier and TypeMethodDescriptionstatic CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builderbuilder()default ObjectThe buffering options.default ObjectReturns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsPropertydefault StringThe endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.default StringThe Serverless offering for Amazon OpenSearch Service index name.default ObjectReturns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.ProcessingConfigurationPropertydefault ObjectThe retry behavior in case Firehose is unable to deliver documents to the Serverless offering for Amazon OpenSearch Service.default ObjectThe 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 StringDefines how documents should be delivered to Amazon S3.default ObjectReturns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.S3DestinationConfigurationPropertydefault ObjectReturns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.VpcConfigurationPropertyMethods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getBufferingHints
The buffering options.If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Returns union: either
IResolvableorCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessBufferingHintsProperty- See Also:
-
getCloudWatchLoggingOptions
Returns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.CloudWatchLoggingOptionsProperty- See Also:
-
getCollectionEndpoint
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.- See Also:
-
getIndexName
The Serverless offering for Amazon OpenSearch Service index name.- See Also:
-
getProcessingConfiguration
Returns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.ProcessingConfigurationProperty- 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).
Returns union: either
IResolvableorCfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessRetryOptionsProperty- 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:
-
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:
-
getS3Configuration
Returns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.S3DestinationConfigurationProperty- See Also:
-
getVpcConfiguration
Returns union: eitherIResolvableorCfnDeliveryStreamPropsMixin.VpcConfigurationProperty- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStreamPropsMixin.AmazonOpenSearchServerlessDestinationConfigurationProperty.Builder builder()
-