Class CfnTablePropsMixin

Creates a new table associated with the given namespace in a table bucket.

Inheritance

object

Mixin

CfnTablePropsMixin

Implements

IMixin

Inherited Members

Mixin.IsMixin(object)

Namespace: Amazon.CDK.Mixins.Preview.AWS.S3Tables.Mixins

Assembly: Amazon.CDK.Mixins.Preview.dll

Syntax (csharp)

public class CfnTablePropsMixin : Mixin, IMixin

Syntax (vb)

Public Class CfnTablePropsMixin Inherits Mixin Implements IMixin

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

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.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3Tables.Mixins;

             var cfnTablePropsMixin = new CfnTablePropsMixin(new CfnTableMixinProps {
                 Compaction = new CompactionProperty {
                     Status = "status",
                     TargetFileSizeMb = 123
                 },
                 IcebergMetadata = new IcebergMetadataProperty {
                     IcebergSchema = new IcebergSchemaProperty {
                         SchemaFieldList = new [] { new SchemaFieldProperty {
                             Name = "name",
                             Required = false,
                             Type = "type"
                         } }
                     }
                 },
                 Namespace = "namespace",
                 OpenTableFormat = "openTableFormat",
                 SnapshotManagement = new SnapshotManagementProperty {
                     MaxSnapshotAgeHours = 123,
                     MinSnapshotsToKeep = 123,
                     Status = "status"
                 },
                 StorageClassConfiguration = new StorageClassConfigurationProperty {
                     StorageClass = "storageClass"
                 },
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WithoutMetadata = "withoutMetadata"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Synopsis

Constructors

CfnTablePropsMixin(ICfnTableMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::S3Tables::Table.

Properties

CFN_PROPERTY_KEYS	Creates a new table associated with the given namespace in a table bucket.
Props	Creates a new table associated with the given namespace in a table bucket.
Strategy	Creates a new table associated with the given namespace in a table bucket.

Methods

ApplyTo(IConstruct)	Apply the mixin properties to the construct.
Supports(IConstruct)	Check if this mixin supports the given construct.

Constructors

CfnTablePropsMixin(ICfnTableMixinProps, ICfnPropertyMixinOptions?)

Create a mixin to apply properties to AWS::S3Tables::Table.

public CfnTablePropsMixin(ICfnTableMixinProps props, ICfnPropertyMixinOptions? options = null)

Parameters

props ICfnTableMixinProps: L1 properties to apply.
options ICfnPropertyMixinOptions: Mixin options.

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

ExampleMetadata: fixture=_generated

Properties

CFN_PROPERTY_KEYS

Creates a new table associated with the given namespace in a table bucket.

protected static string[] CFN_PROPERTY_KEYS { get; }

Property Value

string[]

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

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.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3Tables.Mixins;

             var cfnTablePropsMixin = new CfnTablePropsMixin(new CfnTableMixinProps {
                 Compaction = new CompactionProperty {
                     Status = "status",
                     TargetFileSizeMb = 123
                 },
                 IcebergMetadata = new IcebergMetadataProperty {
                     IcebergSchema = new IcebergSchemaProperty {
                         SchemaFieldList = new [] { new SchemaFieldProperty {
                             Name = "name",
                             Required = false,
                             Type = "type"
                         } }
                     }
                 },
                 Namespace = "namespace",
                 OpenTableFormat = "openTableFormat",
                 SnapshotManagement = new SnapshotManagementProperty {
                     MaxSnapshotAgeHours = 123,
                     MinSnapshotsToKeep = 123,
                     Status = "status"
                 },
                 StorageClassConfiguration = new StorageClassConfigurationProperty {
                     StorageClass = "storageClass"
                 },
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WithoutMetadata = "withoutMetadata"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Props

Creates a new table associated with the given namespace in a table bucket.

protected virtual ICfnTableMixinProps Props { get; }

Property Value

ICfnTableMixinProps

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

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.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3Tables.Mixins;

             var cfnTablePropsMixin = new CfnTablePropsMixin(new CfnTableMixinProps {
                 Compaction = new CompactionProperty {
                     Status = "status",
                     TargetFileSizeMb = 123
                 },
                 IcebergMetadata = new IcebergMetadataProperty {
                     IcebergSchema = new IcebergSchemaProperty {
                         SchemaFieldList = new [] { new SchemaFieldProperty {
                             Name = "name",
                             Required = false,
                             Type = "type"
                         } }
                     }
                 },
                 Namespace = "namespace",
                 OpenTableFormat = "openTableFormat",
                 SnapshotManagement = new SnapshotManagementProperty {
                     MaxSnapshotAgeHours = 123,
                     MinSnapshotsToKeep = 123,
                     Status = "status"
                 },
                 StorageClassConfiguration = new StorageClassConfigurationProperty {
                     StorageClass = "storageClass"
                 },
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WithoutMetadata = "withoutMetadata"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Strategy

Creates a new table associated with the given namespace in a table bucket.

protected virtual PropertyMergeStrategy Strategy { get; }

Property Value

PropertyMergeStrategy

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

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.Mixins;
             using Amazon.CDK.Mixins.Preview.AWS.S3Tables.Mixins;

             var cfnTablePropsMixin = new CfnTablePropsMixin(new CfnTableMixinProps {
                 Compaction = new CompactionProperty {
                     Status = "status",
                     TargetFileSizeMb = 123
                 },
                 IcebergMetadata = new IcebergMetadataProperty {
                     IcebergSchema = new IcebergSchemaProperty {
                         SchemaFieldList = new [] { new SchemaFieldProperty {
                             Name = "name",
                             Required = false,
                             Type = "type"
                         } }
                     }
                 },
                 Namespace = "namespace",
                 OpenTableFormat = "openTableFormat",
                 SnapshotManagement = new SnapshotManagementProperty {
                     MaxSnapshotAgeHours = 123,
                     MinSnapshotsToKeep = 123,
                     Status = "status"
                 },
                 StorageClassConfiguration = new StorageClassConfigurationProperty {
                     StorageClass = "storageClass"
                 },
                 TableBucketArn = "tableBucketArn",
                 TableName = "tableName",
                 Tags = new [] { new CfnTag {
                     Key = "key",
                     Value = "value"
                 } },
                 WithoutMetadata = "withoutMetadata"
             }, new CfnPropertyMixinOptions {
                 Strategy = PropertyMergeStrategy.OVERRIDE
             });

Methods

ApplyTo(IConstruct)

Apply the mixin properties to the construct.

public override IConstruct ApplyTo(IConstruct construct)

Parameters

construct IConstruct

Returns

IConstruct

Overrides

Mixin.ApplyTo(IConstruct)

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

ExampleMetadata: fixture=_generated

Supports(IConstruct)

Check if this mixin supports the given construct.

public override bool Supports(IConstruct construct)

Parameters

construct IConstruct

Returns

bool

Overrides

Mixin.Supports(IConstruct)

Remarks

For more information, see Creating an Amazon S3 table in the Amazon Simple Storage Service User Guide .

Additionally, If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/s3-tables-kms-permissions.html">Permissions requirements for S3 Tables SSE-KMS encryption</a> .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-s3tables-table.html

Aws-cdk: /aws-s3tables-alpha`

Yarn: yarn add @aws-cdk/aws-s3tables-alpha

CloudformationResource: AWS::S3Tables::Table

Mixin: true

ExampleMetadata: fixture=_generated

Implements

IMixin