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

#include <ElasticsearchDestinationUpdate.h>

Public Member Functions

 ElasticsearchDestinationUpdate ()
 
 ElasticsearchDestinationUpdate (Aws::Utils::Json::JsonView jsonValue)
 
ElasticsearchDestinationUpdateoperator= (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)
 
ElasticsearchDestinationUpdateWithRoleARN (const Aws::String &value)
 
ElasticsearchDestinationUpdateWithRoleARN (Aws::String &&value)
 
ElasticsearchDestinationUpdateWithRoleARN (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)
 
ElasticsearchDestinationUpdateWithDomainARN (const Aws::String &value)
 
ElasticsearchDestinationUpdateWithDomainARN (Aws::String &&value)
 
ElasticsearchDestinationUpdateWithDomainARN (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)
 
ElasticsearchDestinationUpdateWithClusterEndpoint (const Aws::String &value)
 
ElasticsearchDestinationUpdateWithClusterEndpoint (Aws::String &&value)
 
ElasticsearchDestinationUpdateWithClusterEndpoint (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)
 
ElasticsearchDestinationUpdateWithIndexName (const Aws::String &value)
 
ElasticsearchDestinationUpdateWithIndexName (Aws::String &&value)
 
ElasticsearchDestinationUpdateWithIndexName (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)
 
ElasticsearchDestinationUpdateWithTypeName (const Aws::String &value)
 
ElasticsearchDestinationUpdateWithTypeName (Aws::String &&value)
 
ElasticsearchDestinationUpdateWithTypeName (const char *value)
 
const ElasticsearchIndexRotationPeriodGetIndexRotationPeriod () const
 
bool IndexRotationPeriodHasBeenSet () const
 
void SetIndexRotationPeriod (const ElasticsearchIndexRotationPeriod &value)
 
void SetIndexRotationPeriod (ElasticsearchIndexRotationPeriod &&value)
 
ElasticsearchDestinationUpdateWithIndexRotationPeriod (const ElasticsearchIndexRotationPeriod &value)
 
ElasticsearchDestinationUpdateWithIndexRotationPeriod (ElasticsearchIndexRotationPeriod &&value)
 
const ElasticsearchBufferingHintsGetBufferingHints () const
 
bool BufferingHintsHasBeenSet () const
 
void SetBufferingHints (const ElasticsearchBufferingHints &value)
 
void SetBufferingHints (ElasticsearchBufferingHints &&value)
 
ElasticsearchDestinationUpdateWithBufferingHints (const ElasticsearchBufferingHints &value)
 
ElasticsearchDestinationUpdateWithBufferingHints (ElasticsearchBufferingHints &&value)
 
const ElasticsearchRetryOptionsGetRetryOptions () const
 
bool RetryOptionsHasBeenSet () const
 
void SetRetryOptions (const ElasticsearchRetryOptions &value)
 
void SetRetryOptions (ElasticsearchRetryOptions &&value)
 
ElasticsearchDestinationUpdateWithRetryOptions (const ElasticsearchRetryOptions &value)
 
ElasticsearchDestinationUpdateWithRetryOptions (ElasticsearchRetryOptions &&value)
 
const S3DestinationUpdateGetS3Update () const
 
bool S3UpdateHasBeenSet () const
 
void SetS3Update (const S3DestinationUpdate &value)
 
void SetS3Update (S3DestinationUpdate &&value)
 
ElasticsearchDestinationUpdateWithS3Update (const S3DestinationUpdate &value)
 
ElasticsearchDestinationUpdateWithS3Update (S3DestinationUpdate &&value)
 
const ProcessingConfigurationGetProcessingConfiguration () const
 
bool ProcessingConfigurationHasBeenSet () const
 
void SetProcessingConfiguration (const ProcessingConfiguration &value)
 
void SetProcessingConfiguration (ProcessingConfiguration &&value)
 
ElasticsearchDestinationUpdateWithProcessingConfiguration (const ProcessingConfiguration &value)
 
ElasticsearchDestinationUpdateWithProcessingConfiguration (ProcessingConfiguration &&value)
 
const CloudWatchLoggingOptionsGetCloudWatchLoggingOptions () const
 
bool CloudWatchLoggingOptionsHasBeenSet () const
 
void SetCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
void SetCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 
ElasticsearchDestinationUpdateWithCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
ElasticsearchDestinationUpdateWithCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 

Detailed Description

Describes an update for a destination in Amazon ES.

See Also:

AWS API Reference

Definition at line 38 of file ElasticsearchDestinationUpdate.h.

Constructor & Destructor Documentation

◆ ElasticsearchDestinationUpdate() [1/2]

Aws::Firehose::Model::ElasticsearchDestinationUpdate::ElasticsearchDestinationUpdate ( )

◆ ElasticsearchDestinationUpdate() [2/2]

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

Member Function Documentation

◆ BufferingHintsHasBeenSet()

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

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

Definition at line 491 of file ElasticsearchDestinationUpdate.h.

◆ CloudWatchLoggingOptionsHasBeenSet()

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

The CloudWatch logging options for your delivery stream.

Definition at line 625 of file ElasticsearchDestinationUpdate.h.

