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

#include <S3DestinationDescription.h>

Public Member Functions

 S3DestinationDescription ()
 
 S3DestinationDescription (Aws::Utils::Json::JsonView jsonValue)
 
S3DestinationDescriptionoperator= (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)
 
S3DestinationDescriptionWithRoleARN (const Aws::String &value)
 
S3DestinationDescriptionWithRoleARN (Aws::String &&value)
 
S3DestinationDescriptionWithRoleARN (const char *value)
 
const Aws::StringGetBucketARN () const
 
bool BucketARNHasBeenSet () const
 
void SetBucketARN (const Aws::String &value)
 
void SetBucketARN (Aws::String &&value)
 
void SetBucketARN (const char *value)
 
S3DestinationDescriptionWithBucketARN (const Aws::String &value)
 
S3DestinationDescriptionWithBucketARN (Aws::String &&value)
 
S3DestinationDescriptionWithBucketARN (const char *value)
 
const Aws::StringGetPrefix () const
 
bool PrefixHasBeenSet () const
 
void SetPrefix (const Aws::String &value)
 
void SetPrefix (Aws::String &&value)
 
void SetPrefix (const char *value)
 
S3DestinationDescriptionWithPrefix (const Aws::String &value)
 
S3DestinationDescriptionWithPrefix (Aws::String &&value)
 
S3DestinationDescriptionWithPrefix (const char *value)
 
const Aws::StringGetErrorOutputPrefix () const
 
bool ErrorOutputPrefixHasBeenSet () const
 
void SetErrorOutputPrefix (const Aws::String &value)
 
void SetErrorOutputPrefix (Aws::String &&value)
 
void SetErrorOutputPrefix (const char *value)
 
S3DestinationDescriptionWithErrorOutputPrefix (const Aws::String &value)
 
S3DestinationDescriptionWithErrorOutputPrefix (Aws::String &&value)
 
S3DestinationDescriptionWithErrorOutputPrefix (const char *value)
 
const BufferingHintsGetBufferingHints () const
 
bool BufferingHintsHasBeenSet () const
 
void SetBufferingHints (const BufferingHints &value)
 
void SetBufferingHints (BufferingHints &&value)
 
S3DestinationDescriptionWithBufferingHints (const BufferingHints &value)
 
S3DestinationDescriptionWithBufferingHints (BufferingHints &&value)
 
const CompressionFormatGetCompressionFormat () const
 
bool CompressionFormatHasBeenSet () const
 
void SetCompressionFormat (const CompressionFormat &value)
 
void SetCompressionFormat (CompressionFormat &&value)
 
S3DestinationDescriptionWithCompressionFormat (const CompressionFormat &value)
 
S3DestinationDescriptionWithCompressionFormat (CompressionFormat &&value)
 
const EncryptionConfigurationGetEncryptionConfiguration () const
 
bool EncryptionConfigurationHasBeenSet () const
 
void SetEncryptionConfiguration (const EncryptionConfiguration &value)
 
void SetEncryptionConfiguration (EncryptionConfiguration &&value)
 
S3DestinationDescriptionWithEncryptionConfiguration (const EncryptionConfiguration &value)
 
S3DestinationDescriptionWithEncryptionConfiguration (EncryptionConfiguration &&value)
 
const CloudWatchLoggingOptionsGetCloudWatchLoggingOptions () const
 
bool CloudWatchLoggingOptionsHasBeenSet () const
 
void SetCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
void SetCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 
S3DestinationDescriptionWithCloudWatchLoggingOptions (const CloudWatchLoggingOptions &value)
 
S3DestinationDescriptionWithCloudWatchLoggingOptions (CloudWatchLoggingOptions &&value)
 

Detailed Description

Describes a destination in Amazon S3.

See Also:

AWS API Reference

Definition at line 35 of file S3DestinationDescription.h.

Constructor & Destructor Documentation

◆ S3DestinationDescription() [1/2]

Aws::Firehose::Model::S3DestinationDescription::S3DestinationDescription ( )

◆ S3DestinationDescription() [2/2]

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

Member Function Documentation

◆ BucketARNHasBeenSet()

bool Aws::Firehose::Model::S3DestinationDescription::BucketARNHasBeenSet ( ) const
inline

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

Definition at line 121 of file S3DestinationDescription.h.

◆ BufferingHintsHasBeenSet()

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

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

Definition at line 314 of file S3DestinationDescription.h.

◆ CloudWatchLoggingOptionsHasBeenSet()

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 423 of file S3DestinationDescription.h.

◆ CompressionFormatHasBeenSet()

bool Aws::Firehose::Model::S3DestinationDescription::CompressionFormatHasBeenSet ( ) const
inline

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

Definition at line 351 of file S3DestinationDescription.h.

◆ EncryptionConfigurationHasBeenSet()

