/AWS1/CL_FRHAMAZONOPENSRCHSV03¶
The destination description in Amazon OpenSearch Service.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_rolearn TYPE /AWS1/FRHROLEARN /AWS1/FRHROLEARN¶
The Amazon Resource Name (ARN) of the Amazon Web Services credentials.
iv_domainarn TYPE /AWS1/FRHAMAZONOPENSRCHSVCDO00 /AWS1/FRHAMAZONOPENSRCHSVCDO00¶
The ARN of the Amazon OpenSearch Service domain.
iv_clusterendpoint TYPE /AWS1/FRHAMAZONOPENSRCHSVCCL00 /AWS1/FRHAMAZONOPENSRCHSVCCL00¶
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.
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. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value for TypeName.
iv_indexrotationperiod TYPE /AWS1/FRHAMAZONOPENSRCHSVCID01 /AWS1/FRHAMAZONOPENSRCHSVCID01¶
The Amazon OpenSearch Service index rotation period
io_bufferinghints TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSV01 /AWS1/CL_FRHAMAZONOPENSRCHSV01¶
The buffering options.
io_retryoptions TYPE REF TO /AWS1/CL_FRHAMAZONOPENSRCHSV02 /AWS1/CL_FRHAMAZONOPENSRCHSV02¶
The Amazon OpenSearch Service retry options.
iv_s3backupmode TYPE /AWS1/FRHAMAZONOPENSRCHSVCS300 /AWS1/FRHAMAZONOPENSRCHSVCS300¶
The Amazon S3 backup mode.
io_s3destinationdescription TYPE REF TO /AWS1/CL_FRHS3DSTDESCRIPTION /AWS1/CL_FRHS3DSTDESCRIPTION¶
S3DestinationDescription
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_vpcconfdescription TYPE REF TO /AWS1/CL_FRHVPCCONFDESCRIPTION /AWS1/CL_FRHVPCCONFDESCRIPTION¶
VpcConfigurationDescription
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 Amazon Web Services credentials.
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.
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. Firehose uses either this ClusterEndpoint or the DomainARN field to send data to Amazon OpenSearch Service.
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. This applies to Elasticsearch 6.x and lower versions. For Elasticsearch 7.x and OpenSearch Service 1.x, there's no value 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
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_BUFFERINGHINTS() |
Getter for BUFFERINGHINTS |
RetryOptions¶
The Amazon OpenSearch Service retry options.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_RETRYOPTIONS() |
Getter for RETRYOPTIONS |
S3BackupMode¶
The Amazon S3 backup mode.
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 |
S3DestinationDescription¶
S3DestinationDescription
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_S3DESTINATIONDESCRIPTION() |
Getter for S3DESTINATIONDESCRIPTION |
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 |
VpcConfigurationDescription¶
VpcConfigurationDescription
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_VPCCONFDESCRIPTION() |
Getter for VPCCONFIGURATIONDESCRIPTION |
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 |