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

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-firehose/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)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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.

Returns:

  • (String)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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.

Returns:

  • (String)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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.

Returns:

  • (String)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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)


4431
4432
4433
4434
4435
4436
4437
4438
4439
4440
# File 'gems/aws-sdk-firehose/lib/aws-sdk-firehose/types.rb', line 4431

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