/AWS1/CL_FRHAMAZONOPENSRCHSE00¶
Describes the configuration of a destination in the Serverless offering for Amazon OpenSearch Service.
CONSTRUCTOR¶
IMPORTING¶
Required arguments:¶
IV_ROLEARN TYPE /AWS1/FRHROLEARN /AWS1/FRHROLEARN¶
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.
IV_INDEXNAME TYPE /AWS1/FRHAMAZONOPENSRCHSERVE01 /AWS1/FRHAMAZONOPENSRCHSERVE01¶
The Serverless offering for Amazon OpenSearch Service index name.
IO_S3CONFIGURATION TYPE REF TO /AWS1/CL_FRHS3DESTINATIONCONF /AWS1/CL_FRHS3DESTINATIONCONF¶
S3Configuration
Optional arguments:¶
IV_COLLECTIONENDPOINT TYPE /AWS1/FRHAMAZONOPENSRCHSERVE00 /AWS1/FRHAMAZONOPENSRCHSERVE00¶
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
IO_BUFFERINGHINTS TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSE01 /AWS1/CL_FRHAMAZONOPENSRCHSE01¶
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
IO_RETRYOPTIONS TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSE02 /AWS1/CL_FRHAMAZONOPENSRCHSE02¶
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).
IV_S3BACKUPMODE TYPE /AWS1/FRHAMAZONOPENSRCHSERVE05 /AWS1/FRHAMAZONOPENSRCHSERVE05¶
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.
IO_PROCESSINGCONFIGURATION TYPE REF TO /AWS1/CL_FRHPROCESSINGCONF /AWS1/CL_FRHPROCESSINGCONF¶
ProcessingConfiguration
IO_CLOUDWATCHLOGGINGOPTIONS TYPE REF TO /AWS1/CL_FRHCLOUDWATCHLOGOPTS /AWS1/CL_FRHCLOUDWATCHLOGOPTS¶
CloudWatchLoggingOptions
IO_VPCCONFIGURATION TYPE REF TO /AWS1/CL_FRHVPCCONFIGURATION /AWS1/CL_FRHVPCCONFIGURATION¶
VpcConfiguration
Queryable Attributes¶
RoleARN¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_ROLEARN() |
Getter for ROLEARN, with configurable default |
ASK_ROLEARN() |
Getter for ROLEARN w/ exceptions if field has no value |
HAS_ROLEARN() |
Determine if ROLEARN has a value |
CollectionEndpoint¶
The endpoint to use when communicating with the collection in the Serverless offering for Amazon OpenSearch Service.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_COLLECTIONENDPOINT() |
Getter for COLLECTIONENDPOINT, with configurable default |
ASK_COLLECTIONENDPOINT() |
Getter for COLLECTIONENDPOINT w/ exceptions if field has no |
HAS_COLLECTIONENDPOINT() |
Determine if COLLECTIONENDPOINT has a value |
IndexName¶
The Serverless offering for Amazon OpenSearch Service index name.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXNAME() |
Getter for INDEXNAME, with configurable default |
ASK_INDEXNAME() |
Getter for INDEXNAME w/ exceptions if field has no value |
HAS_INDEXNAME() |
Determine if INDEXNAME has a value |
BufferingHints¶
The buffering options. If no value is specified, the default values for AmazonopensearchserviceBufferingHints are used.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUFFERINGHINTS() |
Getter for BUFFERINGHINTS |
RetryOptions¶
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).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRYOPTIONS() |
Getter for RETRYOPTIONS |
S3BackupMode¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3BACKUPMODE() |
Getter for S3BACKUPMODE, with configurable default |
ASK_S3BACKUPMODE() |
Getter for S3BACKUPMODE w/ exceptions if field has no value |
HAS_S3BACKUPMODE() |
Determine if S3BACKUPMODE has a value |
S3Configuration¶
S3Configuration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3CONFIGURATION() |
Getter for S3CONFIGURATION |
ProcessingConfiguration¶
ProcessingConfiguration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROCESSINGCONFIGURATION() |
Getter for PROCESSINGCONFIGURATION |
CloudWatchLoggingOptions¶
CloudWatchLoggingOptions
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLOUDWATCHLOGGINGOPTIONS() |
Getter for CLOUDWATCHLOGGINGOPTIONS |
VpcConfiguration¶
VpcConfiguration
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCCONFIGURATION() |
Getter for VPCCONFIGURATION |