bool Aws::Firehose::Model::S3DestinationDescription::EncryptionConfigurationHasBeenSet ( ) const
inline

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

Definition at line 388 of file S3DestinationDescription.h.

◆ ErrorOutputPrefixHasBeenSet()

bool Aws::Firehose::Model::S3DestinationDescription::ErrorOutputPrefixHasBeenSet ( ) const
inline

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.

Definition at line 247 of file S3DestinationDescription.h.

◆ GetBucketARN()

const Aws::String& Aws::Firehose::Model::S3DestinationDescription::GetBucketARN ( ) const
inline

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

Definition at line 114 of file S3DestinationDescription.h.

◆ GetBufferingHints()

const BufferingHints& Aws::Firehose::Model::S3DestinationDescription::GetBufferingHints ( ) const
inline

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

Definition at line 308 of file S3DestinationDescription.h.

◆ GetCloudWatchLoggingOptions()

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 418 of file S3DestinationDescription.h.

◆ GetCompressionFormat()

const CompressionFormat& Aws::Firehose::Model::S3DestinationDescription::GetCompressionFormat ( ) const
inline

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

Definition at line 345 of file S3DestinationDescription.h.

◆ GetEncryptionConfiguration()

const EncryptionConfiguration& Aws::Firehose::Model::S3DestinationDescription::GetEncryptionConfiguration ( ) const
inline

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

Definition at line 382 of file S3DestinationDescription.h.

◆ GetErrorOutputPrefix()

const Aws::String& Aws::Firehose::Model::S3DestinationDescription::GetErrorOutputPrefix ( ) const
inline

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.

Definition at line 238 of file S3DestinationDescription.h.

◆ GetPrefix()

const Aws::String& Aws::Firehose::Model::S3DestinationDescription::GetPrefix ( ) const
inline

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.

Definition at line 172 of file S3DestinationDescription.h.

◆ GetRoleARN()

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

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

Definition at line 50 of file S3DestinationDescription.h.

◆ Jsonize()

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

◆ operator=()

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

◆ PrefixHasBeenSet()

bool Aws::Firehose::Model::S3DestinationDescription::PrefixHasBeenSet ( ) const
inline

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.

Definition at line 180 of file S3DestinationDescription.h.

◆ RoleARNHasBeenSet()

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

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

Definition at line 58 of file S3DestinationDescription.h.

◆ SetBucketARN() [1/3]

void Aws::Firehose::Model::S3DestinationDescription::SetBucketARN ( const Aws::String value)
inline

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

Definition at line 128 of file S3DestinationDescription.h.

◆ SetBucketARN() [2/3]

void Aws::Firehose::Model::S3DestinationDescription::SetBucketARN ( Aws::String &&  value)
inline

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

Definition at line 135 of file S3DestinationDescription.h.

◆ SetBucketARN() [3/3]

void Aws::Firehose::Model::S3DestinationDescription::SetBucketARN ( const char *  value)
inline

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

Definition at line 142 of file S3DestinationDescription.h.

◆ SetBufferingHints() [1/2]

void Aws::Firehose::Model::S3DestinationDescription::SetBufferingHints ( const BufferingHints value)
inline

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

Definition at line 320 of file S3DestinationDescription.h.

◆ SetBufferingHints() [2/2]

void Aws::Firehose::Model::S3DestinationDescription::SetBufferingHints ( BufferingHints &&  value)
inline

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

Definition at line 326 of file S3DestinationDescription.h.

◆ SetCloudWatchLoggingOptions() [1/2]

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 428 of file S3DestinationDescription.h.

◆ SetCloudWatchLoggingOptions() [2/2]

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 433 of file S3DestinationDescription.h.

◆ SetCompressionFormat() [1/2]

void Aws::Firehose::Model::S3DestinationDescription::SetCompressionFormat ( const CompressionFormat value)
inline

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

Definition at line 357 of file S3DestinationDescription.h.

◆ SetCompressionFormat() [2/2]

void Aws::Firehose::Model::S3DestinationDescription::SetCompressionFormat ( CompressionFormat &&  value)
inline

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

Definition at line 363 of file S3DestinationDescription.h.

◆ SetEncryptionConfiguration() [1/2]

void Aws::Firehose::Model::S3DestinationDescription::SetEncryptionConfiguration ( const EncryptionConfiguration value)
inline

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

Definition at line 394 of file S3DestinationDescription.h.

◆ SetEncryptionConfiguration() [2/2]

void Aws::Firehose::Model::S3DestinationDescription::SetEncryptionConfiguration ( EncryptionConfiguration &&  value)
inline

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

Definition at line 400 of file S3DestinationDescription.h.

◆ SetErrorOutputPrefix() [1/3]

void Aws::Firehose::Model::S3DestinationDescription::SetErrorOutputPrefix ( const Aws::String value)
inline

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.

