Class CfnSchema

A CloudFormation AWS::Glue::Schema.

Inheritance

System.Object

Construct

CfnElement

CfnRefElement

CfnResource

CfnSchema

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable

Inherited Members

CfnResource.IsCfnResource(IConstruct)

CfnResource.AddDeletionOverride(String)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(String, Object)

CfnResource.AddOverride(String, Object)

CfnResource.AddPropertyDeletionOverride(String)

CfnResource.AddPropertyOverride(String, Object)

CfnResource.ApplyRemovalPolicy(Nullable<RemovalPolicy>, IRemovalPolicyOptions)

CfnResource.GetAtt(String)

CfnResource.GetMetadata(String)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(Object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.UpdatedProperites

CfnRefElement.Ref

CfnElement.IsCfnElement(Object)

CfnElement.OverrideLogicalId(String)

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Construct.IsConstruct(Object)

Construct.OnPrepare()

Construct.OnSynthesize(ISynthesisSession)

Construct.OnValidate()

Construct.Prepare()

Construct.Synthesize(ISynthesisSession)

Construct.Validate()

Construct.Node

Namespace: Amazon.CDK.AWS.Glue

Assembly: Amazon.CDK.AWS.Glue.dll

Syntax (csharp)

public class CfnSchema : CfnResource, IConstruct, IConstruct, IDependable, IInspectable

Syntax (vb)

Public Class CfnSchema
    Inherits CfnResource
    Implements IConstruct, IConstruct, IDependable, IInspectable

Remarks

The AWS::Glue::Schema is an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.

CloudformationResource: AWS::Glue::Schema

Link: 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.AWS.Glue;

CfnSchema cfnSchema = new CfnSchema(this, "MyCfnSchema", new CfnSchemaProps {
    Compatibility = "compatibility",
    DataFormat = "dataFormat",
    Name = "name",
    SchemaDefinition = "schemaDefinition",

    // the properties below are optional
    CheckpointVersion = new SchemaVersionProperty {
        IsLatest = false,
        VersionNumber = 123
    },
    Description = "description",
    Registry = new RegistryProperty {
        Arn = "arn",
        Name = "name"
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
});

Synopsis

Constructors

CfnSchema(Construct, String, ICfnSchemaProps)	Create a new `AWS::Glue::Schema`.
CfnSchema(ByRefValue)	Used by jsii to construct an instance of this class from a Javascript-owned object reference
CfnSchema(DeputyBase.DeputyProps)	Used by jsii to construct an instance of this class from DeputyProps

Properties

AttrArn	The Amazon Resource Name (ARN) of the schema.
AttrInitialSchemaVersionId
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties
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.

Methods

Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
RenderProperties(IDictionary<String, Object>)

Constructors

CfnSchema(Construct, String, ICfnSchemaProps)

Create a new AWS::Glue::Schema.

public CfnSchema(Construct scope, string id, ICfnSchemaProps props)

Parameters

scope Construct

scope in which this resource is defined.

id System.String

scoped id of the resource.

props ICfnSchemaProps

resource properties.

CfnSchema(ByRefValue)

Used by jsii to construct an instance of this class from a Javascript-owned object reference

protected CfnSchema(ByRefValue reference)

Parameters

reference Amazon.JSII.Runtime.Deputy.ByRefValue: The Javascript-owned object reference

CfnSchema(DeputyBase.DeputyProps)

Used by jsii to construct an instance of this class from DeputyProps

protected CfnSchema(DeputyBase.DeputyProps props)

Parameters

props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps: The deputy props

Properties

AttrArn

The Amazon Resource Name (ARN) of the schema.

public virtual string AttrArn { get; }

Property Value

System.String

Remarks

CloudformationAttribute: Arn

AttrInitialSchemaVersionId

public virtual string AttrInitialSchemaVersionId { get; }

Property Value

System.String

Remarks

CloudformationAttribute: InitialSchemaVersionId

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

System.String

CfnProperties

protected override IDictionary<string, object> CfnProperties { get; }

Property Value

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.CfnProperties

CheckpointVersion

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

public virtual object CheckpointVersion { get; set; }

Property Value

System.Object

Remarks

This is only required for updating a checkpoint.

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

Compatibility

The compatibility mode of the schema.

public virtual string Compatibility { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual string DataFormat { get; set; }

Property Value

System.String

Remarks

Currently only AVRO is supported.

Link: 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 virtual string Description { get; set; }

Property Value

System.String

Remarks

Link: 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 virtual string Name { get; set; }

Property Value

System.String

Remarks

No whitespace.

Link: 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 virtual object Registry { get; set; }

Property Value

System.Object

Remarks

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

SchemaDefinition

The schema definition using the DataFormat setting for SchemaName .

public virtual string SchemaDefinition { get; set; }

Property Value

System.String

Remarks

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

Methods

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector

tree inspector to collect and process attributes.

RenderProperties(IDictionary<String, Object>)

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props System.Collections.Generic.IDictionary<System.String, System.Object>

Returns

System.Collections.Generic.IDictionary<System.String, System.Object>

Overrides

CfnResource.RenderProperties(IDictionary<String, Object>)

Implements

IConstruct

Constructs.IConstruct

IDependable

IInspectable