Class TableBase
(experimental) A Glue table.
Inherited Members
Namespace: Amazon.CDK.AWS.Glue.Alpha
Assembly: Amazon.CDK.AWS.Glue.Alpha.dll
Syntax (csharp)
public abstract class TableBase : Resource, ITable, IResource
Syntax (vb)
Public MustInherit Class TableBase
Inherits Resource
Implements ITable, IResource
Remarks
Stability: Experimental
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.Alpha;
var tableBase = TableBase.FromTableArn(this, "MyTableBase", "tableArn");
Synopsis
Constructors
TableBase(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
TableBase(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
TableBase(Construct, String, ITableBaseProps) |
Properties
Columns | (experimental) This table's columns. |
Compressed | (experimental) Indicates whether the table's data is compressed or not. |
Database | (experimental) Database this table belongs to. |
DataFormat | (experimental) Format of this table's data files. |
Parameters | (experimental) The tables' properties associated with the table. |
PartitionIndexes | |
PartitionKeys | (experimental) This table's partition keys if the table is partitioned. |
StorageParameters | (experimental) The tables' storage descriptor properties. |
TableArn | |
TableName | |
TableResource |
Methods
AddPartitionIndex(IPartitionIndex) | (experimental) Add a partition index to the table. |
FromTableArn(Construct, String, String) | |
FromTableAttributes(Construct, String, ITableAttributes) | (experimental) Creates a Table construct that represents an external table. |
Grant(IGrantable, String[]) | (experimental) Grant the given identity custom permissions. |
GrantRead(IGrantable) | |
GrantReadWrite(IGrantable) | |
GrantToUnderlyingResources(IGrantable, String[]) | (experimental) Grant the given identity custom permissions to ALL underlying resources of the table. |
GrantWrite(IGrantable) |
Constructors
TableBase(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected TableBase(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
TableBase(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected TableBase(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
TableBase(Construct, String, ITableBaseProps)
protected TableBase(Construct scope, string id, ITableBaseProps props)
Parameters
- scope Constructs.Construct
- id System.String
- props ITableBaseProps
Remarks
Stability: Experimental
Properties
Columns
(experimental) This table's columns.
public virtual IColumn[] Columns { get; }
Property Value
IColumn[]
Remarks
Stability: Experimental
Compressed
(experimental) Indicates whether the table's data is compressed or not.
public virtual bool Compressed { get; }
Property Value
System.Boolean
Remarks
Stability: Experimental
Database
(experimental) Database this table belongs to.
public virtual IDatabase Database { get; }
Property Value
Remarks
Stability: Experimental
DataFormat
(experimental) Format of this table's data files.
public virtual DataFormat DataFormat { get; }
Property Value
Remarks
Stability: Experimental
Parameters
(experimental) The tables' properties associated with the table.
protected virtual IDictionary<string, string> Parameters { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.String>
Remarks
PartitionIndexes
public abstract IPartitionIndex[] PartitionIndexes { get; }
Property Value
Remarks
Stability: Experimental
PartitionKeys
(experimental) This table's partition keys if the table is partitioned.
public virtual IColumn[] PartitionKeys { get; }
Property Value
IColumn[]
Remarks
Stability: Experimental
StorageParameters
(experimental) The tables' storage descriptor properties.
public virtual StorageParameter[] StorageParameters { get; }
Property Value
Remarks
Stability: Experimental
TableArn
public abstract string TableArn { get; }
Property Value
System.String
Remarks
Stability: Experimental
TableName
public abstract string TableName { get; }
Property Value
System.String
Remarks
Stability: Experimental
TableResource
protected abstract CfnTable TableResource { get; }
Property Value
Remarks
Stability: Experimental
Methods
AddPartitionIndex(IPartitionIndex)
(experimental) Add a partition index to the table.
public virtual void AddPartitionIndex(IPartitionIndex index)
Parameters
- index IPartitionIndex
Remarks
You can have a maximum of 3 partition indexes to a table. Partition index keys must be a subset of the table's partition keys.
Stability: Experimental
See: https://docs.aws.amazon.com/glue/latest/dg/partition-indexes.html
FromTableArn(Construct, String, String)
public static ITable FromTableArn(Construct scope, string id, string tableArn)
Parameters
- scope Constructs.Construct
- id System.String
- tableArn System.String
Returns
Remarks
Stability: Experimental
FromTableAttributes(Construct, String, ITableAttributes)
(experimental) Creates a Table construct that represents an external table.
public static ITable FromTableAttributes(Construct scope, string id, ITableAttributes attrs)
Parameters
- scope Constructs.Construct
The scope creating construct (usually
this
).- id System.String
The construct's id.
- attrs ITableAttributes
Import attributes.
Returns
Remarks
Stability: Experimental
Grant(IGrantable, String[])
(experimental) Grant the given identity custom permissions.
public virtual Grant Grant(IGrantable grantee, string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
Remarks
Stability: Experimental
GrantRead(IGrantable)
public abstract Grant GrantRead(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental
GrantReadWrite(IGrantable)
public abstract Grant GrantReadWrite(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental
GrantToUnderlyingResources(IGrantable, String[])
(experimental) Grant the given identity custom permissions to ALL underlying resources of the table.
public virtual Grant GrantToUnderlyingResources(IGrantable grantee, string[] actions)
Parameters
- grantee IGrantable
- actions System.String[]
Returns
Remarks
Permissions will be granted to the catalog, the database, and the table.
Stability: Experimental
GrantWrite(IGrantable)
public abstract Grant GrantWrite(IGrantable grantee)
Parameters
- grantee IGrantable
Returns
Remarks
Stability: Experimental