/AWS1/CL_FRHELASTICSRCHDSTCONF¶
Describes the configuration of a destination in 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 Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
iv_indexname TYPE /AWS1/FRHELASTICSRCHINDEXNAME /AWS1/FRHELASTICSRCHINDEXNAME¶
The Elasticsearch index name.
io_s3configuration TYPE REF TO /AWS1/CL_FRHS3DESTINATIONCONF /AWS1/CL_FRHS3DESTINATIONCONF¶
The configuration for the backup Amazon S3 location.
Optional arguments:¶
iv_domainarn TYPE /AWS1/FRHELASTICSEARCHDOMARN /AWS1/FRHELASTICSEARCHDOMARN¶
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
DescribeDomain,DescribeDomains, andDescribeDomainConfigafter assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpointorDomainARN.
iv_clusterendpoint TYPE /AWS1/FRHELASTICSRCHCLUSTENDPT /AWS1/FRHELASTICSRCHCLUSTENDPT¶
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield.
iv_typename TYPE /AWS1/FRHELASTICSEARCHTYPENAME /AWS1/FRHELASTICSEARCHTYPENAME¶
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a
TypeName.
iv_indexrotationperiod TYPE /AWS1/FRHELASTICSRCHIDXROTAT00 /AWS1/FRHELASTICSRCHIDXROTAT00¶
The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. The default value isOneDay.
io_bufferinghints TYPE REF TO /AWS1/CL_FRHELASTICSRCHBUFFE00 /AWS1/CL_FRHELASTICSRCHBUFFE00¶
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHintsare used.
io_retryoptions TYPE REF TO /AWS1/CL_FRHELASTICSRCHRETRY00 /AWS1/CL_FRHELASTICSRCHRETRY00¶
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
iv_s3backupmode TYPE /AWS1/FRHELASTICSRCHS3BACKUP00 /AWS1/FRHELASTICSRCHS3BACKUP00¶
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, withAmazonOpenSearchService-failed/appended to the key prefix. When set toAllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/appended to the prefix. For more information, see Amazon S3 Backup for the Amazon OpenSearch Service Destination. Default value isFailedDocumentsOnly.You can't change this backup mode after you create the Firehose stream.
io_processingconfiguration TYPE REF TO /AWS1/CL_FRHPROCESSINGCONF /AWS1/CL_FRHPROCESSINGCONF¶
The data processing configuration.
io_cloudwatchloggingoptions TYPE REF TO /AWS1/CL_FRHCLOUDWATCHLOGOPTS /AWS1/CL_FRHCLOUDWATCHLOGOPTS¶
The Amazon CloudWatch logging options for your Firehose stream.
io_vpcconfiguration TYPE REF TO /AWS1/CL_FRHVPCCONFIGURATION /AWS1/CL_FRHVPCCONFIGURATION¶
The details of the VPC of the Amazon destination.
io_documentidoptions TYPE REF TO /AWS1/CL_FRHDOCUMENTIDOPTIONS /AWS1/CL_FRHDOCUMENTIDOPTIONS¶
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Queryable Attributes¶
RoleARN¶
The Amazon Resource Name (ARN) of the IAM role to be assumed by Firehose for calling the Amazon OpenSearch Service Configuration API and for indexing documents. For more information, see Grant Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.
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 |
DomainARN¶
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for
DescribeDomain,DescribeDomains, andDescribeDomainConfigafter assuming the role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and Amazon Web Services Service Namespaces.Specify either
ClusterEndpointorDomainARN.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOMAINARN() |
Getter for DOMAINARN, with configurable default |
ASK_DOMAINARN() |
Getter for DOMAINARN w/ exceptions if field has no value |
HAS_DOMAINARN() |
Determine if DOMAINARN has a value |
ClusterEndpoint¶
The endpoint to use when communicating with the cluster. Specify either this
ClusterEndpointor theDomainARNfield.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLUSTERENDPOINT() |
Getter for CLUSTERENDPOINT, with configurable default |
ASK_CLUSTERENDPOINT() |
Getter for CLUSTERENDPOINT w/ exceptions if field has no val |
HAS_CLUSTERENDPOINT() |
Determine if CLUSTERENDPOINT has a value |
IndexName¶
The Elasticsearch 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 |
TypeName¶
The Elasticsearch type name. For Elasticsearch 6.x, there can be only one type per index. If you try to specify a new type for an existing index that already has another type, Firehose returns an error during run time.
For Elasticsearch 7.x, don't specify a
TypeName.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_TYPENAME() |
Getter for TYPENAME, with configurable default |
ASK_TYPENAME() |
Getter for TYPENAME w/ exceptions if field has no value |
HAS_TYPENAME() |
Determine if TYPENAME has a value |
IndexRotationPeriod¶
The Elasticsearch index rotation period. Index rotation appends a timestamp to the
IndexNameto facilitate the expiration of old data. For more information, see Index Rotation for the Amazon OpenSearch Service Destination. The default value isOneDay.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_INDEXROTATIONPERIOD() |
Getter for INDEXROTATIONPERIOD, with configurable default |
ASK_INDEXROTATIONPERIOD() |
Getter for INDEXROTATIONPERIOD w/ exceptions if field has no |
HAS_INDEXROTATIONPERIOD() |
Determine if INDEXROTATIONPERIOD has a value |
BufferingHints¶
The buffering options. If no value is specified, the default values for
ElasticsearchBufferingHintsare 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 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, withAmazonOpenSearchService-failed/appended to the key prefix. When set toAllDocuments, Firehose delivers all incoming records to Amazon S3, and also writes failed documents withAmazonOpenSearchService-failed/appended to the prefix. For more information, see Amazon S3 Backup for the Amazon OpenSearch Service Destination. Default value isFailedDocumentsOnly.You can't change this backup mode after you create the Firehose stream.
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¶
The configuration for the backup Amazon S3 location.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3CONFIGURATION() |
Getter for S3CONFIGURATION |
ProcessingConfiguration¶
The data processing configuration.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_PROCESSINGCONFIGURATION() |
Getter for PROCESSINGCONFIGURATION |
CloudWatchLoggingOptions¶
The Amazon CloudWatch logging options for your Firehose stream.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_CLOUDWATCHLOGGINGOPTIONS() |
Getter for CLOUDWATCHLOGGINGOPTIONS |
VpcConfiguration¶
The details of the VPC of the Amazon destination.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCCONFIGURATION() |
Getter for VPCCONFIGURATION |
DocumentIdOptions¶
Indicates the method for setting up document ID. The supported methods are Firehose generated document ID and OpenSearch Service generated document ID.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DOCUMENTIDOPTIONS() |
Getter for DOCUMENTIDOPTIONS |