setDomainARN

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain,
DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the
role specified in RoleARN. For more information, see Amazon Resource Names (ARNs)
and AWS Service Namespaces.

Parameters:

domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For
more information, see Amazon Resource Names
(ARNs) and AWS Service Namespaces.

getDomainARN

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain,
DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the
role specified in RoleARN. For more information, see Amazon Resource Names (ARNs)
and AWS Service Namespaces.

Returns:

The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For
more information, see Amazon Resource Names
(ARNs) and AWS Service Namespaces.

withDomainARN

The ARN of the Amazon ES domain. The IAM role must have permissions for DescribeElasticsearchDomain,
DescribeElasticsearchDomains, and DescribeElasticsearchDomainConfig after assuming the
role specified in RoleARN. For more information, see Amazon Resource Names (ARNs)
and AWS Service Namespaces.

Parameters:

domainARN - The ARN of the Amazon ES domain. The IAM role must have permissions for
DescribeElasticsearchDomain, DescribeElasticsearchDomains, and
DescribeElasticsearchDomainConfig after assuming the role specified in RoleARN. For
more information, see Amazon Resource Names
(ARNs) and AWS Service Namespaces.

Returns:

Returns a reference to this object so that method calls can be chained together.

setTypeName

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, Kinesis Data Firehose returns an error during run
time.

Parameters:

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, Kinesis Data Firehose returns an
error during run time.

getTypeName

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, Kinesis Data Firehose returns an error during run
time.

Returns:

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, Kinesis Data Firehose returns an
error during run time.

withTypeName

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, Kinesis Data Firehose returns an error during run
time.

Parameters:

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, Kinesis Data Firehose returns an
error during run time.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation for the
Amazon ES Destination. The default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.

getIndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation for the
Amazon ES Destination. The default value is OneDay.

Returns:

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.

withIndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation for the
Amazon ES Destination. The default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.

Returns:

Returns a reference to this object so that method calls can be chained together.

setIndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation for the
Amazon ES Destination. The default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.

withIndexRotationPeriod

The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName to
facilitate the expiration of old data. For more information, see Index Rotation for the
Amazon ES Destination. The default value is OneDay.

Parameters:

indexRotationPeriod - The Elasticsearch index rotation period. Index rotation appends a timestamp to the IndexName
to facilitate the expiration of old data. For more information, see Index Rotation
for the Amazon ES Destination. The default value is OneDay.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments,
Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the
Amazon ES Destination. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3
destination, with elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also
writes failed documents with elasticsearch-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.

getS3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments,
Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the
Amazon ES Destination. Default value is FailedDocumentsOnly.

Returns:

Defines how documents should be delivered to Amazon S3. When it is set to
FailedDocumentsOnly, Kinesis Data Firehose writes any documents that could not be indexed to
the configured Amazon S3 destination, with elasticsearch-failed/ appended to the key prefix.
When set to AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3,
and also writes failed documents with elasticsearch-failed/ appended to the prefix. For more
information, see Amazon S3 Backup
for the Amazon ES Destination. Default value is FailedDocumentsOnly.

withS3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments,
Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the
Amazon ES Destination. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3
destination, with elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also
writes failed documents with elasticsearch-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.

setS3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments,
Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the
Amazon ES Destination. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3
destination, with elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also
writes failed documents with elasticsearch-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.

withS3BackupMode

Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly,
Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3 destination,
with elasticsearch-failed/ appended to the key prefix. When set to AllDocuments,
Kinesis Data Firehose delivers all incoming records to Amazon S3, and also writes failed documents with
elasticsearch-failed/ appended to the prefix. For more information, see Amazon S3 Backup for the
Amazon ES Destination. Default value is FailedDocumentsOnly.

Parameters:

s3BackupMode - Defines how documents should be delivered to Amazon S3. When it is set to FailedDocumentsOnly
, Kinesis Data Firehose writes any documents that could not be indexed to the configured Amazon S3
destination, with elasticsearch-failed/ appended to the key prefix. When set to
AllDocuments, Kinesis Data Firehose delivers all incoming records to Amazon S3, and also
writes failed documents with elasticsearch-failed/ appended to the prefix. For more
information, see Amazon S3 Backup for
the Amazon ES Destination. Default value is FailedDocumentsOnly.

Returns:

Returns a reference to this object so that method calls can be chained together.