Show / Hide Table of Contents

Class CfnSchemaMixinProps

Properties for CfnSchemaPropsMixin.

Inheritance
object
CfnSchemaMixinProps
Implements
ICfnSchemaMixinProps
Inherited Members
object.GetType()
object.MemberwiseClone()
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
Namespace: Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnSchemaMixinProps : ICfnSchemaMixinProps
Syntax (vb)
Public Class CfnSchemaMixinProps Implements ICfnSchemaMixinProps
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins;

             var cfnSchemaMixinProps = new CfnSchemaMixinProps {
                 CheckpointVersion = new SchemaVersionProperty {
                     IsLatest = false,
                     VersionNumber = 123
                 },
                 Compatibility = "compatibility",
                 DataFormat = "dataFormat",
                 Description = "description",
                 Name = "name",
                 Registry = new RegistryProperty {
                     Arn = "arn",
                     Name = "name"
                 },
                 SchemaDefinition = "schemaDefinition",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Synopsis

Constructors

CfnSchemaMixinProps()

Properties for CfnSchemaPropsMixin.

Properties

CheckpointVersion

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

Compatibility

The compatibility mode of the schema.

DataFormat

The data format of the schema definition.

Description

A description of the schema if specified when created.

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.

Registry

The registry where a schema is stored.

SchemaDefinition

The schema definition using the DataFormat setting for SchemaName .

Tags

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

Constructors

CfnSchemaMixinProps()

Properties for CfnSchemaPropsMixin.

public CfnSchemaMixinProps()
Remarks

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

ExampleMetadata: fixture=_generated

Examples
// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.Mixins.Preview.AWS.Glue.Mixins;

             var cfnSchemaMixinProps = new CfnSchemaMixinProps {
                 CheckpointVersion = new SchemaVersionProperty {
                     IsLatest = false,
                     VersionNumber = 123
                 },
                 Compatibility = "compatibility",
                 DataFormat = "dataFormat",
                 Description = "description",
                 Name = "name",
                 Registry = new RegistryProperty {
                     Arn = "arn",
                     Name = "name"
                 },
                 SchemaDefinition = "schemaDefinition",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } }
             };

Properties

CheckpointVersion

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

public object? CheckpointVersion { get; set; }
Property Value

object

Remarks

This is only required for updating a checkpoint.

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

Type union: either IResolvable or CfnSchemaPropsMixin.ISchemaVersionProperty

Compatibility

The compatibility mode of the schema.

public string? Compatibility { get; set; }
Property Value

string

Remarks

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

DataFormat

The data format of the schema definition.

public string? DataFormat { get; set; }
Property Value

string

Remarks

Currently only AVRO is supported.

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

Description

A description of the schema if specified when created.

public string? Description { get; set; }
Property Value

string

Remarks

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

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.

public string? Name { get; set; }
Property Value

string

Remarks

No whitespace.

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

Registry

The registry where a schema is stored.

public object? Registry { get; set; }
Property Value

object

Remarks

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

Type union: either IResolvable or CfnSchemaPropsMixin.IRegistryProperty

SchemaDefinition

The schema definition using the DataFormat setting for SchemaName .

public string? SchemaDefinition { get; set; }
Property Value

string

Remarks

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

Tags

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

public ICfnTag[]? Tags { get; set; }
Property Value

ICfnTag[]

Remarks

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

Implements

ICfnSchemaMixinProps
Back to top Generated by DocFX