/AWS1/CL_FRHAMAZONOPENSRCHSV04¶
Describes an update for a destination in Amazon OpenSearch Service.
CONSTRUCTOR¶
IMPORTING¶
Optional 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.
iv_domainarn TYPE /AWS1/FRHAMAZONOPENSRCHSVCDO00 /AWS1/FRHAMAZONOPENSRCHSVCDO00¶
The ARN of the Amazon OpenSearch Service domain. The IAM role must have permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
iv_clusterendpoint TYPE /AWS1/FRHAMAZONOPENSRCHSVCCL00 /AWS1/FRHAMAZONOPENSRCHSVCCL00¶
The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.
iv_indexname TYPE /AWS1/FRHAMAZONOPENSRCHSVCID00 /AWS1/FRHAMAZONOPENSRCHSVCID00¶
The Amazon OpenSearch Service index name.
iv_typename TYPE /AWS1/FRHAMAZONOPENSRCHSVCTY00 /AWS1/FRHAMAZONOPENSRCHSVCTY00¶
The Amazon OpenSearch Service 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 runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for TypeName.
iv_indexrotationperiod TYPE /AWS1/FRHAMAZONOPENSRCHSVCID01 /AWS1/FRHAMAZONOPENSRCHSVCID01¶
The Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
io_bufferinghints TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSV01 /AWS1/CL_FRHAMAZONOPENSRCHSV01¶
The buffering options. If no value is specified, AmazonopensearchBufferingHints object default values are used.
io_retryoptions TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSV02 /AWS1/CL_FRHAMAZONOPENSRCHSV02¶
The retry behavior in case Firehose is unable to deliver documents to Amazon OpenSearch Service. The default value is 300 (5 minutes).
io_s3update TYPE REF TO /AWS1/CL_FRHS3DSTUPDATE /AWS1/CL_FRHS3DSTUPDATE¶
S3Update
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_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.
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, and DescribeDomainConfig after assuming the IAM role specified in RoleARN.
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 ClusterEndpoint or the DomainARN field.
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 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 |
TypeName¶
The Amazon OpenSearch Service 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 runtime.
If you upgrade Elasticsearch from 6.x to 7.x and don’t update your Firehose stream, Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your Firehose stream with a new index name, provide an empty string for 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 Amazon OpenSearch Service index rotation period. Index rotation appends a timestamp to IndexName to facilitate the expiration of old data.
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, AmazonopensearchBufferingHints object default values 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 Amazon OpenSearch Service. The default value is 300 (5 minutes).
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRYOPTIONS() |
Getter for RETRYOPTIONS |
S3Update¶
S3Update
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3UPDATE() |
Getter for S3UPDATE |
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 |
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 |