You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.

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

Inherits:
Struct
  • Object
show all
Defined in:
(unknown)

Overview

Note:

When passing SchemaConfiguration as input to an Aws::Client method, you can use a vanilla 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. This parameter is required if Enabled is set to true.

Returned by:

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) —

    The ID of the AWS Glue Data Catalog.

#database_name ⇒ String

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

Returns:

  • (String) —

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

#region ⇒ String

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

Returns:

  • (String) —

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

#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) —

    The role that Kinesis Data Firehose can use to access AWS Glue.

#table_name ⇒ String

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

Returns:

  • (String) —

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

#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) —

    Specifies the table version for the output data schema.