/** * 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 namespace Aws { namespace Utils { namespace Json { class JsonValue; class JsonView; } // namespace Json } // namespace Utils namespace Firehose { namespace Model { /** *

Describes the configuration of a destination in Amazon S3.

See * Also:

AWS * API Reference

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The Amazon Resource Name (ARN) of the AWS credentials. For more information, * see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

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

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline const Aws::String& GetBucketARN() const{ return m_bucketARN; } /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline bool BucketARNHasBeenSet() const { return m_bucketARNHasBeenSet; } /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline void SetBucketARN(const Aws::String& value) { m_bucketARNHasBeenSet = true; m_bucketARN = value; } /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline void SetBucketARN(Aws::String&& value) { m_bucketARNHasBeenSet = true; m_bucketARN = std::move(value); } /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline void SetBucketARN(const char* value) { m_bucketARNHasBeenSet = true; m_bucketARN.assign(value); } /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline S3DestinationConfiguration& WithBucketARN(const Aws::String& value) { SetBucketARN(value); return *this;} /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline S3DestinationConfiguration& WithBucketARN(Aws::String&& value) { SetBucketARN(std::move(value)); return *this;} /** *

The ARN of the S3 bucket. For more information, see Amazon * Resource Names (ARNs) and AWS Service Namespaces.

*/ inline S3DestinationConfiguration& WithBucketARN(const char* value) { SetBucketARN(value); return *this;} /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline const Aws::String& GetPrefix() const{ return m_prefix; } /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline bool PrefixHasBeenSet() const { return m_prefixHasBeenSet; } /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetPrefix(const Aws::String& value) { m_prefixHasBeenSet = true; m_prefix = value; } /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetPrefix(Aws::String&& value) { m_prefixHasBeenSet = true; m_prefix = std::move(value); } /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetPrefix(const char* value) { m_prefixHasBeenSet = true; m_prefix.assign(value); } /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithPrefix(const Aws::String& value) { SetPrefix(value); return *this;} /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithPrefix(Aws::String&& value) { SetPrefix(std::move(value)); return *this;} /** *

The "YYYY/MM/DD/HH" time format prefix is automatically used for delivered * Amazon S3 files. You can also specify a custom prefix, as described in Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithPrefix(const char* value) { SetPrefix(value); return *this;} /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline const Aws::String& GetErrorOutputPrefix() const{ return m_errorOutputPrefix; } /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline bool ErrorOutputPrefixHasBeenSet() const { return m_errorOutputPrefixHasBeenSet; } /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetErrorOutputPrefix(const Aws::String& value) { m_errorOutputPrefixHasBeenSet = true; m_errorOutputPrefix = value; } /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetErrorOutputPrefix(Aws::String&& value) { m_errorOutputPrefixHasBeenSet = true; m_errorOutputPrefix = std::move(value); } /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline void SetErrorOutputPrefix(const char* value) { m_errorOutputPrefixHasBeenSet = true; m_errorOutputPrefix.assign(value); } /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithErrorOutputPrefix(const Aws::String& value) { SetErrorOutputPrefix(value); return *this;} /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithErrorOutputPrefix(Aws::String&& value) { SetErrorOutputPrefix(std::move(value)); return *this;} /** *

A prefix that Kinesis Data Firehose evaluates and adds to failed records * before writing them to S3. This prefix appears immediately following the bucket * name. For information about how to specify this prefix, see Custom * Prefixes for Amazon S3 Objects.

*/ inline S3DestinationConfiguration& WithErrorOutputPrefix(const char* value) { SetErrorOutputPrefix(value); return *this;} /** *

The buffering option. If no value is specified, BufferingHints * object default values are used.

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

The buffering option. If no value is specified, BufferingHints * object default values are used.

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

The buffering option. If no value is specified, BufferingHints * object default values are used.

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

The buffering option. If no value is specified, BufferingHints * object default values are used.

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

The buffering option. If no value is specified, BufferingHints * object default values are used.

*/ inline S3DestinationConfiguration& WithBufferingHints(const BufferingHints& value) { SetBufferingHints(value); return *this;} /** *

The buffering option. If no value is specified, BufferingHints * object default values are used.

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

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline const CompressionFormat& GetCompressionFormat() const{ return m_compressionFormat; } /** *

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline bool CompressionFormatHasBeenSet() const { return m_compressionFormatHasBeenSet; } /** *

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline void SetCompressionFormat(const CompressionFormat& value) { m_compressionFormatHasBeenSet = true; m_compressionFormat = value; } /** *

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline void SetCompressionFormat(CompressionFormat&& value) { m_compressionFormatHasBeenSet = true; m_compressionFormat = std::move(value); } /** *

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline S3DestinationConfiguration& WithCompressionFormat(const CompressionFormat& value) { SetCompressionFormat(value); return *this;} /** *

The compression format. If no value is specified, the default is * UNCOMPRESSED.

The compression formats SNAPPY or * ZIP cannot be specified for Amazon Redshift destinations because * they are not supported by the Amazon Redshift COPY operation that * reads from the S3 bucket.

*/ inline S3DestinationConfiguration& WithCompressionFormat(CompressionFormat&& value) { SetCompressionFormat(std::move(value)); return *this;} /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline const EncryptionConfiguration& GetEncryptionConfiguration() const{ return m_encryptionConfiguration; } /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline bool EncryptionConfigurationHasBeenSet() const { return m_encryptionConfigurationHasBeenSet; } /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline void SetEncryptionConfiguration(const EncryptionConfiguration& value) { m_encryptionConfigurationHasBeenSet = true; m_encryptionConfiguration = value; } /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline void SetEncryptionConfiguration(EncryptionConfiguration&& value) { m_encryptionConfigurationHasBeenSet = true; m_encryptionConfiguration = std::move(value); } /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline S3DestinationConfiguration& WithEncryptionConfiguration(const EncryptionConfiguration& value) { SetEncryptionConfiguration(value); return *this;} /** *

The encryption configuration. If no value is specified, the default is no * encryption.

*/ inline S3DestinationConfiguration& WithEncryptionConfiguration(EncryptionConfiguration&& value) { SetEncryptionConfiguration(std::move(value)); return *this;} /** *

The CloudWatch logging options for your delivery stream.

*/ inline const CloudWatchLoggingOptions& GetCloudWatchLoggingOptions() const{ return m_cloudWatchLoggingOptions; } /** *

The CloudWatch logging options for your delivery stream.

*/ inline bool CloudWatchLoggingOptionsHasBeenSet() const { return m_cloudWatchLoggingOptionsHasBeenSet; } /** *

The CloudWatch logging options for your delivery stream.

*/ inline void SetCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = value; } /** *

The CloudWatch logging options for your delivery stream.

*/ inline void SetCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { m_cloudWatchLoggingOptionsHasBeenSet = true; m_cloudWatchLoggingOptions = std::move(value); } /** *

The CloudWatch logging options for your delivery stream.

*/ inline S3DestinationConfiguration& WithCloudWatchLoggingOptions(const CloudWatchLoggingOptions& value) { SetCloudWatchLoggingOptions(value); return *this;} /** *

The CloudWatch logging options for your delivery stream.

*/ inline S3DestinationConfiguration& WithCloudWatchLoggingOptions(CloudWatchLoggingOptions&& value) { SetCloudWatchLoggingOptions(std::move(value)); return *this;} private: Aws::String m_roleARN; bool m_roleARNHasBeenSet; Aws::String m_bucketARN; bool m_bucketARNHasBeenSet; Aws::String m_prefix; bool m_prefixHasBeenSet; Aws::String m_errorOutputPrefix; bool m_errorOutputPrefixHasBeenSet; BufferingHints m_bufferingHints; bool m_bufferingHintsHasBeenSet; CompressionFormat m_compressionFormat; bool m_compressionFormatHasBeenSet; EncryptionConfiguration m_encryptionConfiguration; bool m_encryptionConfigurationHasBeenSet; CloudWatchLoggingOptions m_cloudWatchLoggingOptions; bool m_cloudWatchLoggingOptionsHasBeenSet; }; } // namespace Model } // namespace Firehose } // namespace Aws