AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::Firehose::Model::ElasticsearchDestinationConfiguration Class Reference

#include <ElasticsearchDestinationConfiguration.h>

Public Member Functions

 ElasticsearchDestinationConfiguration ()
 
 ElasticsearchDestinationConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
ElasticsearchDestinationConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetRoleARN () const
 
bool RoleARNHasBeenSet () const
 
void SetRoleARN (const Aws::String &value)
 
void SetRoleARN (Aws::String &&value)
 
void SetRoleARN (const char *value)
 
ElasticsearchDestinationConfigurationWithRoleARN (const Aws::String &value)
 
ElasticsearchDestinationConfigurationWithRoleARN (Aws::String &&value)
 
ElasticsearchDestinationConfigurationWithRoleARN (const char *value)
 
const Aws::StringGetDomainARN () const
 
bool DomainARNHasBeenSet () const
 
void SetDomainARN (const Aws::String &value)
 
void SetDomainARN (Aws::String &&value)
 
void SetDomainARN (const char *value)
 
ElasticsearchDestinationConfigurationWithDomainARN (const Aws::String &value)
 
ElasticsearchDestinationConfigurationWithDomainARN (Aws::String &&value)
 
ElasticsearchDestinationConfigurationWithDomainARN (const char *value)
 
const Aws::StringGetClusterEndpoint () const
 
bool ClusterEndpointHasBeenSet () const
 
void SetClusterEndpoint (const Aws::String &value)
 
void SetClusterEndpoint (Aws::String &&value)
 
void SetClusterEndpoint (const char *value)
 
ElasticsearchDestinationConfigurationWithClusterEndpoint (const Aws::String &value)
 
ElasticsearchDestinationConfigurationWithClusterEndpoint (Aws::String &&value)
 
ElasticsearchDestinationConfigurationWithClusterEndpoint (const char *value)
 
const Aws::StringGetIndexName () const
 
bool IndexNameHasBeenSet () const
 
void SetIndexName (const Aws::String &value)
 
void SetIndexName (Aws::String &&value)
 
void SetIndexName (const char *value)
 
ElasticsearchDestinationConfigurationWithIndexName (const Aws::String &value)
 
ElasticsearchDestinationConfigurationWithIndexName (Aws::String &&value)
 
ElasticsearchDestinationConfigurationWithIndexName (const char *value)
 
const Aws::StringGetTypeName () const
 
bool TypeNameHasBeenSet () const
 
void SetTypeName (const Aws::String &value)
 
void SetTypeName (Aws::String &&value)
 
void SetTypeName (const char *value)
 
ElasticsearchDestinationConfigurationWithTypeName (const Aws::String &value)
 
ElasticsearchDestinationConfigurationWithTypeName (Aws::String &&value)
 
ElasticsearchDestinationConfigurationWithTypeName (const char *value)
 
const ElasticsearchIndexRotationPeriodGetIndexRotationPeriod () const
 
bool IndexRotationPeriodHasBeenSet () const
 
void SetIndexRotationPeriod (const ElasticsearchIndexRotationPeriod &value)
 
void SetIndexRotationPeriod (ElasticsearchIndexRotationPeriod &&value)
 
ElasticsearchDestinationConfigurationWithIndexRotationPeriod (const ElasticsearchIndexRotationPeriod &value)
 
ElasticsearchDestinationConfigurationWithIndexRotationPeriod (ElasticsearchIndexRotationPeriod &&value)
 
const ElasticsearchBufferingHintsGetBufferingHints () const
 
bool BufferingHintsHasBeenSet () const
 
void SetBufferingHints (const ElasticsearchBufferingHints &value)
 
void SetBufferingHints (ElasticsearchBufferingHints &&value)
 
ElasticsearchDestinationConfigurationWithBufferingHints (const ElasticsearchBufferingHints &value)
 
ElasticsearchDestinationConfigurationWithBufferingHints (ElasticsearchBufferingHints &&value)
 
const ElasticsearchRetryOptionsGetRetryOptions () const
 
bool RetryOptionsHasBeenSet () const
 
void SetRetryOptions (const ElasticsearchRetryOptions &value)
 
void SetRetryOptions (ElasticsearchRetryOptions &&value)
 
ElasticsearchDestinationConfigurationWithRetryOptions (const ElasticsearchRetryOptions &value)
 
ElasticsearchDestinationConfigurationWithRetryOptions (ElasticsearchRetryOptions &&value)
 
const ElasticsearchS3BackupModeGetS3BackupMode () const
 
bool S3BackupModeHasBeenSet () const
 
void SetS3BackupMode (const ElasticsearchS3BackupMode &value)
 
void SetS3BackupMode (ElasticsearchS3BackupMode &&value)
 
ElasticsearchDestinationConfigurationWithS3BackupMode (const ElasticsearchS3BackupMode &value)
 
ElasticsearchDestinationConfigurationWithS3BackupMode (ElasticsearchS3BackupMode &&value)
 
const S3DestinationConfigurationGetS3Configuration () const
 
bool S3ConfigurationHasBeenSet () const
 
void SetS3Configuration (const S3DestinationConfiguration &value)
 
void SetS3Configuration (S3DestinationConfiguration &&value)
 
ElasticsearchDestinationConfigurationWithS3Configuration (const S3DestinationConfiguration &value)
 
ElasticsearchDestinationConfigurationWithS3Configuration (S3DestinationConfiguration &&value)
 
const ProcessingConfigurationGetProcessingConfiguration () const
 
bool ProcessingConfigurationHasBeenSet () const
 
void SetProcessingConfiguration (const ProcessingConfiguration &value)
 
void SetProcessingConfiguration (ProcessingConfiguration &&value)
 
ElasticsearchDestinationConfigurationWithProcessingConfiguration (const ProcessingConfiguration &value)
 
ElasticsearchDestinationConfigurationWithProcessingConfiguration (ProcessingConfiguration &&value)
 
const CloudWatchLoggingOptionsGetCloudWatchLoggingOptions () const
 
bool CloudWatchLoggingOptionsHasBeenSet () const
 
void SetCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
void SetCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 
ElasticsearchDestinationConfigurationWithCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
ElasticsearchDestinationConfigurationWithCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 
const VpcConfigurationGetVpcConfiguration () const
 
bool VpcConfigurationHasBeenSet () const
 
void SetVpcConfiguration (const VpcConfiguration &value)
 
void SetVpcConfiguration (VpcConfiguration &&value)
 
ElasticsearchDestinationConfigurationWithVpcConfiguration (const VpcConfiguration &value)
 
ElasticsearchDestinationConfigurationWithVpcConfiguration (VpcConfiguration &&value)
 

Detailed Description

Describes the configuration of a destination in Amazon ES.

See Also:

AWS API Reference

Definition at line 40 of file ElasticsearchDestinationConfiguration.h.

Constructor & Destructor Documentation

◆ ElasticsearchDestinationConfiguration() [1/2]

Aws::Firehose::Model::ElasticsearchDestinationConfiguration::ElasticsearchDestinationConfiguration ( )

◆ ElasticsearchDestinationConfiguration() [2/2]

Aws::Firehose::Model::ElasticsearchDestinationConfiguration::ElasticsearchDestinationConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BufferingHintsHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::BufferingHintsHasBeenSet ( ) const
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 461 of file ElasticsearchDestinationConfiguration.h.

◆ CloudWatchLoggingOptionsHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::CloudWatchLoggingOptionsHasBeenSet ( ) const
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 692 of file ElasticsearchDestinationConfiguration.h.

◆ ClusterEndpointHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::ClusterEndpointHasBeenSet ( ) const
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 245 of file ElasticsearchDestinationConfiguration.h.

◆ DomainARNHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::DomainARNHasBeenSet ( ) const
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 160 of file ElasticsearchDestinationConfiguration.h.

◆ GetBufferingHints()

const ElasticsearchBufferingHints& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetBufferingHints ( ) const
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 455 of file ElasticsearchDestinationConfiguration.h.

◆ GetCloudWatchLoggingOptions()

const CloudWatchLoggingOptions& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetCloudWatchLoggingOptions ( ) const
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 687 of file ElasticsearchDestinationConfiguration.h.

◆ GetClusterEndpoint()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetClusterEndpoint ( ) const
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 239 of file ElasticsearchDestinationConfiguration.h.

◆ GetDomainARN()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetDomainARN ( ) const
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 148 of file ElasticsearchDestinationConfiguration.h.

◆ GetIndexName()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetIndexName ( ) const
inline

The Elasticsearch index name.

Definition at line 287 of file ElasticsearchDestinationConfiguration.h.

◆ GetIndexRotationPeriod()

const ElasticsearchIndexRotationPeriod& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetIndexRotationPeriod ( ) const
inline

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.

Definition at line 398 of file ElasticsearchDestinationConfiguration.h.

◆ GetProcessingConfiguration()

const ProcessingConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetProcessingConfiguration ( ) const
inline

The data processing configuration.

Definition at line 656 of file ElasticsearchDestinationConfiguration.h.

◆ GetRetryOptions()

const ElasticsearchRetryOptions& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetRetryOptions ( ) const
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 492 of file ElasticsearchDestinationConfiguration.h.

◆ GetRoleARN()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetRoleARN ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 58 of file ElasticsearchDestinationConfiguration.h.

◆ GetS3BackupMode()

const ElasticsearchS3BackupMode& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetS3BackupMode ( ) const
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 539 of file ElasticsearchDestinationConfiguration.h.

◆ GetS3Configuration()

const S3DestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetS3Configuration ( ) const
inline

The configuration for the backup Amazon S3 location.

Definition at line 625 of file ElasticsearchDestinationConfiguration.h.

◆ GetTypeName()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetTypeName ( ) const
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 331 of file ElasticsearchDestinationConfiguration.h.

◆ GetVpcConfiguration()

const VpcConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::GetVpcConfiguration ( ) const
inline

The details of the VPC of the Amazon ES destination.

Definition at line 718 of file ElasticsearchDestinationConfiguration.h.

◆ IndexNameHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::IndexNameHasBeenSet ( ) const
inline

The Elasticsearch index name.

Definition at line 292 of file ElasticsearchDestinationConfiguration.h.

◆ IndexRotationPeriodHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::IndexRotationPeriodHasBeenSet ( ) const
inline

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.

Definition at line 408 of file ElasticsearchDestinationConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::Firehose::Model::ElasticsearchDestinationConfiguration::Jsonize ( ) const

◆ operator=()

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ ProcessingConfigurationHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::ProcessingConfigurationHasBeenSet ( ) const
inline

The data processing configuration.

Definition at line 661 of file ElasticsearchDestinationConfiguration.h.

◆ RetryOptionsHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::RetryOptionsHasBeenSet ( ) const
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 498 of file ElasticsearchDestinationConfiguration.h.

◆ RoleARNHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::RoleARNHasBeenSet ( ) const
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 69 of file ElasticsearchDestinationConfiguration.h.

◆ S3BackupModeHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::S3BackupModeHasBeenSet ( ) const
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 555 of file ElasticsearchDestinationConfiguration.h.

◆ S3ConfigurationHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::S3ConfigurationHasBeenSet ( ) const
inline

The configuration for the backup Amazon S3 location.

Definition at line 630 of file ElasticsearchDestinationConfiguration.h.

◆ SetBufferingHints() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetBufferingHints ( const ElasticsearchBufferingHints value)
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 467 of file ElasticsearchDestinationConfiguration.h.

◆ SetBufferingHints() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetBufferingHints ( ElasticsearchBufferingHints &&  value)
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 473 of file ElasticsearchDestinationConfiguration.h.

