/** * Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. * SPDX-License-Identifier: Apache-2.0. */ #pragma once #include #include #include #include #include #include #include #include #include namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Firehose { namespace Model { /** *

Describes an update for a destination in Amazon OpenSearch * Service.

See Also:

AWS * API Reference

*/ class AmazonopensearchserviceDestinationUpdate { public: AWS_FIREHOSE_API AmazonopensearchserviceDestinationUpdate(); AWS_FIREHOSE_API AmazonopensearchserviceDestinationUpdate(Aws::Utils::Json::JsonView jsonValue); AWS_FIREHOSE_API AmazonopensearchserviceDestinationUpdate& operator=(Aws::Utils::Json::JsonView jsonValue); AWS_FIREHOSE_API Aws::Utils::Json::JsonValue Jsonize() const; /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline const Aws::String& GetRoleARN() const{ return m_roleARN; } /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; } /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; } /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); } /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); } /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline AmazonopensearchserviceDestinationUpdate& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline AmazonopensearchserviceDestinationUpdate& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;} /** *

The Amazon Resource Name (ARN) of the IAM role to be assumed by Kinesis Data * Firehose for calling the Amazon OpenSearch Service Configuration API and for * indexing documents.

*/ inline AmazonopensearchserviceDestinationUpdate& WithRoleARN(const char* value) { SetRoleARN(value); return *this;} /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline const Aws::String& GetDomainARN() const{ return m_domainARN; } /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline bool DomainARNHasBeenSet() const { return m_domainARNHasBeenSet; } /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline void SetDomainARN(const Aws::String& value) { m_domainARNHasBeenSet = true; m_domainARN = value; } /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline void SetDomainARN(Aws::String&& value) { m_domainARNHasBeenSet = true; m_domainARN = std::move(value); } /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline void SetDomainARN(const char* value) { m_domainARNHasBeenSet = true; m_domainARN.assign(value); } /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline AmazonopensearchserviceDestinationUpdate& WithDomainARN(const Aws::String& value) { SetDomainARN(value); return *this;} /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline AmazonopensearchserviceDestinationUpdate& WithDomainARN(Aws::String&& value) { SetDomainARN(std::move(value)); return *this;} /** *

The ARN of the Amazon OpenSearch Service domain. The IAM role must have * permissions for DescribeDomain, DescribeDomains, and DescribeDomainConfig after * assuming the IAM role specified in RoleARN.

*/ inline AmazonopensearchserviceDestinationUpdate& WithDomainARN(const char* value) { SetDomainARN(value); return *this;} /** *

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

*/ inline const Aws::String& GetClusterEndpoint() const{ return m_clusterEndpoint; } /** *

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

*/ inline bool ClusterEndpointHasBeenSet() const { return m_clusterEndpointHasBeenSet; } /** *

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

*/ inline void SetClusterEndpoint(const Aws::String& value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint = value; } /** *

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

*/ inline void SetClusterEndpoint(Aws::String&& value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint = std::move(value); } /** *

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

*/ inline void SetClusterEndpoint(const char* value) { m_clusterEndpointHasBeenSet = true; m_clusterEndpoint.assign(value); } /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithClusterEndpoint(const Aws::String& value) { SetClusterEndpoint(value); return *this;} /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithClusterEndpoint(Aws::String&& value) { SetClusterEndpoint(std::move(value)); return *this;} /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithClusterEndpoint(const char* value) { SetClusterEndpoint(value); return *this;} /** *

The Amazon OpenSearch Service index name.

*/ inline const Aws::String& GetIndexName() const{ return m_indexName; } /** *

The Amazon OpenSearch Service index name.

*/ inline bool IndexNameHasBeenSet() const { return m_indexNameHasBeenSet; } /** *

The Amazon OpenSearch Service index name.

*/ inline void SetIndexName(const Aws::String& value) { m_indexNameHasBeenSet = true; m_indexName = value; } /** *

The Amazon OpenSearch Service index name.

*/ inline void SetIndexName(Aws::String&& value) { m_indexNameHasBeenSet = true; m_indexName = std::move(value); } /** *

The Amazon OpenSearch Service index name.

*/ inline void SetIndexName(const char* value) { m_indexNameHasBeenSet = true; m_indexName.assign(value); } /** *

The Amazon OpenSearch Service index name.

*/ inline AmazonopensearchserviceDestinationUpdate& WithIndexName(const Aws::String& value) { SetIndexName(value); return *this;} /** *

The Amazon OpenSearch Service index name.

*/ inline AmazonopensearchserviceDestinationUpdate& WithIndexName(Aws::String&& value) { SetIndexName(std::move(value)); return *this;} /** *

The Amazon OpenSearch Service index name.

*/ inline AmazonopensearchserviceDestinationUpdate& WithIndexName(const char* value) { SetIndexName(value); return *this;} /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline const Aws::String& GetTypeName() const{ return m_typeName; } /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline bool TypeNameHasBeenSet() const { return m_typeNameHasBeenSet; } /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline void SetTypeName(const Aws::String& value) { m_typeNameHasBeenSet = true; m_typeName = value; } /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline void SetTypeName(Aws::String&& value) { m_typeNameHasBeenSet = true; m_typeName = std::move(value); } /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline void SetTypeName(const char* value) { m_typeNameHasBeenSet = true; m_typeName.assign(value); } /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline AmazonopensearchserviceDestinationUpdate& WithTypeName(const Aws::String& value) { SetTypeName(value); return *this;} /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline AmazonopensearchserviceDestinationUpdate& WithTypeName(Aws::String&& value) { SetTypeName(std::move(value)); return *this;} /** *

The Amazon OpenSearch Service type name. For Elasticsearch 6.x, there can be * only one type per index. If you try to specify a new type for an existing index * that already has another type, 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.

*/ inline AmazonopensearchserviceDestinationUpdate& WithTypeName(const char* value) { SetTypeName(value); return *this;} /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline const AmazonopensearchserviceIndexRotationPeriod& GetIndexRotationPeriod() const{ return m_indexRotationPeriod; } /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline bool IndexRotationPeriodHasBeenSet() const { return m_indexRotationPeriodHasBeenSet; } /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline void SetIndexRotationPeriod(const AmazonopensearchserviceIndexRotationPeriod& value) { m_indexRotationPeriodHasBeenSet = true; m_indexRotationPeriod = value; } /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline void SetIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod&& value) { m_indexRotationPeriodHasBeenSet = true; m_indexRotationPeriod = std::move(value); } /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline AmazonopensearchserviceDestinationUpdate& WithIndexRotationPeriod(const AmazonopensearchserviceIndexRotationPeriod& value) { SetIndexRotationPeriod(value); return *this;} /** *

The Amazon OpenSearch Service index rotation period. Index rotation appends a * timestamp to IndexName to facilitate the expiration of old data.

*/ inline AmazonopensearchserviceDestinationUpdate& WithIndexRotationPeriod(AmazonopensearchserviceIndexRotationPeriod&& value) { SetIndexRotationPeriod(std::move(value)); return *this;} /** *

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

*/ inline const AmazonopensearchserviceBufferingHints& GetBufferingHints() const{ return m_bufferingHints; } /** *

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

*/ inline bool BufferingHintsHasBeenSet() const { return m_bufferingHintsHasBeenSet; } /** *

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

*/ inline void SetBufferingHints(const AmazonopensearchserviceBufferingHints& value) { m_bufferingHintsHasBeenSet = true; m_bufferingHints = value; } /** *

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

*/ inline void SetBufferingHints(AmazonopensearchserviceBufferingHints&& value) { m_bufferingHintsHasBeenSet = true; m_bufferingHints = std::move(value); } /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithBufferingHints(const AmazonopensearchserviceBufferingHints& value) { SetBufferingHints(value); return *this;} /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithBufferingHints(AmazonopensearchserviceBufferingHints&& value) { SetBufferingHints(std::move(value)); return *this;} /** *

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

*/ inline const AmazonopensearchserviceRetryOptions& GetRetryOptions() const{ return m_retryOptions; } /** *

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

*/ inline bool RetryOptionsHasBeenSet() const { return m_retryOptionsHasBeenSet; } /** *

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

*/ inline void SetRetryOptions(const AmazonopensearchserviceRetryOptions& value) { m_retryOptionsHasBeenSet = true; m_retryOptions = value; } /** *

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

*/ inline void SetRetryOptions(AmazonopensearchserviceRetryOptions&& value) { m_retryOptionsHasBeenSet = true; m_retryOptions = std::move(value); } /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithRetryOptions(const AmazonopensearchserviceRetryOptions& value) { SetRetryOptions(value); return *this;} /** *

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

*/ inline AmazonopensearchserviceDestinationUpdate& WithRetryOptions(AmazonopensearchserviceRetryOptions&& value) { SetRetryOptions(std::move(value)); return *this;} inline const S3DestinationUpdate& GetS3Update() const{ return m_s3Update; } inline bool S3UpdateHasBeenSet() const { return m_s3UpdateHasBeenSet; } inline void SetS3Update(const S3DestinationUpdate& value) { m_s3UpdateHasBeenSet = true; m_s3Update = value; } inline void SetS3Update(S3DestinationUpdate&& value) { m_s3UpdateHasBeenSet = true; m_s3Update = std::move(value); } inline AmazonopensearchserviceDestinationUpdate& WithS3Update(const S3DestinationUpdate& value) { SetS3Update(value); return *this;} inline AmazonopensearchserviceDestinationUpdate& WithS3Update(S3DestinationUpdate&& value) { SetS3Update(std::move(value)); return *this;} inline const ProcessingConfiguration& GetProcessingConfiguration() const{ return m_processingConfiguration; } inline bool ProcessingConfigurationHasBeenSet() const { return m_processingConfigurationHasBeenSet; } inline void SetProcessingConfiguration(const ProcessingConfiguration& value) { m_processingConfigurationHasBeenSet = true; m_processingConfiguration = value; } inline void SetProcessingConfiguration(ProcessingConfiguration&& value) { m_processingConfigurationHasBeenSet = true; m_processingConfiguration = std::move(value); } inline AmazonopensearchserviceDestinationUpdate& WithProcessingConfiguration(const ProcessingConfiguration& value) { SetProcessingConfiguration(value); return *this;} inline AmazonopensearchserviceDestinationUpdate& WithProcessingConfiguration(ProcessingConfiguration&& value) { SetProcessingConfiguration(std::move(value)); return *this;} inline const CloudWatchLoggingOptions& GetCloudWatchLoggingOptions() const{ return m_cloudWatchLoggingOptions; } inline bool CloudWatchLoggingOptionsHasBeenSet() const { return m_cloudWatchLoggingOptionsHasBeenSet; } inline void SetCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = value; } inline void SetCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = std::move(value); } inline AmazonopensearchserviceDestinationUpdate& WithCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { SetCloudWatchLoggingOptions(value); return *this;} inline AmazonopensearchserviceDestinationUpdate& WithCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { SetCloudWatchLoggingOptions(std::move(value)); return *this;} private: Aws::String m_roleARN; bool m_roleARNHasBeenSet = false; Aws::String m_domainARN; bool m_domainARNHasBeenSet = false; Aws::String m_clusterEndpoint; bool m_clusterEndpointHasBeenSet = false; Aws::String m_indexName; bool m_indexNameHasBeenSet = false; Aws::String m_typeName; bool m_typeNameHasBeenSet = false; AmazonopensearchserviceIndexRotationPeriod m_indexRotationPeriod; bool m_indexRotationPeriodHasBeenSet = false; AmazonopensearchserviceBufferingHints m_bufferingHints; bool m_bufferingHintsHasBeenSet = false; AmazonopensearchserviceRetryOptions m_retryOptions; bool m_retryOptionsHasBeenSet = false; S3DestinationUpdate m_s3Update; bool m_s3UpdateHasBeenSet = false; ProcessingConfiguration m_processingConfiguration; bool m_processingConfigurationHasBeenSet = false; CloudWatchLoggingOptions m_cloudWatchLoggingOptions; bool m_cloudWatchLoggingOptionsHasBeenSet = false; }; } // namespace Model } // namespace Firehose } // namespace Aws