Class: Aws::Firehose::Types::SchemaConfiguration

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
lib/aws-sdk-firehose/types.rb

Overview

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

See Also:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

The ID of the Amazon Web Services Glue Data Catalog. If you don’t supply this, the Amazon Web Services account ID is used by default.

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#database_name ⇒ String

Specifies the name of the Amazon Web Services 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.

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#region ⇒ String

If you don’t specify an Amazon Web Services Region, the default is the current Region.

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#role_arn ⇒ String

The role that Firehose can use to access Amazon Web Services Glue. This role must be in the same account you use for 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.

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#table_name ⇒ String

Specifies the Amazon Web Services 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.

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end

#version_id ⇒ String

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

Returns:

  • (String) 


3806
3807
3808
3809
3810
3811
3812
3813
3814
3815
 
# File 'lib/aws-sdk-firehose/types.rb', line 3806

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  SENSITIVE = []
  include Aws::Structure
end