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. This parameter is required if `Enabled` is set to true.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_idString

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

Returns:

  • (String)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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

#database_nameString

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.

Returns:

  • (String)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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

#regionString

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

Returns:

  • (String)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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

#role_arnString

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.

Returns:

  • (String)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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

#table_nameString

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.

Returns:

  • (String)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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

#version_idString

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)

4990
4991
4992
4993
4994
4995
4996
4997
4998
4999
# File 'lib/aws-sdk-firehose/types.rb', line 4990

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