Interface CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Jsii$Proxy
- Enclosing class:
CfnDeliveryStream
@Stability(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") .documentIdOptions(DocumentIdOptionsProperty.builder() .defaultDocumentIdFormat("defaultDocumentIdFormat") .build()) .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();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
static final class
An implementation forCfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty
-
Method Summary
Modifier and TypeMethodDescriptionbuilder()
default Object
The buffering options.default Object
Describes the Amazon CloudWatch logging options for your delivery stream.default String
The endpoint to use when communicating with the cluster.default Object
Indicates the method for setting up document ID.default String
The ARN of the Amazon OpenSearch Service domain.The Amazon OpenSearch Service index name.default String
The Amazon OpenSearch Service index rotation period.default Object
Describes a data processing configuration.default Object
The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon OpenSearch Service.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
Defines how documents should be delivered to Amazon S3.Describes the configuration of a destination in Amazon S3.default String
The Amazon OpenSearch Service type name.default Object
The details of the VPC of the Amazon OpenSearch Service destination.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getIndexName
The Amazon OpenSearch Service index name.- See Also:
-
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.- See Also:
-
getS3Configuration
Describes the configuration of a destination in Amazon S3.- See Also:
-
getBufferingHints
The buffering options.If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
- See Also:
-
getCloudWatchLoggingOptions
Describes the Amazon CloudWatch logging options for your delivery stream.- See Also:
-
getClusterEndpoint
The endpoint to use when communicating with the cluster.Specify either this ClusterEndpoint or the DomainARN field.
- See Also:
-
getDocumentIdOptions
Indicates the method for setting up document ID.The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
- See Also:
-
getDomainArn
The ARN of the Amazon OpenSearch Service domain.- See Also:
-
getIndexRotationPeriod
The Amazon OpenSearch Service index rotation period.Index rotation appends a timestamp to the IndexName to facilitate the expiration of old data.
- See Also:
-
getProcessingConfiguration
Describes a data processing configuration.- See Also:
-
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).
- See Also:
-
getS3BackupMode
Defines how documents should be delivered to Amazon S3.- See Also:
-
getTypeName
The Amazon OpenSearch Service type name.- See Also:
-
getVpcConfiguration
The details of the VPC of the Amazon OpenSearch Service destination.- See Also:
-
builder
@Stability(Stable) static CfnDeliveryStream.AmazonopensearchserviceDestinationConfigurationProperty.Builder builder()
-