Package software.amazon.awscdk.services.glue

Class CfnSchema.Builder

java.lang.Object
software.amazon.awscdk.services.glue.CfnSchema.Builder
All Implemented Interfaces:
software.amazon.jsii.Builder<CfnSchema>
Enclosing class:
CfnSchema
@Stability(Stable) public static final class CfnSchema.Builder extends Object implements software.amazon.jsii.Builder<CfnSchema>
A fluent builder for CfnSchema.

  • Method Details

    • create

      @Stability(Stable) public static CfnSchema.Builder create(Construct scope, String id)
      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      This parameter is required.
      Returns:
      a new instance of CfnSchema.Builder.

    • compatibility

      @Stability(Stable) public CfnSchema.Builder compatibility(String compatibility)
      The compatibility mode of the schema.

      Parameters:
      compatibility - The compatibility mode of the schema. This parameter is required.
      Returns:
      this

    • dataFormat

      @Stability(Stable) public CfnSchema.Builder dataFormat(String dataFormat)
      The data format of the schema definition.

      Currently only AVRO is supported.

      Parameters:
      dataFormat - The data format of the schema definition. This parameter is required.
      Returns:
      this

    • name

      @Stability(Stable) public CfnSchema.Builder name(String name)
      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.

      Parameters:
      name - 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. This parameter is required.
      Returns:
      this

    • schemaDefinition

      @Stability(Stable) public CfnSchema.Builder schemaDefinition(String schemaDefinition)
      The schema definition using the DataFormat setting for SchemaName .

      Parameters:
      schemaDefinition - The schema definition using the DataFormat setting for SchemaName . This parameter is required.
      Returns:
      this

    • checkpointVersion

      @Stability(Stable) public CfnSchema.Builder checkpointVersion(IResolvable checkpointVersion)
      Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

      This is only required for updating a checkpoint.

      Parameters:
      checkpointVersion - Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This parameter is required.
      Returns:
      this

    • checkpointVersion

      @Stability(Stable) public CfnSchema.Builder checkpointVersion(CfnSchema.SchemaVersionProperty checkpointVersion)
      Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

      This is only required for updating a checkpoint.

      Parameters:
      checkpointVersion - Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This parameter is required.
      Returns:
      this

    • description

      @Stability(Stable) public CfnSchema.Builder description(String description)
      A description of the schema if specified when created.

      Parameters:
      description - A description of the schema if specified when created. This parameter is required.
      Returns:
      this

    • registry

      @Stability(Stable) public CfnSchema.Builder registry(IResolvable registry)
      The registry where a schema is stored.

      Parameters:
      registry - The registry where a schema is stored. This parameter is required.
      Returns:
      this

    • registry

      @Stability(Stable) public CfnSchema.Builder registry(CfnSchema.RegistryProperty registry)
      The registry where a schema is stored.

      Parameters:
      registry - The registry where a schema is stored. This parameter is required.
      Returns:
      this

    • tags

      @Stability(Stable) public CfnSchema.Builder tags(List<? extends CfnTag> tags)
      AWS tags that contain a key value pair and may be searched by console, command line, or API.

      Parameters:
      tags - AWS tags that contain a key value pair and may be searched by console, command line, or API. This parameter is required.
      Returns:
      this

    • build

      @Stability(Stable) public CfnSchema build()
      Specified by:
      build in interface software.amazon.jsii.Builder<CfnSchema>
      Returns:
      a newly built instance of CfnSchema.