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.104.0 (build e79254c)",
           date="2024-11-22T02:24:02.480Z")
@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")
         // 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-compatibility

getDataFormat

@Stability(Stable)
@NotNull
String getDataFormat()

The data format of the schema definition.

Currently only AVRO is supported.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-dataformat

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-name

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-checkpointversion

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the schema if specified when created.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-description

getRegistry

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

The registry where a schema is stored.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-registry

getSchemaDefinition

@Stability(Stable)
@Nullable
default String getSchemaDefinition()

The schema definition using the DataFormat setting for SchemaName .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-schemadefinition

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.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-schema.html#cfn-glue-schema-tags

builder

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

Returns:

a CfnSchemaProps.Builder of CfnSchemaProps