AmazonopensearchserviceDestinationDescription

The destination description in Amazon OpenSearch Service.

BufferingHints

The buffering options.

Type: AmazonopensearchserviceBufferingHints object

Required: No

CloudWatchLoggingOptions

Describes the Amazon CloudWatch logging options for your Firehose stream.

Type: CloudWatchLoggingOptions object

Required: No

ClusterEndpoint

The endpoint to use when communicating with the cluster. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: https:.*

Required: No

DocumentIdOptions

Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.

Type: DocumentIdOptions object

Required: No

DomainARN

The ARN of the Amazon OpenSearch Service domain.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*:es:[a-zA-Z0-9\-]+:\d{12}:domain/[a-z][-0-9a-z]{2,27}

Required: No

IndexName

The Amazon OpenSearch Service index name.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 80.

Pattern: .*

Required: No

IndexRotationPeriod

The Amazon OpenSearch Service index rotation period

Type: String

Valid Values: NoRotation | OneHour | OneDay | OneWeek | OneMonth

Required: No

ProcessingConfiguration

Describes a data processing configuration.

Type: ProcessingConfiguration object

Required: No

RetryOptions

The Amazon OpenSearch Service retry options.

Type: AmazonopensearchserviceRetryOptions object

Required: No

RoleARN

The Amazon Resource Name (ARN) of the AWS credentials.

Type: String

Length Constraints: Minimum length of 1. Maximum length of 512.

Pattern: arn:.*:iam::\d{12}:role/[a-zA-Z_0-9+=,.@\-_/]+

Required: No

S3BackupMode

The Amazon S3 backup mode.

Type: String

Valid Values: FailedDocumentsOnly | AllDocuments

Required: No

S3DestinationDescription

Describes a destination in Amazon S3.

Type: S3DestinationDescription object

Required: No

TypeName

The Amazon OpenSearch Service type name. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.

Type: String

Length Constraints: Minimum length of 0. Maximum length of 100.

Pattern: .*

Required: No

VpcConfigurationDescription

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

Type: VpcConfigurationDescription object

Required: No

AmazonopensearchserviceDestinationDescription

Contents

See Also