Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. glue
  5. Schema

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.glue.Schema

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
pulumi/pulumi-aws-native

    This resource represents a schema of Glue Schema Registry.

    Create Schema Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Schema(name: string, args: SchemaArgs, opts?: CustomResourceOptions);
    @overload
def Schema(resource_name: str,
           args: SchemaArgs,
           opts: Optional[ResourceOptions] = None)

@overload
def Schema(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           compatibility: Optional[SchemaCompatibility] = None,
           data_format: Optional[SchemaDataFormat] = None,
           schema_definition: Optional[str] = None,
           checkpoint_version: Optional[SchemaVersionArgs] = None,
           description: Optional[str] = None,
           name: Optional[str] = None,
           registry: Optional[SchemaRegistryArgs] = None,
           tags: Optional[Sequence[_root_inputs.TagArgs]] = None)
    func NewSchema(ctx *Context, name string, args SchemaArgs, opts ...ResourceOption) (*Schema, error)
    public Schema(string name, SchemaArgs args, CustomResourceOptions? opts = null)
    public Schema(String name, SchemaArgs args)
public Schema(String name, SchemaArgs args, CustomResourceOptions options)

    type: aws-native:glue:Schema
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args SchemaArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!

    Coming soon!

    Coming soon!

    Coming soon!

    const aws_nativeSchemaResource = new aws_native.glue.Schema("aws-nativeSchemaResource", {
    compatibility: aws_native.glue.SchemaCompatibility.None,
    dataFormat: aws_native.glue.SchemaDataFormat.Avro,
    schemaDefinition: "string",
    checkpointVersion: {
        isLatest: false,
        versionNumber: 0,
    },
    description: "string",
    name: "string",
    registry: {
        arn: "string",
        name: "string",
    },
    tags: [{
        key: "string",
        value: "string",
    }],
});

    Coming soon!

    Schema Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Schema resource accepts the following input properties:

    Compatibility Pulumi.AwsNative.Glue.SchemaCompatibility
    Compatibility setting for the schema.
    DataFormat Pulumi.AwsNative.Glue.SchemaDataFormat
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    SchemaDefinition string
    Definition for the initial schema version in plain-text.
    CheckpointVersion Pulumi.AwsNative.Glue.Inputs.SchemaVersion
    Description string
    A description of the schema. If description is not provided, there will not be any default value for this.
    Name string
    Name of the schema.
    Registry Pulumi.AwsNative.Glue.Inputs.SchemaRegistry
    Tags List<Pulumi.AwsNative.Inputs.Tag>
    List of tags to tag the schema
    Compatibility SchemaCompatibility
    Compatibility setting for the schema.
    DataFormat SchemaDataFormat
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    SchemaDefinition string
    Definition for the initial schema version in plain-text.
    CheckpointVersion SchemaVersionTypeArgs
    Description string
    A description of the schema. If description is not provided, there will not be any default value for this.
    Name string
    Name of the schema.
    Registry SchemaRegistryArgs
    Tags TagArgs
    List of tags to tag the schema
    compatibility SchemaCompatibility
    Compatibility setting for the schema.
    dataFormat SchemaDataFormat
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    schemaDefinition String
    Definition for the initial schema version in plain-text.
    checkpointVersion SchemaVersion
    description String
    A description of the schema. If description is not provided, there will not be any default value for this.
    name String
    Name of the schema.
    registry SchemaRegistry
    tags List<Tag>
    List of tags to tag the schema
    compatibility SchemaCompatibility
    Compatibility setting for the schema.
    dataFormat SchemaDataFormat
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    schemaDefinition string
    Definition for the initial schema version in plain-text.
    checkpointVersion SchemaVersion
    description string
    A description of the schema. If description is not provided, there will not be any default value for this.
    name string
    Name of the schema.
    registry SchemaRegistry
    tags Tag[]
    List of tags to tag the schema
    compatibility SchemaCompatibility
    Compatibility setting for the schema.
    data_format SchemaDataFormat
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    schema_definition str
    Definition for the initial schema version in plain-text.
    checkpoint_version SchemaVersionArgs
    description str
    A description of the schema. If description is not provided, there will not be any default value for this.
    name str
    Name of the schema.
    registry SchemaRegistryArgs
    tags Sequence[TagArgs]
    List of tags to tag the schema
    compatibility "NONE" | "DISABLED" | "BACKWARD" | "BACKWARD_ALL" | "FORWARD" | "FORWARD_ALL" | "FULL" | "FULL_ALL"
    Compatibility setting for the schema.
    dataFormat "AVRO" | "JSON" | "PROTOBUF"
    Data format name to use for the schema. Accepted values: 'AVRO', 'JSON', 'PROTOBUF'
    schemaDefinition String
    Definition for the initial schema version in plain-text.
    checkpointVersion Property Map
    description String
    A description of the schema. If description is not provided, there will not be any default value for this.
    name String
    Name of the schema.
    registry Property Map
    tags List<Property Map>
    List of tags to tag the schema

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Schema resource produces the following output properties:

    Arn string
    Amazon Resource Name for the Schema.
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialSchemaVersionId string
    Represents the version ID associated with the initial schema version.
    Arn string
    Amazon Resource Name for the Schema.
    Id string
    The provider-assigned unique ID for this managed resource.
    InitialSchemaVersionId string
    Represents the version ID associated with the initial schema version.
    arn String
    Amazon Resource Name for the Schema.
    id String
    The provider-assigned unique ID for this managed resource.
    initialSchemaVersionId String
    Represents the version ID associated with the initial schema version.
    arn string
    Amazon Resource Name for the Schema.
    id string
    The provider-assigned unique ID for this managed resource.
    initialSchemaVersionId string
    Represents the version ID associated with the initial schema version.
    arn str
    Amazon Resource Name for the Schema.
    id str
    The provider-assigned unique ID for this managed resource.
    initial_schema_version_id str
    Represents the version ID associated with the initial schema version.
    arn String
    Amazon Resource Name for the Schema.
    id String
    The provider-assigned unique ID for this managed resource.
    initialSchemaVersionId String
    Represents the version ID associated with the initial schema version.

    Supporting Types

    SchemaCompatibility, SchemaCompatibilityArgs

    None
    NONE
    Disabled
    DISABLED
    Backward
    BACKWARD
    BackwardAll
    BACKWARD_ALL
    Forward
    FORWARD
    ForwardAll
    FORWARD_ALL
    Full
    FULL
    FullAll
    FULL_ALL
    SchemaCompatibilityNone
    NONE
    SchemaCompatibilityDisabled
    DISABLED
    SchemaCompatibilityBackward
    BACKWARD
    SchemaCompatibilityBackwardAll
    BACKWARD_ALL
    SchemaCompatibilityForward
    FORWARD
    SchemaCompatibilityForwardAll
    FORWARD_ALL
    SchemaCompatibilityFull
    FULL
    SchemaCompatibilityFullAll
    FULL_ALL
    None
    NONE
    Disabled
    DISABLED
    Backward
    BACKWARD
    BackwardAll
    BACKWARD_ALL
    Forward
    FORWARD
    ForwardAll
    FORWARD_ALL
    Full
    FULL
    FullAll
    FULL_ALL
    None
    NONE
    Disabled
    DISABLED
    Backward
    BACKWARD
    BackwardAll
    BACKWARD_ALL
    Forward
    FORWARD
    ForwardAll
    FORWARD_ALL
    Full
    FULL
    FullAll
    FULL_ALL
    NONE
    NONE
    DISABLED
    DISABLED
    BACKWARD
    BACKWARD
    BACKWARD_ALL
    BACKWARD_ALL
    FORWARD
    FORWARD
    FORWARD_ALL
    FORWARD_ALL
    FULL
    FULL
    FULL_ALL
    FULL_ALL
    "NONE"
    NONE
    "DISABLED"
    DISABLED
    "BACKWARD"
    BACKWARD
    "BACKWARD_ALL"
    BACKWARD_ALL
    "FORWARD"
    FORWARD
    "FORWARD_ALL"
    FORWARD_ALL
    "FULL"
    FULL
    "FULL_ALL"
    FULL_ALL

    SchemaDataFormat, SchemaDataFormatArgs

    Avro
    AVRO
    Json
    JSON
    Protobuf
    PROTOBUF
    SchemaDataFormatAvro
    AVRO
    SchemaDataFormatJson
    JSON
    SchemaDataFormatProtobuf
    PROTOBUF
    Avro
    AVRO
    Json
    JSON
    Protobuf
    PROTOBUF
    Avro
    AVRO
    Json
    JSON
    Protobuf
    PROTOBUF
    AVRO
    AVRO
    JSON
    JSON
    PROTOBUF
    PROTOBUF
    "AVRO"
    AVRO
    "JSON"
    JSON
    "PROTOBUF"
    PROTOBUF

    SchemaRegistry, SchemaRegistryArgs

    Arn string
    Amazon Resource Name for the Registry.
    Name string
    Name of the registry in which the schema will be created.
    Arn string
    Amazon Resource Name for the Registry.
    Name string
    Name of the registry in which the schema will be created.
    arn String
    Amazon Resource Name for the Registry.
    name String
    Name of the registry in which the schema will be created.
    arn string
    Amazon Resource Name for the Registry.
    name string
    Name of the registry in which the schema will be created.
    arn str
    Amazon Resource Name for the Registry.
    name str
    Name of the registry in which the schema will be created.
    arn String
    Amazon Resource Name for the Registry.
    name String
    Name of the registry in which the schema will be created.

    SchemaVersion, SchemaVersionArgs

    IsLatest bool
    Indicates if the latest version needs to be updated.
    VersionNumber int
    Indicates the version number in the schema to update.
    IsLatest bool
    Indicates if the latest version needs to be updated.
    VersionNumber int
    Indicates the version number in the schema to update.
    isLatest Boolean
    Indicates if the latest version needs to be updated.
    versionNumber Integer
    Indicates the version number in the schema to update.
    isLatest boolean
    Indicates if the latest version needs to be updated.
    versionNumber number
    Indicates the version number in the schema to update.
    is_latest bool
    Indicates if the latest version needs to be updated.
    version_number int
    Indicates the version number in the schema to update.
    isLatest Boolean
    Indicates if the latest version needs to be updated.
    versionNumber Number
    Indicates the version number in the schema to update.

    Tag, TagArgs

    Key string
    The key name of the tag
    Value string
    The value of the tag
    Key string
    The key name of the tag
    Value string
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag
    key string
    The key name of the tag
    value string
    The value of the tag
    key str
    The key name of the tag
    value str
    The value of the tag
    key String
    The key name of the tag
    value String
    The value of the tag

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.102.0 published on Tuesday, Apr 16, 2024 by Pulumi
    pulumi/pulumi-aws-native