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

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

Overview

Note:

When making an API call, you may pass SchemaConfiguration data as a hash:

{
  role_arn: "NonEmptyStringWithoutWhitespace",
  catalog_id: "NonEmptyStringWithoutWhitespace",
  database_name: "NonEmptyStringWithoutWhitespace",
  table_name: "NonEmptyStringWithoutWhitespace",
  region: "NonEmptyStringWithoutWhitespace",
  version_id: "NonEmptyStringWithoutWhitespace",
}

Specifies the schema to which you want Kinesis Data Firehose to configure your data before it writes it to Amazon S3.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

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

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

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

#database_name ⇒ String

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

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

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

#region ⇒ String

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

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

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

#role_arn ⇒ String

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.

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

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

#table_name ⇒ String

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

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

class SchemaConfiguration < Struct.new(
  :role_arn,
  :catalog_id,
  :database_name,
  :table_name,
  :region,
  :version_id)
  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`, Kinesis Data Firehose uses the most recent version. This means that any updates to the table are automatically picked up.

Returns:

  • (String) 


3424
3425
3426
3427
3428
3429
3430
3431
3432
 
# File 'lib/aws-sdk-firehose/types.rb', line 3424

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