Package software.amazon.awscdk.services.glue

Class CfnSchema.Builder

java.lang.Object

software.amazon.awscdk.services.glue.CfnSchema.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<CfnSchema>

Enclosing class:

CfnSchema

@Stability(Stable)
public static final class CfnSchema.Builder
extends Object
implements software.amazon.jsii.Builder<CfnSchema>

A fluent builder for CfnSchema.

Method Summary

Modifier and Type	Method	Description
CfnSchema	build()
CfnSchema.Builder	checkpointVersion(IResolvable checkpointVersion)	Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.
CfnSchema.Builder	checkpointVersion(CfnSchema.SchemaVersionProperty checkpointVersion)	Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema.
CfnSchema.Builder	compatibility(String compatibility)	The compatibility mode of the schema.
static CfnSchema.Builder	create(software.constructs.Construct scope, String id)
CfnSchema.Builder	dataFormat(String dataFormat)	The data format of the schema definition.
CfnSchema.Builder	description(String description)	A description of the schema if specified when created.
CfnSchema.Builder	name(String name)	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.
CfnSchema.Builder	registry(IResolvable registry)	The registry where a schema is stored.
CfnSchema.Builder	registry(CfnSchema.RegistryProperty registry)	The registry where a schema is stored.
CfnSchema.Builder	schemaDefinition(String schemaDefinition)	The schema definition using the DataFormat setting for SchemaName .
CfnSchema.Builder	tags(List<? extends CfnTag> tags)	AWS tags that contain a key value pair and may be searched by console, command line, or API.

Methods inherited from class java.lang.Object

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

Method Details

create

@Stability(Stable)
public static CfnSchema.Builder create(software.constructs.Construct scope,
 String id)

Parameters:

scope - Scope in which this resource is defined. This parameter is required.

id - Construct identifier for this resource (unique in its scope). This parameter is required.

Returns:

a new instance of CfnSchema.Builder.

compatibility

@Stability(Stable)
public CfnSchema.Builder compatibility(String compatibility)

The compatibility mode of the schema.

Parameters:

compatibility - The compatibility mode of the schema. This parameter is required.

Returns:

this

See Also:

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

dataFormat

@Stability(Stable)
public CfnSchema.Builder dataFormat(String dataFormat)

The data format of the schema definition.

Currently only AVRO is supported.

Parameters:

dataFormat - The data format of the schema definition. This parameter is required.

Returns:

this

See Also:

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

name

@Stability(Stable)
public CfnSchema.Builder name(String name)

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.

Parameters:

name - 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. This parameter is required.

Returns:

this

See Also:

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

checkpointVersion

@Stability(Stable)
public CfnSchema.Builder checkpointVersion(IResolvable checkpointVersion)

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

This is only required for updating a checkpoint.

Parameters:

checkpointVersion - Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This parameter is required.

Returns:

this

See Also:

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

checkpointVersion

@Stability(Stable)
public CfnSchema.Builder checkpointVersion(CfnSchema.SchemaVersionProperty checkpointVersion)

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

This is only required for updating a checkpoint.

Parameters:

checkpointVersion - Specify the VersionNumber or the IsLatest for setting the checkpoint for the schema. This parameter is required.

Returns:

this

See Also:

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

description

@Stability(Stable)
public CfnSchema.Builder description(String description)

A description of the schema if specified when created.

Parameters:

description - A description of the schema if specified when created. This parameter is required.

Returns:

this

See Also:

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

registry

@Stability(Stable)
public CfnSchema.Builder registry(IResolvable registry)

The registry where a schema is stored.

Parameters:

registry - The registry where a schema is stored. This parameter is required.

Returns:

this

See Also:

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

registry

@Stability(Stable)
public CfnSchema.Builder registry(CfnSchema.RegistryProperty registry)

The registry where a schema is stored.

Parameters:

registry - The registry where a schema is stored. This parameter is required.

Returns:

this

See Also:

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

schemaDefinition

@Stability(Stable)
public CfnSchema.Builder schemaDefinition(String schemaDefinition)

The schema definition using the DataFormat setting for SchemaName .

Parameters:

schemaDefinition - The schema definition using the DataFormat setting for SchemaName . This parameter is required.

Returns:

this

See Also:

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

tags

@Stability(Stable)
public CfnSchema.Builder tags(List<? extends CfnTag> tags)

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

Parameters:

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

Returns:

this

See Also:

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

build

@Stability(Stable)
public CfnSchema build()

Specified by:

build in interface software.amazon.jsii.Builder<CfnSchema>

Returns:

a newly built instance of CfnSchema.