software.amazon.awscdk.services.glue

Interface CfnSchemaProps

All Known Implementing Classes:

CfnSchemaProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.58.0 (build f8ba112)",
           date="2022-05-13T01:13:35.096Z")
public interface CfnSchemaProps

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 and Description
static class	CfnSchemaProps.Builder A builder for CfnSchemaProps
static class	CfnSchemaProps.Jsii$Proxy An implementation for CfnSchemaProps

Method Summary

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

Method Detail

getCompatibility

java.lang.String getCompatibility()

The compatibility mode of the schema.

getDataFormat

java.lang.String getDataFormat()

The data format of the schema definition.

Currently only AVRO is supported.

getName

java.lang.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

java.lang.String getSchemaDefinition()

The schema definition using the `DataFormat` setting for `SchemaName` .

getCheckpointVersion

default java.lang.Object getCheckpointVersion()

Specify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema.

This is only required for updating a checkpoint.

getDescription

default java.lang.String getDescription()

A description of the schema if specified when created.

getRegistry

default java.lang.Object getRegistry()

The registry where a schema is stored.

getTags

default java.util.List<CfnTag> getTags()

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

builder

static CfnSchemaProps.Builder builder()

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps