This repository has been archived on 2025-09-14. You can view files and clone it, but cannot push or open issues or pull requests.
Files
pxz-hos-client-cpp-module/support/aws-sdk-cpp-master/aws-cpp-sdk-firehose/include/aws/firehose/model/RedshiftDestinationConfiguration.h

544 lines
22 KiB
C++

/**
* Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
* SPDX-License-Identifier: Apache-2.0.
*/
#pragma once
#include <aws/firehose/Firehose_EXPORTS.h>
#include <aws/core/utils/memory/stl/AWSString.h>
#include <aws/firehose/model/CopyCommand.h>
#include <aws/firehose/model/RedshiftRetryOptions.h>
#include <aws/firehose/model/S3DestinationConfiguration.h>
#include <aws/firehose/model/ProcessingConfiguration.h>
#include <aws/firehose/model/RedshiftS3BackupMode.h>
#include <aws/firehose/model/CloudWatchLoggingOptions.h>
#include <utility>
namespace Aws
{
namespace Utils
{
namespace Json
{
class JsonValue;
class JsonView;
} // namespace Json
} // namespace Utils
namespace Firehose
{
namespace Model
{
/**
* <p>Describes the configuration of a destination in Amazon
* Redshift.</p><p><h3>See Also:</h3> <a
* href="http://docs.aws.amazon.com/goto/WebAPI/firehose-2015-08-04/RedshiftDestinationConfiguration">AWS
* API Reference</a></p>
*/
class AWS_FIREHOSE_API RedshiftDestinationConfiguration
{
public:
RedshiftDestinationConfiguration();
RedshiftDestinationConfiguration(Aws::Utils::Json::JsonView jsonValue);
RedshiftDestinationConfiguration& operator=(Aws::Utils::Json::JsonView jsonValue);
Aws::Utils::Json::JsonValue Jsonize() const;
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline const Aws::String& GetRoleARN() const{ return m_roleARN; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline bool RoleARNHasBeenSet() const { return m_roleARNHasBeenSet; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetRoleARN(const Aws::String& value) { m_roleARNHasBeenSet = true; m_roleARN = value; }
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetRoleARN(Aws::String&& value) { m_roleARNHasBeenSet = true; m_roleARN = std::move(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline void SetRoleARN(const char* value) { m_roleARNHasBeenSet = true; m_roleARN.assign(value); }
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline RedshiftDestinationConfiguration& WithRoleARN(const Aws::String& value) { SetRoleARN(value); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline RedshiftDestinationConfiguration& WithRoleARN(Aws::String&& value) { SetRoleARN(std::move(value)); return *this;}
/**
* <p>The Amazon Resource Name (ARN) of the AWS credentials. For more information,
* see <a
* href="https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html">Amazon
* Resource Names (ARNs) and AWS Service Namespaces</a>.</p>
*/
inline RedshiftDestinationConfiguration& WithRoleARN(const char* value) { SetRoleARN(value); return *this;}
/**
* <p>The database connection string.</p>
*/
inline const Aws::String& GetClusterJDBCURL() const{ return m_clusterJDBCURL; }
/**
* <p>The database connection string.</p>
*/
inline bool ClusterJDBCURLHasBeenSet() const { return m_clusterJDBCURLHasBeenSet; }
/**
* <p>The database connection string.</p>
*/
inline void SetClusterJDBCURL(const Aws::String& value) { m_clusterJDBCURLHasBeenSet = true; m_clusterJDBCURL = value; }
/**
* <p>The database connection string.</p>
*/
inline void SetClusterJDBCURL(Aws::String&& value) { m_clusterJDBCURLHasBeenSet = true; m_clusterJDBCURL = std::move(value); }
/**
* <p>The database connection string.</p>
*/
inline void SetClusterJDBCURL(const char* value) { m_clusterJDBCURLHasBeenSet = true; m_clusterJDBCURL.assign(value); }
/**
* <p>The database connection string.</p>
*/
inline RedshiftDestinationConfiguration& WithClusterJDBCURL(const Aws::String& value) { SetClusterJDBCURL(value); return *this;}
/**
* <p>The database connection string.</p>
*/
inline RedshiftDestinationConfiguration& WithClusterJDBCURL(Aws::String&& value) { SetClusterJDBCURL(std::move(value)); return *this;}
/**
* <p>The database connection string.</p>
*/
inline RedshiftDestinationConfiguration& WithClusterJDBCURL(const char* value) { SetClusterJDBCURL(value); return *this;}
/**
* <p>The <code>COPY</code> command.</p>
*/
inline const CopyCommand& GetCopyCommand() const{ return m_copyCommand; }
/**
* <p>The <code>COPY</code> command.</p>
*/
inline bool CopyCommandHasBeenSet() const { return m_copyCommandHasBeenSet; }
/**
* <p>The <code>COPY</code> command.</p>
*/
inline void SetCopyCommand(const CopyCommand& value) { m_copyCommandHasBeenSet = true; m_copyCommand = value; }
/**
* <p>The <code>COPY</code> command.</p>
*/
inline void SetCopyCommand(CopyCommand&& value) { m_copyCommandHasBeenSet = true; m_copyCommand = std::move(value); }
/**
* <p>The <code>COPY</code> command.</p>
*/
inline RedshiftDestinationConfiguration& WithCopyCommand(const CopyCommand& value) { SetCopyCommand(value); return *this;}
/**
* <p>The <code>COPY</code> command.</p>
*/
inline RedshiftDestinationConfiguration& WithCopyCommand(CopyCommand&& value) { SetCopyCommand(std::move(value)); return *this;}
/**
* <p>The name of the user.</p>
*/
inline const Aws::String& GetUsername() const{ return m_username; }
/**
* <p>The name of the user.</p>
*/
inline bool UsernameHasBeenSet() const { return m_usernameHasBeenSet; }
/**
* <p>The name of the user.</p>
*/
inline void SetUsername(const Aws::String& value) { m_usernameHasBeenSet = true; m_username = value; }
/**
* <p>The name of the user.</p>
*/
inline void SetUsername(Aws::String&& value) { m_usernameHasBeenSet = true; m_username = std::move(value); }
/**
* <p>The name of the user.</p>
*/
inline void SetUsername(const char* value) { m_usernameHasBeenSet = true; m_username.assign(value); }
/**
* <p>The name of the user.</p>
*/
inline RedshiftDestinationConfiguration& WithUsername(const Aws::String& value) { SetUsername(value); return *this;}
/**
* <p>The name of the user.</p>
*/
inline RedshiftDestinationConfiguration& WithUsername(Aws::String&& value) { SetUsername(std::move(value)); return *this;}
/**
* <p>The name of the user.</p>
*/
inline RedshiftDestinationConfiguration& WithUsername(const char* value) { SetUsername(value); return *this;}
/**
* <p>The user password.</p>
*/
inline const Aws::String& GetPassword() const{ return m_password; }
/**
* <p>The user password.</p>
*/
inline bool PasswordHasBeenSet() const { return m_passwordHasBeenSet; }
/**
* <p>The user password.</p>
*/
inline void SetPassword(const Aws::String& value) { m_passwordHasBeenSet = true; m_password = value; }
/**
* <p>The user password.</p>
*/
inline void SetPassword(Aws::String&& value) { m_passwordHasBeenSet = true; m_password = std::move(value); }
/**
* <p>The user password.</p>
*/
inline void SetPassword(const char* value) { m_passwordHasBeenSet = true; m_password.assign(value); }
/**
* <p>The user password.</p>
*/
inline RedshiftDestinationConfiguration& WithPassword(const Aws::String& value) { SetPassword(value); return *this;}
/**
* <p>The user password.</p>
*/
inline RedshiftDestinationConfiguration& WithPassword(Aws::String&& value) { SetPassword(std::move(value)); return *this;}
/**
* <p>The user password.</p>
*/
inline RedshiftDestinationConfiguration& WithPassword(const char* value) { SetPassword(value); return *this;}
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline const RedshiftRetryOptions& GetRetryOptions() const{ return m_retryOptions; }
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline bool RetryOptionsHasBeenSet() const { return m_retryOptionsHasBeenSet; }
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline void SetRetryOptions(const RedshiftRetryOptions& value) { m_retryOptionsHasBeenSet = true; m_retryOptions = value; }
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline void SetRetryOptions(RedshiftRetryOptions&& value) { m_retryOptionsHasBeenSet = true; m_retryOptions = std::move(value); }
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline RedshiftDestinationConfiguration& WithRetryOptions(const RedshiftRetryOptions& value) { SetRetryOptions(value); return *this;}
/**
* <p>The retry behavior in case Kinesis Data Firehose is unable to deliver
* documents to Amazon Redshift. Default value is 3600 (60 minutes).</p>
*/
inline RedshiftDestinationConfiguration& WithRetryOptions(RedshiftRetryOptions&& value) { SetRetryOptions(std::move(value)); return *this;}
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline const S3DestinationConfiguration& GetS3Configuration() const{ return m_s3Configuration; }
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline bool S3ConfigurationHasBeenSet() const { return m_s3ConfigurationHasBeenSet; }
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline void SetS3Configuration(const S3DestinationConfiguration& value) { m_s3ConfigurationHasBeenSet = true; m_s3Configuration = value; }
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline void SetS3Configuration(S3DestinationConfiguration&& value) { m_s3ConfigurationHasBeenSet = true; m_s3Configuration = std::move(value); }
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline RedshiftDestinationConfiguration& WithS3Configuration(const S3DestinationConfiguration& value) { SetS3Configuration(value); return *this;}
/**
* <p>The configuration for the intermediate Amazon S3 location from which Amazon
* Redshift obtains data. Restrictions are described in the topic for
* <a>CreateDeliveryStream</a>.</p> <p>The compression formats <code>SNAPPY</code>
* or <code>ZIP</code> cannot be specified in
* <code>RedshiftDestinationConfiguration.S3Configuration</code> because the Amazon
* Redshift <code>COPY</code> operation that reads from the S3 bucket doesn't
* support these compression formats.</p>
*/
inline RedshiftDestinationConfiguration& WithS3Configuration(S3DestinationConfiguration&& value) { SetS3Configuration(std::move(value)); return *this;}
/**
* <p>The data processing configuration.</p>
*/
inline const ProcessingConfiguration& GetProcessingConfiguration() const{ return m_processingConfiguration; }
/**
* <p>The data processing configuration.</p>
*/
inline bool ProcessingConfigurationHasBeenSet() const { return m_processingConfigurationHasBeenSet; }
/**
* <p>The data processing configuration.</p>
*/
inline void SetProcessingConfiguration(const ProcessingConfiguration& value) { m_processingConfigurationHasBeenSet = true; m_processingConfiguration = value; }
/**
* <p>The data processing configuration.</p>
*/
inline void SetProcessingConfiguration(ProcessingConfiguration&& value) { m_processingConfigurationHasBeenSet = true; m_processingConfiguration = std::move(value); }
/**
* <p>The data processing configuration.</p>
*/
inline RedshiftDestinationConfiguration& WithProcessingConfiguration(const ProcessingConfiguration& value) { SetProcessingConfiguration(value); return *this;}
/**
* <p>The data processing configuration.</p>
*/
inline RedshiftDestinationConfiguration& WithProcessingConfiguration(ProcessingConfiguration&& value) { SetProcessingConfiguration(std::move(value)); return *this;}
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline const RedshiftS3BackupMode& GetS3BackupMode() const{ return m_s3BackupMode; }
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline bool S3BackupModeHasBeenSet() const { return m_s3BackupModeHasBeenSet; }
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline void SetS3BackupMode(const RedshiftS3BackupMode& value) { m_s3BackupModeHasBeenSet = true; m_s3BackupMode = value; }
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline void SetS3BackupMode(RedshiftS3BackupMode&& value) { m_s3BackupModeHasBeenSet = true; m_s3BackupMode = std::move(value); }
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline RedshiftDestinationConfiguration& WithS3BackupMode(const RedshiftS3BackupMode& value) { SetS3BackupMode(value); return *this;}
/**
* <p>The Amazon S3 backup mode. After you create a delivery stream, you can update
* it to enable Amazon S3 backup if it is disabled. If backup is enabled, you can't
* update the delivery stream to disable it. </p>
*/
inline RedshiftDestinationConfiguration& WithS3BackupMode(RedshiftS3BackupMode&& value) { SetS3BackupMode(std::move(value)); return *this;}
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline const S3DestinationConfiguration& GetS3BackupConfiguration() const{ return m_s3BackupConfiguration; }
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline bool S3BackupConfigurationHasBeenSet() const { return m_s3BackupConfigurationHasBeenSet; }
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline void SetS3BackupConfiguration(const S3DestinationConfiguration& value) { m_s3BackupConfigurationHasBeenSet = true; m_s3BackupConfiguration = value; }
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline void SetS3BackupConfiguration(S3DestinationConfiguration&& value) { m_s3BackupConfigurationHasBeenSet = true; m_s3BackupConfiguration = std::move(value); }
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline RedshiftDestinationConfiguration& WithS3BackupConfiguration(const S3DestinationConfiguration& value) { SetS3BackupConfiguration(value); return *this;}
/**
* <p>The configuration for backup in Amazon S3.</p>
*/
inline RedshiftDestinationConfiguration& WithS3BackupConfiguration(S3DestinationConfiguration&& value) { SetS3BackupConfiguration(std::move(value)); return *this;}
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline const CloudWatchLoggingOptions& GetCloudWatchLoggingOptions() const{ return m_cloudWatchLoggingOptions; }
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline bool CloudWatchLoggingOptionsHasBeenSet() const { return m_cloudWatchLoggingOptionsHasBeenSet; }
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline void SetCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = value; }
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline void SetCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = std::move(value); }
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline RedshiftDestinationConfiguration& WithCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { SetCloudWatchLoggingOptions(value); return *this;}
/**
* <p>The CloudWatch logging options for your delivery stream.</p>
*/
inline RedshiftDestinationConfiguration& WithCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { SetCloudWatchLoggingOptions(std::move(value)); return *this;}
private:
Aws::String m_roleARN;
bool m_roleARNHasBeenSet;
Aws::String m_clusterJDBCURL;
bool m_clusterJDBCURLHasBeenSet;
CopyCommand m_copyCommand;
bool m_copyCommandHasBeenSet;
Aws::String m_username;
bool m_usernameHasBeenSet;
Aws::String m_password;
bool m_passwordHasBeenSet;
RedshiftRetryOptions m_retryOptions;
bool m_retryOptionsHasBeenSet;
S3DestinationConfiguration m_s3Configuration;
bool m_s3ConfigurationHasBeenSet;
ProcessingConfiguration m_processingConfiguration;
bool m_processingConfigurationHasBeenSet;
RedshiftS3BackupMode m_s3BackupMode;
bool m_s3BackupModeHasBeenSet;
S3DestinationConfiguration m_s3BackupConfiguration;
bool m_s3BackupConfigurationHasBeenSet;
CloudWatchLoggingOptions m_cloudWatchLoggingOptions;
bool m_cloudWatchLoggingOptionsHasBeenSet;
};
} // namespace Model
} // namespace Firehose
} // namespace Aws