Definition at line 256 of file S3DestinationDescription.h.

◆ SetErrorOutputPrefix() [2/3]

void Aws::Firehose::Model::S3DestinationDescription::SetErrorOutputPrefix ( Aws::String &&  value)
inline

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.

Definition at line 265 of file S3DestinationDescription.h.

◆ SetErrorOutputPrefix() [3/3]

void Aws::Firehose::Model::S3DestinationDescription::SetErrorOutputPrefix ( const char *  value)
inline

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.

Definition at line 274 of file S3DestinationDescription.h.

◆ SetPrefix() [1/3]

void Aws::Firehose::Model::S3DestinationDescription::SetPrefix ( const Aws::String value)
inline

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.

Definition at line 188 of file S3DestinationDescription.h.

◆ SetPrefix() [2/3]

void Aws::Firehose::Model::S3DestinationDescription::SetPrefix ( Aws::String &&  value)
inline

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.

Definition at line 196 of file S3DestinationDescription.h.

◆ SetPrefix() [3/3]

void Aws::Firehose::Model::S3DestinationDescription::SetPrefix ( const char *  value)
inline

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.

Definition at line 204 of file S3DestinationDescription.h.

◆ SetRoleARN() [1/3]

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

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

Definition at line 66 of file S3DestinationDescription.h.

◆ SetRoleARN() [2/3]

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

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

Definition at line 74 of file S3DestinationDescription.h.

◆ SetRoleARN() [3/3]

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

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

Definition at line 82 of file S3DestinationDescription.h.

◆ WithBucketARN() [1/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithBucketARN ( const Aws::String value)
inline

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

Definition at line 149 of file S3DestinationDescription.h.

◆ WithBucketARN() [2/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithBucketARN ( Aws::String &&  value)
inline

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

Definition at line 156 of file S3DestinationDescription.h.

◆ WithBucketARN() [3/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithBucketARN ( const char *  value)
inline

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

Definition at line 163 of file S3DestinationDescription.h.

◆ WithBufferingHints() [1/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithBufferingHints ( const BufferingHints value)
inline

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

Definition at line 332 of file S3DestinationDescription.h.

◆ WithBufferingHints() [2/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithBufferingHints ( BufferingHints &&  value)
inline

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

Definition at line 338 of file S3DestinationDescription.h.

◆ WithCloudWatchLoggingOptions() [1/2]

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 438 of file S3DestinationDescription.h.

◆ WithCloudWatchLoggingOptions() [2/2]

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

The Amazon CloudWatch logging options for your delivery stream.

Definition at line 443 of file S3DestinationDescription.h.

◆ WithCompressionFormat() [1/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithCompressionFormat ( const CompressionFormat value)
inline

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

Definition at line 369 of file S3DestinationDescription.h.

◆ WithCompressionFormat() [2/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithCompressionFormat ( CompressionFormat &&  value)
inline

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

Definition at line 375 of file S3DestinationDescription.h.

◆ WithEncryptionConfiguration() [1/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithEncryptionConfiguration ( const EncryptionConfiguration value)
inline

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

Definition at line 406 of file S3DestinationDescription.h.

◆ WithEncryptionConfiguration() [2/2]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithEncryptionConfiguration ( EncryptionConfiguration &&  value)
inline

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

Definition at line 412 of file S3DestinationDescription.h.

◆ WithErrorOutputPrefix() [1/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithErrorOutputPrefix ( const Aws::String value)
inline

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.

Definition at line 283 of file S3DestinationDescription.h.

◆ WithErrorOutputPrefix() [2/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithErrorOutputPrefix ( Aws::String &&  value)
inline

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.

Definition at line 292 of file S3DestinationDescription.h.

◆ WithErrorOutputPrefix() [3/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithErrorOutputPrefix ( const char *  value)
inline

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.

Definition at line 301 of file S3DestinationDescription.h.

◆ WithPrefix() [1/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithPrefix ( const Aws::String value)
inline

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.

Definition at line 212 of file S3DestinationDescription.h.

◆ WithPrefix() [2/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithPrefix ( Aws::String &&  value)
inline

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.

Definition at line 220 of file S3DestinationDescription.h.

◆ WithPrefix() [3/3]

S3DestinationDescription& Aws::Firehose::Model::S3DestinationDescription::WithPrefix ( const char *  value)
inline

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.

Definition at line 228 of file S3DestinationDescription.h.

◆ WithRoleARN() [1/3]

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

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

Definition at line 90 of file S3DestinationDescription.h.

◆ WithRoleARN() [2/3]

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

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

Definition at line 98 of file S3DestinationDescription.h.

◆ WithRoleARN() [3/3]

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

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

Definition at line 106 of file S3DestinationDescription.h.


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