Package software.amazon.awscdk.services.glue

Interface CfnSchemaProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)",
           date="2023-06-19T16:30:42.463Z")
@Stability(Stable)
public interface CfnSchemaProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnSchema.

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.*;
 CfnSchemaProps cfnSchemaProps = CfnSchemaProps.builder()
         .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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSchemaProps.Builder	A builder for CfnSchemaProps
static final class	CfnSchemaProps.Jsii$Proxy	An implementation for CfnSchemaProps

Method Summary

Modifier and Type	Method	Description
static CfnSchemaProps.Builder	builder()
default Object	getCheckpointVersion()	Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.
String	getCompatibility()	The compatibility mode of the schema.
String	getDataFormat()	The data format of the schema definition.
default String	getDescription()	A description of the schema if specified when created.
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.
default Object	getRegistry()	The registry where a schema is stored.
String	getSchemaDefinition()	The schema definition using the DataFormat setting for SchemaName .
default List<CfnTag>	getTags()	AWS tags that contain a key value pair and may be searched by console, command line, or API.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getCompatibility

@Stability(Stable)
@NotNull
String getCompatibility()

The compatibility mode of the schema.

getDataFormat

@Stability(Stable)
@NotNull
String getDataFormat()

The data format of the schema definition.

Currently only AVRO is supported.

getName

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

getSchemaDefinition

@Stability(Stable)
@NotNull
String getSchemaDefinition()

The schema definition using the DataFormat setting for SchemaName .

getCheckpointVersion

@Stability(Stable)
@Nullable
default Object getCheckpointVersion()

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
default String getDescription()

A description of the schema if specified when created.

getRegistry

@Stability(Stable)
@Nullable
default Object getRegistry()

The registry where a schema is stored.

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

AWS tags that contain a key value pair and may be searched by console, command line, or API.

builder

@Stability(Stable)
static CfnSchemaProps.Builder builder()

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps