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

#include <SchemaConfiguration.h>

Public Member Functions

 SchemaConfiguration ()
 
 SchemaConfiguration (Aws::Utils::Json::JsonView jsonValue)
 
SchemaConfigurationoperator= (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)
 
SchemaConfigurationWithRoleARN (const Aws::String &value)
 
SchemaConfigurationWithRoleARN (Aws::String &&value)
 
SchemaConfigurationWithRoleARN (const char *value)
 
const Aws::StringGetCatalogId () const
 
bool CatalogIdHasBeenSet () const
 
void SetCatalogId (const Aws::String &value)
 
void SetCatalogId (Aws::String &&value)
 
void SetCatalogId (const char *value)
 
SchemaConfigurationWithCatalogId (const Aws::String &value)
 
SchemaConfigurationWithCatalogId (Aws::String &&value)
 
SchemaConfigurationWithCatalogId (const char *value)
 
const Aws::StringGetDatabaseName () const
 
bool DatabaseNameHasBeenSet () const
 
void SetDatabaseName (const Aws::String &value)
 
void SetDatabaseName (Aws::String &&value)
 
void SetDatabaseName (const char *value)
 
SchemaConfigurationWithDatabaseName (const Aws::String &value)
 
SchemaConfigurationWithDatabaseName (Aws::String &&value)
 
SchemaConfigurationWithDatabaseName (const char *value)
 
const Aws::StringGetTableName () const
 
bool TableNameHasBeenSet () const
 
void SetTableName (const Aws::String &value)
 
void SetTableName (Aws::String &&value)
 
void SetTableName (const char *value)
 
SchemaConfigurationWithTableName (const Aws::String &value)
 
SchemaConfigurationWithTableName (Aws::String &&value)
 
SchemaConfigurationWithTableName (const char *value)
 
const Aws::StringGetRegion () const
 
bool RegionHasBeenSet () const
 
void SetRegion (const Aws::String &value)
 
void SetRegion (Aws::String &&value)
 
void SetRegion (const char *value)
 
SchemaConfigurationWithRegion (const Aws::String &value)
 
SchemaConfigurationWithRegion (Aws::String &&value)
 
SchemaConfigurationWithRegion (const char *value)
 
const Aws::StringGetVersionId () const
 
bool VersionIdHasBeenSet () const
 
void SetVersionId (const Aws::String &value)
 
void SetVersionId (Aws::String &&value)
 
void SetVersionId (const char *value)
 
SchemaConfigurationWithVersionId (const Aws::String &value)
 
SchemaConfigurationWithVersionId (Aws::String &&value)
 
SchemaConfigurationWithVersionId (const char *value)
 

Detailed Description

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3. This parameter is required if Enabled is set to true.

See Also:

AWS API Reference

Definition at line 33 of file SchemaConfiguration.h.

Constructor & Destructor Documentation

◆ SchemaConfiguration() [1/2]

Aws::Firehose::Model::SchemaConfiguration::SchemaConfiguration ( )

◆ SchemaConfiguration() [2/2]

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

Member Function Documentation

◆ CatalogIdHasBeenSet()

bool Aws::Firehose::Model::SchemaConfiguration::CatalogIdHasBeenSet ( ) const
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 133 of file SchemaConfiguration.h.

◆ DatabaseNameHasBeenSet()

bool Aws::Firehose::Model::SchemaConfiguration::DatabaseNameHasBeenSet ( ) const
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 188 of file SchemaConfiguration.h.

◆ GetCatalogId()

const Aws::String& Aws::Firehose::Model::SchemaConfiguration::GetCatalogId ( ) const
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 127 of file SchemaConfiguration.h.

◆ GetDatabaseName()

const Aws::String& Aws::Firehose::Model::SchemaConfiguration::GetDatabaseName ( ) const
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 179 of file SchemaConfiguration.h.

◆ GetRegion()

const Aws::String& Aws::Firehose::Model::SchemaConfiguration::GetRegion ( ) const
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 321 of file SchemaConfiguration.h.

◆ GetRoleARN()

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 50 of file SchemaConfiguration.h.

◆ GetTableName()

const Aws::String& Aws::Firehose::Model::SchemaConfiguration::GetTableName ( ) const
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 252 of file SchemaConfiguration.h.

◆ GetVersionId()

const Aws::String& Aws::Firehose::Model::SchemaConfiguration::GetVersionId ( ) const
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 365 of file SchemaConfiguration.h.

◆ Jsonize()

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

◆ operator=()

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

◆ RegionHasBeenSet()

bool Aws::Firehose::Model::SchemaConfiguration::RegionHasBeenSet ( ) const
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 326 of file SchemaConfiguration.h.

◆ RoleARNHasBeenSet()

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 60 of file SchemaConfiguration.h.

◆ SetCatalogId() [1/3]

void Aws::Firehose::Model::SchemaConfiguration::SetCatalogId ( Aws::String &&  value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 145 of file SchemaConfiguration.h.

◆ SetCatalogId() [2/3]

void Aws::Firehose::Model::SchemaConfiguration::SetCatalogId ( const Aws::String value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 139 of file SchemaConfiguration.h.

◆ SetCatalogId() [3/3]

void Aws::Firehose::Model::SchemaConfiguration::SetCatalogId ( const char *  value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 151 of file SchemaConfiguration.h.

◆ SetDatabaseName() [1/3]

void Aws::Firehose::Model::SchemaConfiguration::SetDatabaseName ( Aws::String &&  value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 206 of file SchemaConfiguration.h.

◆ SetDatabaseName() [2/3]

void Aws::Firehose::Model::SchemaConfiguration::SetDatabaseName ( const Aws::String value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 197 of file SchemaConfiguration.h.

◆ SetDatabaseName() [3/3]

void Aws::Firehose::Model::SchemaConfiguration::SetDatabaseName ( const char *  value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 215 of file SchemaConfiguration.h.

◆ SetRegion() [1/3]

void Aws::Firehose::Model::SchemaConfiguration::SetRegion ( Aws::String &&  value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 336 of file SchemaConfiguration.h.

◆ SetRegion() [2/3]

void Aws::Firehose::Model::SchemaConfiguration::SetRegion ( const Aws::String value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 331 of file SchemaConfiguration.h.

◆ SetRegion() [3/3]

void Aws::Firehose::Model::SchemaConfiguration::SetRegion ( const char *  value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 341 of file SchemaConfiguration.h.

◆ SetRoleARN() [1/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 80 of file SchemaConfiguration.h.

◆ SetRoleARN() [2/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 70 of file SchemaConfiguration.h.

◆ SetRoleARN() [3/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 90 of file SchemaConfiguration.h.

◆ SetTableName() [1/3]

void Aws::Firehose::Model::SchemaConfiguration::SetTableName ( Aws::String &&  value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 279 of file SchemaConfiguration.h.

◆ SetTableName() [2/3]

void Aws::Firehose::Model::SchemaConfiguration::SetTableName ( const Aws::String value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 270 of file SchemaConfiguration.h.

◆ SetTableName() [3/3]

void Aws::Firehose::Model::SchemaConfiguration::SetTableName ( const char *  value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 288 of file SchemaConfiguration.h.

◆ SetVersionId() [1/3]

void Aws::Firehose::Model::SchemaConfiguration::SetVersionId ( Aws::String &&  value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 389 of file SchemaConfiguration.h.

◆ SetVersionId() [2/3]

void Aws::Firehose::Model::SchemaConfiguration::SetVersionId ( const Aws::String value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 381 of file SchemaConfiguration.h.

◆ SetVersionId() [3/3]

void Aws::Firehose::Model::SchemaConfiguration::SetVersionId ( const char *  value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 397 of file SchemaConfiguration.h.

◆ TableNameHasBeenSet()

bool Aws::Firehose::Model::SchemaConfiguration::TableNameHasBeenSet ( ) const
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 261 of file SchemaConfiguration.h.

◆ VersionIdHasBeenSet()

bool Aws::Firehose::Model::SchemaConfiguration::VersionIdHasBeenSet ( ) const
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 373 of file SchemaConfiguration.h.

◆ WithCatalogId() [1/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithCatalogId ( Aws::String &&  value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 163 of file SchemaConfiguration.h.

◆ WithCatalogId() [2/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithCatalogId ( const Aws::String value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 157 of file SchemaConfiguration.h.

◆ WithCatalogId() [3/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithCatalogId ( const char *  value)
inline

The ID of the AWS Glue Data Catalog. If you don't supply this, the AWS account ID is used by default.

Definition at line 169 of file SchemaConfiguration.h.

◆ WithDatabaseName() [1/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithDatabaseName ( Aws::String &&  value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 233 of file SchemaConfiguration.h.

◆ WithDatabaseName() [2/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithDatabaseName ( const Aws::String value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 224 of file SchemaConfiguration.h.

◆ WithDatabaseName() [3/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithDatabaseName ( const char *  value)
inline

Specifies the name of the AWS Glue database that contains the schema for the output data.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the DatabaseName property is required and its value must be specified.

Definition at line 242 of file SchemaConfiguration.h.

◆ WithRegion() [1/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithRegion ( Aws::String &&  value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 351 of file SchemaConfiguration.h.

◆ WithRegion() [2/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithRegion ( const Aws::String value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 346 of file SchemaConfiguration.h.

◆ WithRegion() [3/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithRegion ( const char *  value)
inline

If you don't specify an AWS Region, the default is the current Region.

Definition at line 356 of file SchemaConfiguration.h.

◆ WithRoleARN() [1/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 110 of file SchemaConfiguration.h.

◆ WithRoleARN() [2/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 100 of file SchemaConfiguration.h.

◆ WithRoleARN() [3/3]

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

The role that Kinesis Data Firehose can use to access AWS Glue. This role must be in the same account you use for Kinesis Data Firehose. Cross-account roles aren't allowed.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the RoleARN property is required and its value must be specified.

Definition at line 120 of file SchemaConfiguration.h.

◆ WithTableName() [1/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithTableName ( Aws::String &&  value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 306 of file SchemaConfiguration.h.

◆ WithTableName() [2/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithTableName ( const Aws::String value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 297 of file SchemaConfiguration.h.

◆ WithTableName() [3/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithTableName ( const char *  value)
inline

Specifies the AWS Glue table that contains the column information that constitutes your data schema.

If the SchemaConfiguration request parameter is used as part of invoking the CreateDeliveryStream API, then the TableName property is required and its value must be specified.

Definition at line 315 of file SchemaConfiguration.h.

◆ WithVersionId() [1/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithVersionId ( Aws::String &&  value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 413 of file SchemaConfiguration.h.

◆ WithVersionId() [2/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithVersionId ( const Aws::String value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 405 of file SchemaConfiguration.h.

◆ WithVersionId() [3/3]

SchemaConfiguration& Aws::Firehose::Model::SchemaConfiguration::WithVersionId ( const char *  value)
inline

Specifies the table version for the output data schema. If you don't specify this version ID, or if you set it to LATEST, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Definition at line 421 of file SchemaConfiguration.h.


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