◆ SetCloudWatchLoggingOptions() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetCloudWatchLoggingOptions ( const CloudWatchLoggingOptions value)
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 697 of file ElasticsearchDestinationConfiguration.h.

◆ SetCloudWatchLoggingOptions() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetCloudWatchLoggingOptions ( CloudWatchLoggingOptions &&  value)
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 702 of file ElasticsearchDestinationConfiguration.h.

◆ SetClusterEndpoint() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetClusterEndpoint ( const Aws::String value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 251 of file ElasticsearchDestinationConfiguration.h.

◆ SetClusterEndpoint() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetClusterEndpoint ( Aws::String &&  value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 257 of file ElasticsearchDestinationConfiguration.h.

◆ SetClusterEndpoint() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetClusterEndpoint ( const char *  value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 263 of file ElasticsearchDestinationConfiguration.h.

◆ SetDomainARN() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetDomainARN ( const Aws::String value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 172 of file ElasticsearchDestinationConfiguration.h.

◆ SetDomainARN() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetDomainARN ( Aws::String &&  value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 184 of file ElasticsearchDestinationConfiguration.h.

◆ SetDomainARN() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetDomainARN ( const char *  value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 196 of file ElasticsearchDestinationConfiguration.h.

◆ SetIndexName() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetIndexName ( const Aws::String value)
inline

The Elasticsearch index name.

Definition at line 297 of file ElasticsearchDestinationConfiguration.h.

◆ SetIndexName() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetIndexName ( Aws::String &&  value)
inline

The Elasticsearch index name.

Definition at line 302 of file ElasticsearchDestinationConfiguration.h.

◆ SetIndexName() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetIndexName ( const char *  value)
inline

The Elasticsearch index name.

Definition at line 307 of file ElasticsearchDestinationConfiguration.h.

◆ SetIndexRotationPeriod() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetIndexRotationPeriod ( const ElasticsearchIndexRotationPeriod value)
inline

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.

Definition at line 418 of file ElasticsearchDestinationConfiguration.h.

◆ SetIndexRotationPeriod() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetIndexRotationPeriod ( ElasticsearchIndexRotationPeriod &&  value)
inline

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.

Definition at line 428 of file ElasticsearchDestinationConfiguration.h.

◆ SetProcessingConfiguration() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetProcessingConfiguration ( const ProcessingConfiguration value)
inline

The data processing configuration.

Definition at line 666 of file ElasticsearchDestinationConfiguration.h.

◆ SetProcessingConfiguration() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetProcessingConfiguration ( ProcessingConfiguration &&  value)
inline

The data processing configuration.

Definition at line 671 of file ElasticsearchDestinationConfiguration.h.

◆ SetRetryOptions() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetRetryOptions ( const ElasticsearchRetryOptions value)
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 504 of file ElasticsearchDestinationConfiguration.h.

◆ SetRetryOptions() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetRetryOptions ( ElasticsearchRetryOptions &&  value)
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 510 of file ElasticsearchDestinationConfiguration.h.

◆ SetRoleARN() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetRoleARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 80 of file ElasticsearchDestinationConfiguration.h.

◆ SetRoleARN() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 91 of file ElasticsearchDestinationConfiguration.h.

◆ SetRoleARN() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetRoleARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 102 of file ElasticsearchDestinationConfiguration.h.

◆ SetS3BackupMode() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetS3BackupMode ( const ElasticsearchS3BackupMode value)
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 571 of file ElasticsearchDestinationConfiguration.h.

◆ SetS3BackupMode() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetS3BackupMode ( ElasticsearchS3BackupMode &&  value)
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 587 of file ElasticsearchDestinationConfiguration.h.

◆ SetS3Configuration() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetS3Configuration ( const S3DestinationConfiguration value)
inline

The configuration for the backup Amazon S3 location.

Definition at line 635 of file ElasticsearchDestinationConfiguration.h.

◆ SetS3Configuration() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetS3Configuration ( S3DestinationConfiguration &&  value)
inline

The configuration for the backup Amazon S3 location.

Definition at line 640 of file ElasticsearchDestinationConfiguration.h.

◆ SetTypeName() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetTypeName ( const Aws::String value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 347 of file ElasticsearchDestinationConfiguration.h.

◆ SetTypeName() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetTypeName ( Aws::String &&  value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 355 of file ElasticsearchDestinationConfiguration.h.

◆ SetTypeName() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetTypeName ( const char *  value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 363 of file ElasticsearchDestinationConfiguration.h.

◆ SetVpcConfiguration() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetVpcConfiguration ( const VpcConfiguration value)
inline

The details of the VPC of the Amazon ES destination.

Definition at line 728 of file ElasticsearchDestinationConfiguration.h.

◆ SetVpcConfiguration() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationConfiguration::SetVpcConfiguration ( VpcConfiguration &&  value)
inline

The details of the VPC of the Amazon ES destination.

Definition at line 733 of file ElasticsearchDestinationConfiguration.h.

◆ TypeNameHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::TypeNameHasBeenSet ( ) const
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 339 of file ElasticsearchDestinationConfiguration.h.

◆ VpcConfigurationHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationConfiguration::VpcConfigurationHasBeenSet ( ) const
inline

The details of the VPC of the Amazon ES destination.

Definition at line 723 of file ElasticsearchDestinationConfiguration.h.

◆ WithBufferingHints() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithBufferingHints ( const ElasticsearchBufferingHints value)
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 479 of file ElasticsearchDestinationConfiguration.h.

◆ WithBufferingHints() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithBufferingHints ( ElasticsearchBufferingHints &&  value)
inline

The buffering options. If no value is specified, the default values for ElasticsearchBufferingHints are used.

Definition at line 485 of file ElasticsearchDestinationConfiguration.h.

◆ WithCloudWatchLoggingOptions() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithCloudWatchLoggingOptions ( const CloudWatchLoggingOptions value)
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 707 of file ElasticsearchDestinationConfiguration.h.

◆ WithCloudWatchLoggingOptions() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithCloudWatchLoggingOptions ( CloudWatchLoggingOptions &&  value)
inline

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 712 of file ElasticsearchDestinationConfiguration.h.

◆ WithClusterEndpoint() [1/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithClusterEndpoint ( const Aws::String value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 269 of file ElasticsearchDestinationConfiguration.h.

◆ WithClusterEndpoint() [2/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithClusterEndpoint ( Aws::String &&  value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 275 of file ElasticsearchDestinationConfiguration.h.

◆ WithClusterEndpoint() [3/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithClusterEndpoint ( const char *  value)
inline

The endpoint to use when communicating with the cluster. Specify either this ClusterEndpoint or the DomainARN field.

Definition at line 281 of file ElasticsearchDestinationConfiguration.h.

◆ WithDomainARN() [1/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithDomainARN ( const Aws::String value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 208 of file ElasticsearchDestinationConfiguration.h.

◆ WithDomainARN() [2/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithDomainARN ( Aws::String &&  value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 220 of file ElasticsearchDestinationConfiguration.h.

◆ WithDomainARN() [3/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithDomainARN ( const char *  value)
inline

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.

Specify either ClusterEndpoint or DomainARN.

Definition at line 232 of file ElasticsearchDestinationConfiguration.h.

◆ WithIndexName() [1/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithIndexName ( const Aws::String value)
inline

The Elasticsearch index name.

Definition at line 312 of file ElasticsearchDestinationConfiguration.h.

◆ WithIndexName() [2/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithIndexName ( Aws::String &&  value)
inline

The Elasticsearch index name.

Definition at line 317 of file ElasticsearchDestinationConfiguration.h.

◆ WithIndexName() [3/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithIndexName ( const char *  value)
inline

The Elasticsearch index name.

Definition at line 322 of file ElasticsearchDestinationConfiguration.h.

◆ WithIndexRotationPeriod() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithIndexRotationPeriod ( const ElasticsearchIndexRotationPeriod value)
inline

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.

Definition at line 438 of file ElasticsearchDestinationConfiguration.h.

◆ WithIndexRotationPeriod() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithIndexRotationPeriod ( ElasticsearchIndexRotationPeriod &&  value)
inline

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.

Definition at line 448 of file ElasticsearchDestinationConfiguration.h.

◆ WithProcessingConfiguration() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithProcessingConfiguration ( const ProcessingConfiguration value)
inline

The data processing configuration.

Definition at line 676 of file ElasticsearchDestinationConfiguration.h.

◆ WithProcessingConfiguration() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithProcessingConfiguration ( ProcessingConfiguration &&  value)
inline

The data processing configuration.

Definition at line 681 of file ElasticsearchDestinationConfiguration.h.

◆ WithRetryOptions() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithRetryOptions ( const ElasticsearchRetryOptions value)
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 516 of file ElasticsearchDestinationConfiguration.h.

◆ WithRetryOptions() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithRetryOptions ( ElasticsearchRetryOptions &&  value)
inline

The retry behavior in case Kinesis Data Firehose is unable to deliver documents to Amazon ES. The default value is 300 (5 minutes).

Definition at line 522 of file ElasticsearchDestinationConfiguration.h.

◆ WithRoleARN() [1/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithRoleARN ( const Aws::String value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 113 of file ElasticsearchDestinationConfiguration.h.

◆ WithRoleARN() [2/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithRoleARN ( Aws::String &&  value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 124 of file ElasticsearchDestinationConfiguration.h.

◆ WithRoleARN() [3/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithRoleARN ( const char *  value)
inline

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data Firehose for calling the Amazon ES Configuration API and for indexing documents. For more information, see Grant Kinesis Data Firehose Access to an Amazon S3 Destination and Amazon Resource Names (ARNs) and AWS Service Namespaces.

Definition at line 135 of file ElasticsearchDestinationConfiguration.h.

◆ WithS3BackupMode() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithS3BackupMode ( const ElasticsearchS3BackupMode value)
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 603 of file ElasticsearchDestinationConfiguration.h.

◆ WithS3BackupMode() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithS3BackupMode ( ElasticsearchS3BackupMode &&  value)
inline

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.

You can't change this backup mode after you create the delivery stream.

Definition at line 619 of file ElasticsearchDestinationConfiguration.h.

◆ WithS3Configuration() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithS3Configuration ( const S3DestinationConfiguration value)
inline

The configuration for the backup Amazon S3 location.

Definition at line 645 of file ElasticsearchDestinationConfiguration.h.

◆ WithS3Configuration() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithS3Configuration ( S3DestinationConfiguration &&  value)
inline

The configuration for the backup Amazon S3 location.

Definition at line 650 of file ElasticsearchDestinationConfiguration.h.

◆ WithTypeName() [1/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithTypeName ( const Aws::String value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 371 of file ElasticsearchDestinationConfiguration.h.

◆ WithTypeName() [2/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithTypeName ( Aws::String &&  value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 379 of file ElasticsearchDestinationConfiguration.h.

◆ WithTypeName() [3/3]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithTypeName ( const char *  value)
inline

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.

For Elasticsearch 7.x, don't specify a TypeName.

Definition at line 387 of file ElasticsearchDestinationConfiguration.h.

◆ WithVpcConfiguration() [1/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithVpcConfiguration ( const VpcConfiguration value)
inline

The details of the VPC of the Amazon ES destination.

Definition at line 738 of file ElasticsearchDestinationConfiguration.h.

◆ WithVpcConfiguration() [2/2]

ElasticsearchDestinationConfiguration& Aws::Firehose::Model::ElasticsearchDestinationConfiguration::WithVpcConfiguration ( VpcConfiguration &&  value)
inline

The details of the VPC of the Amazon ES destination.

Definition at line 743 of file ElasticsearchDestinationConfiguration.h.


The documentation for this class was generated from the following file: