Package software.amazon.awscdk.services.glue

Class CfnSchema

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnSchema
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.459Z") @Stability(Stable) public class CfnSchema extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::Schema.

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")
         .schemaDefinition("schemaDefinition")
         // the properties below are optional
         .checkpointVersion(SchemaVersionProperty.builder()
                 .isLatest(false)
                 .versionNumber(123)
                 .build())
         .description("description")
         .registry(RegistryProperty.builder()
                 .arn("arn")
                 .name("name")
                 .build())
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

  • 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 Construct scope, @NotNull String id, @NotNull CfnSchemaProps props)
      Create a new AWS::Glue::Schema.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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()

    • getCfnProperties

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

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      AWS tags that contain a key value pair and may be searched by console, command line, or API.

    • 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.

      Currently only AVRO is supported.

    • setDataFormat

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

      Currently only AVRO is supported.

    • 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.

      No whitespace.

    • 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.

      No whitespace.

    • getSchemaDefinition

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

    • setSchemaDefinition

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

    • getCheckpointVersion

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

      This is only required for updating a checkpoint.

    • setCheckpointVersion

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

      This is only required for updating a checkpoint.

    • setCheckpointVersion

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

      This is only required for updating a checkpoint.

    • 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.