◆ ClusterEndpointHasBeenSet()

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

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

Definition at line 243 of file ElasticsearchDestinationUpdate.h.

◆ DomainARNHasBeenSet()

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

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

Specify either ClusterEndpoint or DomainARN.

Definition at line 158 of file ElasticsearchDestinationUpdate.h.

◆ GetBufferingHints()

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

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

Definition at line 485 of file ElasticsearchDestinationUpdate.h.

◆ GetCloudWatchLoggingOptions()

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

The CloudWatch logging options for your delivery stream.

Definition at line 620 of file ElasticsearchDestinationUpdate.h.

◆ GetClusterEndpoint()

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

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

Definition at line 237 of file ElasticsearchDestinationUpdate.h.

◆ GetDomainARN()

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

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

Specify either ClusterEndpoint or DomainARN.

Definition at line 146 of file ElasticsearchDestinationUpdate.h.

◆ GetIndexName()

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

The Elasticsearch index name.

Definition at line 285 of file ElasticsearchDestinationUpdate.h.

◆ GetIndexRotationPeriod()

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

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

Definition at line 428 of file ElasticsearchDestinationUpdate.h.

◆ GetProcessingConfiguration()

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

The data processing configuration.

Definition at line 589 of file ElasticsearchDestinationUpdate.h.

◆ GetRetryOptions()

const ElasticsearchRetryOptions& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 522 of file ElasticsearchDestinationUpdate.h.

◆ GetRoleARN()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 56 of file ElasticsearchDestinationUpdate.h.

◆ GetS3Update()

const S3DestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::GetS3Update ( ) const
inline

The Amazon S3 destination.

Definition at line 558 of file ElasticsearchDestinationUpdate.h.

◆ GetTypeName()

const Aws::String& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 333 of file ElasticsearchDestinationUpdate.h.

◆ IndexNameHasBeenSet()

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

The Elasticsearch index name.

Definition at line 290 of file ElasticsearchDestinationUpdate.h.

◆ IndexRotationPeriodHasBeenSet()

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

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

Definition at line 438 of file ElasticsearchDestinationUpdate.h.

◆ Jsonize()

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

◆ operator=()

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

◆ ProcessingConfigurationHasBeenSet()

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

The data processing configuration.

Definition at line 594 of file ElasticsearchDestinationUpdate.h.

◆ RetryOptionsHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 528 of file ElasticsearchDestinationUpdate.h.

◆ RoleARNHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 67 of file ElasticsearchDestinationUpdate.h.

◆ S3UpdateHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationUpdate::S3UpdateHasBeenSet ( ) const
inline

The Amazon S3 destination.

Definition at line 563 of file ElasticsearchDestinationUpdate.h.

◆ SetBufferingHints() [1/2]

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

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

Definition at line 497 of file ElasticsearchDestinationUpdate.h.

◆ SetBufferingHints() [2/2]

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

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

Definition at line 503 of file ElasticsearchDestinationUpdate.h.

◆ SetCloudWatchLoggingOptions() [1/2]

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

The CloudWatch logging options for your delivery stream.

Definition at line 630 of file ElasticsearchDestinationUpdate.h.

◆ SetCloudWatchLoggingOptions() [2/2]

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

The CloudWatch logging options for your delivery stream.

Definition at line 635 of file ElasticsearchDestinationUpdate.h.

◆ SetClusterEndpoint() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 249 of file ElasticsearchDestinationUpdate.h.

◆ SetClusterEndpoint() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 255 of file ElasticsearchDestinationUpdate.h.

◆ SetClusterEndpoint() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 261 of file ElasticsearchDestinationUpdate.h.

◆ SetDomainARN() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 170 of file ElasticsearchDestinationUpdate.h.

◆ SetDomainARN() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 182 of file ElasticsearchDestinationUpdate.h.

◆ SetDomainARN() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 194 of file ElasticsearchDestinationUpdate.h.

◆ SetIndexName() [1/3]

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

The Elasticsearch index name.

Definition at line 295 of file ElasticsearchDestinationUpdate.h.

◆ SetIndexName() [2/3]

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

The Elasticsearch index name.

Definition at line 300 of file ElasticsearchDestinationUpdate.h.

◆ SetIndexName() [3/3]

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

The Elasticsearch index name.

Definition at line 305 of file ElasticsearchDestinationUpdate.h.

◆ SetIndexRotationPeriod() [1/2]

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

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

Definition at line 448 of file ElasticsearchDestinationUpdate.h.

◆ SetIndexRotationPeriod() [2/2]

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

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

Definition at line 458 of file ElasticsearchDestinationUpdate.h.

◆ SetProcessingConfiguration() [1/2]

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

The data processing configuration.

Definition at line 599 of file ElasticsearchDestinationUpdate.h.

◆ SetProcessingConfiguration() [2/2]

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

The data processing configuration.

Definition at line 604 of file ElasticsearchDestinationUpdate.h.

◆ SetRetryOptions() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 534 of file ElasticsearchDestinationUpdate.h.

◆ SetRetryOptions() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 540 of file ElasticsearchDestinationUpdate.h.

