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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.570Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnSchema.Builder A fluent builder for CfnSchema.
static interface	CfnSchema.RegistryProperty Specifies a registry in the AWS Glue Schema Registry.
static interface	CfnSchema.SchemaVersionProperty Specifies the version of a schema.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnSchema(software.constructs.Construct scope, String id, CfnSchemaProps props) Create a new `AWS::Glue::Schema`.
protected	CfnSchema(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnSchema(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn() The Amazon Resource Name (ARN) of the schema.
String	getAttrInitialSchemaVersionId()
protected Map<String,Object>	getCfnProperties()
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.
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.
Object	getRegistry() The registry where a schema is stored.
String	getSchemaDefinition() The schema definition using the `DataFormat` setting for `SchemaName` .
TagManager	getTags() AWS tags that contain a key value pair and may be searched by console, command line, or API.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCheckpointVersion(CfnSchema.SchemaVersionProperty value) Specify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema.
void	setCheckpointVersion(IResolvable value) Specify the `VersionNumber` or the `IsLatest` for setting the checkpoint for the schema.
void	setCompatibility(String value) The compatibility mode of the schema.
void	setDataFormat(String value) The data format of the schema definition.
void	setDescription(String value) A description of the schema if specified when created.
void	setName(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.
void	setRegistry(CfnSchema.RegistryProperty value) The registry where a schema is stored.
void	setRegistry(IResolvable value) The registry where a schema is stored.
void	setSchemaDefinition(String value) The schema definition using the `DataFormat` setting for `SchemaName` .

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnSchema

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

CfnSchema

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

CfnSchema

@Stability(value=Stable)
public CfnSchema(@NotNull
                                          software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the schema.

getAttrInitialSchemaVersionId

@Stability(value=Stable)
 @NotNull
public String getAttrInitialSchemaVersionId()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=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(value=Stable)
 @NotNull
public String getCompatibility()

The compatibility mode of the schema.

setCompatibility

@Stability(value=Stable)
public void setCompatibility(@NotNull
                                                      String value)

The compatibility mode of the schema.

getDataFormat

@Stability(value=Stable)
 @NotNull
public String getDataFormat()

The data format of the schema definition.

Currently only AVRO is supported.

setDataFormat

@Stability(value=Stable)
public void setDataFormat(@NotNull
                                                   String value)

The data format of the schema definition.

Currently only AVRO is supported.

getName

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getSchemaDefinition()

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

setSchemaDefinition

@Stability(value=Stable)
public void setSchemaDefinition(@NotNull
                                                         String value)

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

getCheckpointVersion

@Stability(value=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(value=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.

setCheckpointVersion

@Stability(value=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.

getDescription

@Stability(value=Stable)
 @Nullable
public String getDescription()

A description of the schema if specified when created.

setDescription

@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)

A description of the schema if specified when created.

getRegistry

@Stability(value=Stable)
 @Nullable
public Object getRegistry()

The registry where a schema is stored.

setRegistry

@Stability(value=Stable)
public void setRegistry(@Nullable
                                                 CfnSchema.RegistryProperty value)

The registry where a schema is stored.

setRegistry

@Stability(value=Stable)
public void setRegistry(@Nullable
                                                 IResolvable value)

The registry where a schema is stored.