Package software.amazon.awscdk.services.glue

Class CfnSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnSchema
All Implemented Interfaces:
IInspectable, ITaggable, ISchemaRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.113.0 (build fc68b25)", date="2025-10-14T12:28:11.802Z") @Stability(Stable) public class CfnSchema extends CfnResource implements IInspectable, ISchemaRef, ITaggable
The AWS::Glue::Schema is an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 CfnSchema cfnSchema = CfnSchema.Builder.create(this, "MyCfnSchema")
         .compatibility("compatibility")
         .dataFormat("dataFormat")
         .name("name")
         // the properties below are optional
         .checkpointVersion(SchemaVersionProperty.builder()
                 .isLatest(false)
                 .versionNumber(123)
                 .build())
         .description("description")
         .registry(RegistryProperty.builder()
                 .arn("arn")
                 .name("name")
                 .build())
         .schemaDefinition("schemaDefinition")
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSchema

      protected CfnSchema(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSchema

      protected CfnSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSchema

      @Stability(Stable) public CfnSchema(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSchemaProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the schema.

    • getAttrInitialSchemaVersionId

      @Stability(Stable) @NotNull public String getAttrInitialSchemaVersionId()
      Represents the version ID associated with the initial schema version.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSchemaRef

      @Stability(Stable) @NotNull public SchemaReference getSchemaRef()
      A reference to a Schema resource.
      Specified by:
      getSchemaRef in interface ISchemaRef

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getCompatibility

      @Stability(Stable) @NotNull public String getCompatibility()
      The compatibility mode of the schema.

    • setCompatibility

      @Stability(Stable) public void setCompatibility(@NotNull String value)
      The compatibility mode of the schema.

    • getDataFormat

      @Stability(Stable) @NotNull public String getDataFormat()
      The data format of the schema definition.

    • setDataFormat

      @Stability(Stable) public void setDataFormat(@NotNull String value)
      The data format of the schema definition.

    • getName

      @Stability(Stable) @NotNull public String getName()
      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.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      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.

    • getCheckpointVersion

      @Stability(Stable) @Nullable public Object getCheckpointVersion()
      Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

    • setCheckpointVersion

      @Stability(Stable) public void setCheckpointVersion(@Nullable IResolvable value)
      Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

    • setCheckpointVersion

      @Stability(Stable) public void setCheckpointVersion(@Nullable CfnSchema.SchemaVersionProperty value)
      Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.

    • getDescription

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

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the schema if specified when created.

    • getRegistry

      @Stability(Stable) @Nullable public Object getRegistry()
      The registry where a schema is stored.

    • setRegistry

      @Stability(Stable) public void setRegistry(@Nullable IResolvable value)
      The registry where a schema is stored.

    • setRegistry

      @Stability(Stable) public void setRegistry(@Nullable CfnSchema.RegistryProperty value)
      The registry where a schema is stored.

    • getSchemaDefinition

      @Stability(Stable) @Nullable public String getSchemaDefinition()
      The schema definition using the DataFormat setting for SchemaName .

    • setSchemaDefinition

      @Stability(Stable) public void setSchemaDefinition(@Nullable String value)
      The schema definition using the DataFormat setting for SchemaName .

    • getTagsRaw

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

    • setTagsRaw

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