◆ SetRoleARN() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 78 of file ElasticsearchDestinationUpdate.h.

◆ SetRoleARN() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 89 of file ElasticsearchDestinationUpdate.h.

◆ SetRoleARN() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 100 of file ElasticsearchDestinationUpdate.h.

◆ SetS3Update() [1/2]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::SetS3Update ( const S3DestinationUpdate value)
inline

The Amazon S3 destination.

Definition at line 568 of file ElasticsearchDestinationUpdate.h.

◆ SetS3Update() [2/2]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::SetS3Update ( S3DestinationUpdate &&  value)
inline

The Amazon S3 destination.

Definition at line 573 of file ElasticsearchDestinationUpdate.h.

◆ SetTypeName() [1/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 357 of file ElasticsearchDestinationUpdate.h.

◆ SetTypeName() [2/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 369 of file ElasticsearchDestinationUpdate.h.

◆ SetTypeName() [3/3]

void Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 381 of file ElasticsearchDestinationUpdate.h.

◆ TypeNameHasBeenSet()

bool Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 345 of file ElasticsearchDestinationUpdate.h.

◆ WithBufferingHints() [1/2]

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

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

Definition at line 509 of file ElasticsearchDestinationUpdate.h.

◆ WithBufferingHints() [2/2]

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

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

Definition at line 515 of file ElasticsearchDestinationUpdate.h.

◆ WithCloudWatchLoggingOptions() [1/2]

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

The CloudWatch logging options for your delivery stream.

Definition at line 640 of file ElasticsearchDestinationUpdate.h.

◆ WithCloudWatchLoggingOptions() [2/2]

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

The CloudWatch logging options for your delivery stream.

Definition at line 645 of file ElasticsearchDestinationUpdate.h.

◆ WithClusterEndpoint() [1/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 267 of file ElasticsearchDestinationUpdate.h.

◆ WithClusterEndpoint() [2/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 273 of file ElasticsearchDestinationUpdate.h.

◆ WithClusterEndpoint() [3/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 279 of file ElasticsearchDestinationUpdate.h.

◆ WithDomainARN() [1/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 206 of file ElasticsearchDestinationUpdate.h.

◆ WithDomainARN() [2/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 218 of file ElasticsearchDestinationUpdate.h.

◆ WithDomainARN() [3/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 IAM role specified in RoleARN. For more information, see Amazon Resource Names (ARNs) and AWS Service Namespaces.

Specify either ClusterEndpoint or DomainARN.

Definition at line 230 of file ElasticsearchDestinationUpdate.h.

◆ WithIndexName() [1/3]

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

The Elasticsearch index name.

Definition at line 310 of file ElasticsearchDestinationUpdate.h.

◆ WithIndexName() [2/3]

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

The Elasticsearch index name.

Definition at line 315 of file ElasticsearchDestinationUpdate.h.

◆ WithIndexName() [3/3]

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

The Elasticsearch index name.

Definition at line 320 of file ElasticsearchDestinationUpdate.h.

◆ WithIndexRotationPeriod() [1/2]

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

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

Definition at line 468 of file ElasticsearchDestinationUpdate.h.

◆ WithIndexRotationPeriod() [2/2]

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

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

Definition at line 478 of file ElasticsearchDestinationUpdate.h.

◆ WithProcessingConfiguration() [1/2]

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

The data processing configuration.

Definition at line 609 of file ElasticsearchDestinationUpdate.h.

◆ WithProcessingConfiguration() [2/2]

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

The data processing configuration.

Definition at line 614 of file ElasticsearchDestinationUpdate.h.

◆ WithRetryOptions() [1/2]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 546 of file ElasticsearchDestinationUpdate.h.

◆ WithRetryOptions() [2/2]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 552 of file ElasticsearchDestinationUpdate.h.

◆ WithRoleARN() [1/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 111 of file ElasticsearchDestinationUpdate.h.

◆ WithRoleARN() [2/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 122 of file ElasticsearchDestinationUpdate.h.

◆ WithRoleARN() [3/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 133 of file ElasticsearchDestinationUpdate.h.

◆ WithS3Update() [1/2]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::WithS3Update ( const S3DestinationUpdate value)
inline

The Amazon S3 destination.

Definition at line 578 of file ElasticsearchDestinationUpdate.h.

◆ WithS3Update() [2/2]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::WithS3Update ( S3DestinationUpdate &&  value)
inline

The Amazon S3 destination.

Definition at line 583 of file ElasticsearchDestinationUpdate.h.

◆ WithTypeName() [1/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 393 of file ElasticsearchDestinationUpdate.h.

◆ WithTypeName() [2/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 405 of file ElasticsearchDestinationUpdate.h.

◆ WithTypeName() [3/3]

ElasticsearchDestinationUpdate& Aws::Firehose::Model::ElasticsearchDestinationUpdate::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 runtime.

If you upgrade Elasticsearch from 6.x to 7.x and don’t update your delivery stream, Kinesis Data Firehose still delivers data to Elasticsearch with the old index name and type name. If you want to update your delivery stream with a new index name, provide an empty string for TypeName.

Definition at line 417 of file ElasticsearchDestinationUpdate.h.


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