Class: Aws::Glue::Types::CreateSchemaInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

Note:

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

{
  registry_id: {
    registry_name: "SchemaRegistryNameString",
    registry_arn: "GlueResourceArn",
  },
  schema_name: "SchemaRegistryNameString", # required
  data_format: "AVRO", # required, accepts AVRO, JSON
  compatibility: "NONE", # accepts NONE, DISABLED, BACKWARD, BACKWARD_ALL, FORWARD, FORWARD_ALL, FULL, FULL_ALL
  description: "DescriptionString",
  tags: {
    "TagKey" => "TagValue",
  },
  schema_definition: "SchemaDefinitionString",
}

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#compatibilityString

The compatibility mode of the schema. The possible values are:

  • NONE: No compatibility mode applies. You can use this choice in development scenarios or if you do not know the compatibility mode that you want to apply to schemas. Any new version added will be accepted without undergoing a compatibility check.

  • DISABLED: This compatibility choice prevents versioning for a particular schema. You can use this choice to prevent future versioning of a schema.

  • BACKWARD: This compatibility choice is recommended as it allows data receivers to read both the current and one previous schema version. This means that for instance, a new schema version cannot drop data fields or change the type of these fields, so they can't be read by readers using the previous version.

  • BACKWARD_ALL: This compatibility choice allows data receivers to read both the current and all previous schema versions. You can use this choice when you need to delete fields or add optional fields, and check compatibility against all previous schema versions.

  • FORWARD: This compatibility choice allows data receivers to read both the current and one next schema version, but not necessarily later versions. You can use this choice when you need to add fields or delete optional fields, but only check compatibility against the last schema version.

  • FORWARD_ALL: This compatibility choice allows data receivers to read written by producers of any new registered schema. You can use this choice when you need to add fields or delete optional fields, and check compatibility against all previous schema versions.

  • FULL: This compatibility choice allows data receivers to read data written by producers using the previous or next version of the schema, but not necessarily earlier or later versions. You can use this choice when you need to add or remove optional fields, but only check compatibility against the last schema version.

  • FULL_ALL: This compatibility choice allows data receivers to read data written by producers using all previous schema versions. You can use this choice when you need to add or remove optional fields, and check compatibility against all previous schema versions.

Returns:

  • (String)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#data_formatString

The data format of the schema definition. Currently AVRO and JSON are supported.

Returns:

  • (String)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

An optional description of the schema. If description is not provided, there will not be any automatic default value for this.

Returns:

  • (String)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#registry_idTypes::RegistryId

This is a wrapper shape to contain the registry identity fields. If this is not provided, the default registry will be used. The ARN format for the same will be: arn:aws:glue:us-east-2:<customer id>:registry/default-registry:random-5-letter-id.

Returns:



4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#schema_definitionString

The schema definition using the DataFormat setting for SchemaName.

Returns:

  • (String)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#schema_nameString

Name of the schema to be created of max length of 255, and may only contain letters, numbers, hyphen, underscore, dollar sign, or hash mark. No whitespace.

Returns:

  • (String)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end

#tagsHash<String,String>

Amazon Web Services tags that contain a key value pair and may be searched by console, command line, or API. If specified, follows the Amazon Web Services tags-on-create pattern.

Returns:

  • (Hash<String,String>)


4475
4476
4477
4478
4479
4480
4481
4482
4483
4484
4485
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 4475

class CreateSchemaInput < Struct.new(
  :registry_id,
  :schema_name,
  :data_format,
  :compatibility,
  :description,
  :tags,
  :schema_definition)
  SENSITIVE = []
  include Aws::Structure
end