AWS SDK for C++  1.8.95
AWS SDK for C++
Public Member Functions | List of all members
Aws::IoTAnalytics::Model::S3DestinationConfiguration Class Reference

#include <S3DestinationConfiguration.h>

Public Member Functions

 S3DestinationConfiguration ()
 
 S3DestinationConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
S3DestinationConfigurationoperator= (Aws::Utils::Json::JsonView jsonValue)
 
Aws::Utils::Json::JsonValue Jsonize () const
 
const Aws::StringGetBucket () const
 
bool BucketHasBeenSet () const
 
void SetBucket (const Aws::String &value)
 
void SetBucket (Aws::String &&value)
 
void SetBucket (const char *value)
 
S3DestinationConfigurationWithBucket (const Aws::String &value)
 
S3DestinationConfigurationWithBucket (Aws::String &&value)
 
S3DestinationConfigurationWithBucket (const char *value)
 
const Aws::StringGetKey () const
 
bool KeyHasBeenSet () const
 
void SetKey (const Aws::String &value)
 
void SetKey (Aws::String &&value)
 
void SetKey (const char *value)
 
S3DestinationConfigurationWithKey (const Aws::String &value)
 
S3DestinationConfigurationWithKey (Aws::String &&value)
 
S3DestinationConfigurationWithKey (const char *value)
 
const GlueConfigurationGetGlueConfiguration () const
 
bool GlueConfigurationHasBeenSet () const
 
void SetGlueConfiguration (const GlueConfiguration &value)
 
void SetGlueConfiguration (GlueConfiguration &&value)
 
S3DestinationConfigurationWithGlueConfiguration (const GlueConfiguration &value)
 
S3DestinationConfigurationWithGlueConfiguration (GlueConfiguration &&value)
 
const Aws::StringGetRoleArn () const
 
bool RoleArnHasBeenSet () const
 
void SetRoleArn (const Aws::String &value)
 
void SetRoleArn (Aws::String &&value)
 
void SetRoleArn (const char *value)
 
S3DestinationConfigurationWithRoleArn (const Aws::String &value)
 
S3DestinationConfigurationWithRoleArn (Aws::String &&value)
 
S3DestinationConfigurationWithRoleArn (const char *value)
 

Detailed Description

Configuration information for delivery of dataset contents to Amazon Simple Storage Service (Amazon S3).

See Also:

AWS API Reference

Definition at line 33 of file S3DestinationConfiguration.h.

Constructor & Destructor Documentation

◆ S3DestinationConfiguration() [1/2]

Aws::IoTAnalytics::Model::S3DestinationConfiguration::S3DestinationConfiguration ( )

◆ S3DestinationConfiguration() [2/2]

Aws::IoTAnalytics::Model::S3DestinationConfiguration::S3DestinationConfiguration ( Aws::Utils::Json::JsonView  jsonValue)

Member Function Documentation

◆ BucketHasBeenSet()

bool Aws::IoTAnalytics::Model::S3DestinationConfiguration::BucketHasBeenSet ( ) const
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 50 of file S3DestinationConfiguration.h.

◆ GetBucket()

const Aws::String& Aws::IoTAnalytics::Model::S3DestinationConfiguration::GetBucket ( ) const
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 45 of file S3DestinationConfiguration.h.

◆ GetGlueConfiguration()

const GlueConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::GetGlueConfiguration ( ) const
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 240 of file S3DestinationConfiguration.h.

◆ GetKey()

const Aws::String& Aws::IoTAnalytics::Model::S3DestinationConfiguration::GetKey ( ) const
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 100 of file S3DestinationConfiguration.h.

◆ GetRoleArn()

const Aws::String& Aws::IoTAnalytics::Model::S3DestinationConfiguration::GetRoleArn ( ) const
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 277 of file S3DestinationConfiguration.h.

◆ GlueConfigurationHasBeenSet()

bool Aws::IoTAnalytics::Model::S3DestinationConfiguration::GlueConfigurationHasBeenSet ( ) const
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 246 of file S3DestinationConfiguration.h.

◆ Jsonize()

Aws::Utils::Json::JsonValue Aws::IoTAnalytics::Model::S3DestinationConfiguration::Jsonize ( ) const

◆ KeyHasBeenSet()

bool Aws::IoTAnalytics::Model::S3DestinationConfiguration::KeyHasBeenSet ( ) const
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 119 of file S3DestinationConfiguration.h.

◆ operator=()

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::operator= ( Aws::Utils::Json::JsonView  jsonValue)

◆ RoleArnHasBeenSet()

bool Aws::IoTAnalytics::Model::S3DestinationConfiguration::RoleArnHasBeenSet ( ) const
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 283 of file S3DestinationConfiguration.h.

◆ SetBucket() [1/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetBucket ( const Aws::String value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 55 of file S3DestinationConfiguration.h.

◆ SetBucket() [2/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetBucket ( Aws::String &&  value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 60 of file S3DestinationConfiguration.h.

◆ SetBucket() [3/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetBucket ( const char *  value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 65 of file S3DestinationConfiguration.h.

◆ SetGlueConfiguration() [1/2]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetGlueConfiguration ( const GlueConfiguration value)
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 252 of file S3DestinationConfiguration.h.

◆ SetGlueConfiguration() [2/2]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetGlueConfiguration ( GlueConfiguration &&  value)
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 258 of file S3DestinationConfiguration.h.

◆ SetKey() [1/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetKey ( const Aws::String value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 138 of file S3DestinationConfiguration.h.

◆ SetKey() [2/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetKey ( Aws::String &&  value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 157 of file S3DestinationConfiguration.h.

◆ SetKey() [3/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetKey ( const char *  value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 176 of file S3DestinationConfiguration.h.

◆ SetRoleArn() [1/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetRoleArn ( const Aws::String value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 289 of file S3DestinationConfiguration.h.

◆ SetRoleArn() [2/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetRoleArn ( Aws::String &&  value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 295 of file S3DestinationConfiguration.h.

◆ SetRoleArn() [3/3]

void Aws::IoTAnalytics::Model::S3DestinationConfiguration::SetRoleArn ( const char *  value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 301 of file S3DestinationConfiguration.h.

◆ WithBucket() [1/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithBucket ( const Aws::String value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 70 of file S3DestinationConfiguration.h.

◆ WithBucket() [2/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithBucket ( Aws::String &&  value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 75 of file S3DestinationConfiguration.h.

◆ WithBucket() [3/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithBucket ( const char *  value)
inline

The name of the S3 bucket to which dataset contents are delivered.

Definition at line 80 of file S3DestinationConfiguration.h.

◆ WithGlueConfiguration() [1/2]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithGlueConfiguration ( const GlueConfiguration value)
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 264 of file S3DestinationConfiguration.h.

◆ WithGlueConfiguration() [2/2]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithGlueConfiguration ( GlueConfiguration &&  value)
inline

Configuration information for coordination with AWS Glue, a fully managed extract, transform and load (ETL) service.

Definition at line 270 of file S3DestinationConfiguration.h.

◆ WithKey() [1/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithKey ( const Aws::String value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 195 of file S3DestinationConfiguration.h.

◆ WithKey() [2/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithKey ( Aws::String &&  value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 214 of file S3DestinationConfiguration.h.

◆ WithKey() [3/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithKey ( const char *  value)
inline

The key of the dataset contents object in an S3 bucket. Each object has a key that is a unique identifier. Each object has exactly one key.

You can create a unique key with the following options:

  • Use !{iotanalytics:scheduleTime} to insert the time of a scheduled SQL query run.

  • Use !{iotanalytics:versionId} to insert a unique hash that identifies a dataset content.

  • Use !{iotanalytics:creationTime} to insert the creation time of a dataset content.

The following example creates a unique key for a CSV file: dataset/mydataset/!{iotanalytics:scheduleTime}/!{iotanalytics:versionId}.csv

If you don't use !{iotanalytics:versionId} to specify the key, you might get duplicate keys. For example, you might have two dataset contents with the same scheduleTime but different versionIds. This means that one dataset content overwrites the other.

Definition at line 233 of file S3DestinationConfiguration.h.

◆ WithRoleArn() [1/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithRoleArn ( const Aws::String value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 307 of file S3DestinationConfiguration.h.

◆ WithRoleArn() [2/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithRoleArn ( Aws::String &&  value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 313 of file S3DestinationConfiguration.h.

◆ WithRoleArn() [3/3]

S3DestinationConfiguration& Aws::IoTAnalytics::Model::S3DestinationConfiguration::WithRoleArn ( const char *  value)
inline

The ARN of the role that grants AWS IoT Analytics permission to interact with your Amazon S3 and AWS Glue resources.

Definition at line 319 of file S3DestinationConfiguration.h.


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