Class S3Table

(experimental) A Glue table that targets a S3 dataset.

Inheritance
object
Resource
TableBase
S3Table
Table
Implements
IConstruct
IDependable
Inherited Members
Namespace: Amazon.CDK.AWS.Glue.Alpha
Assembly: Amazon.CDK.AWS.Glue.Alpha.dll
Syntax (csharp)
public class S3Table : TableBase, ITable, IResource, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class S3Table Inherits TableBase Implements ITable, IResource, IConstruct, IDependable, IEnvironmentAware
Remarks

Stability: Experimental

Resource: AWS::Glue::Table

ExampleMetadata: infused

Examples
Database myDatabase;

             new S3Table(this, "MyTable", new S3TableProps {
                 Database = myDatabase,
                 Columns = new [] { new Column {
                     Name = "col1",
                     Type = Schema.STRING
                 } },
                 PartitionKeys = new [] { new Column {
                     Name = "year",
                     Type = Schema.SMALL_INT
                 }, new Column {
                     Name = "month",
                     Type = Schema.SMALL_INT
                 } },
                 DataFormat = DataFormat.JSON,
                 EnablePartitionFiltering = true
             });

Synopsis

Constructors

S3Table(Construct, string, IS3TableProps)

(experimental) A Glue table that targets a S3 dataset.

Properties

Bucket

(experimental) S3 bucket in which the table's data resides.
Encryption

(experimental) The type of encryption enabled for the table.
EncryptionKey

(experimental) The KMS key used to secure the data if encryption is set to CSE-KMS or SSE-KMS.
PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.
PartitionIndexes

(experimental) This table's partition indexes.
S3Prefix

(experimental) S3 Key Prefix under which this table's files are stored in S3.
TableArn

(experimental) ARN of this table.
TableName

(experimental) Name of this table.
TableResource

(experimental) A Glue table that targets a S3 dataset.

Methods

GenerateS3PrefixForGrant()

(experimental) A Glue table that targets a S3 dataset.
GrantRead(IGrantable)

(experimental) Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.
GrantReadWrite(IGrantable)

(experimental) Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.
GrantWrite(IGrantable)

(experimental) Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.

Constructors

S3Table(Construct, string, IS3TableProps)

(experimental) A Glue table that targets a S3 dataset.

public S3Table(Construct scope, string id, IS3TableProps props)
Parameters
scope Construct
id string
props IS3TableProps
Remarks

Stability: Experimental

Properties

Bucket

(experimental) S3 bucket in which the table's data resides.

public virtual IBucket Bucket { get; }
Property Value

IBucket

Remarks

Stability: Experimental

Encryption

(experimental) The type of encryption enabled for the table.

public virtual TableEncryption Encryption { get; }
Property Value

TableEncryption

Remarks

Stability: Experimental

EncryptionKey

(experimental) The KMS key used to secure the data if encryption is set to CSE-KMS or SSE-KMS.

public virtual IKey? EncryptionKey { get; }
Property Value

IKey

Remarks

Otherwise, undefined.

Stability: Experimental

PROPERTY_INJECTION_ID

(experimental) Uniquely identifies this class.

public static string PROPERTY_INJECTION_ID { get; }
Property Value

string

Remarks

Stability: Experimental

PartitionIndexes

(experimental) This table's partition indexes.

public override IPartitionIndex[]? PartitionIndexes { get; }
Property Value

IPartitionIndex[]

Overrides
Remarks

Stability: Experimental

S3Prefix

(experimental) S3 Key Prefix under which this table's files are stored in S3.

public virtual string S3Prefix { get; }
Property Value

string

Remarks

Stability: Experimental

TableArn

(experimental) ARN of this table.

public override string TableArn { get; }
Property Value

string

Overrides
Remarks

Stability: Experimental

TableName

(experimental) Name of this table.

public override string TableName { get; }
Property Value

string

Overrides
Remarks

Stability: Experimental

TableResource

(experimental) A Glue table that targets a S3 dataset.

protected override CfnTable TableResource { get; }
Property Value

CfnTable

Overrides
Remarks

Stability: Experimental

Methods

GenerateS3PrefixForGrant()

(experimental) A Glue table that targets a S3 dataset.

protected virtual string GenerateS3PrefixForGrant()
Returns

string

Remarks

Stability: Experimental

GrantRead(IGrantable)

(experimental) Grant read permissions to the table and the underlying data stored in S3 to an IAM principal.

public override Grant GrantRead(IGrantable grantee)
Parameters
grantee IGrantable

the principal.

Returns

Grant

Overrides
Remarks

Stability: Experimental

GrantReadWrite(IGrantable)

(experimental) Grant read and write permissions to the table and the underlying data stored in S3 to an IAM principal.

public override Grant GrantReadWrite(IGrantable grantee)
Parameters
grantee IGrantable

the principal.

Returns

Grant

Overrides
Remarks

Stability: Experimental

GrantWrite(IGrantable)

(experimental) Grant write permissions to the table and the underlying data stored in S3 to an IAM principal.

public override Grant GrantWrite(IGrantable grantee)
Parameters
grantee IGrantable

the principal.

Returns

Grant

Overrides
Remarks

Stability: Experimental

Implements

Constructs.IConstruct
Constructs.IDependable