Skip to content

CreateTableRequest

Source code in docs_src/capo_s3tables/types/create_table_request.py
class CreateTableRequest(TypedDict, closed=True):
    table_bucket_arn: "capo_s3tables.types.table_bucket_arn.TableBucketARN"
    """<p>The Amazon Resource Name (ARN) of the table bucket to create the table in.</p>"""
    namespace: "capo_s3tables.types.namespace_name.NamespaceName"
    """<p>The namespace to associated with the table.</p>"""
    name: "capo_s3tables.types.table_name.TableName"
    """<p>The name for the table.</p>"""
    format: "capo_s3tables.types.open_table_format.OpenTableFormat"
    """<p>The format for the table.</p>"""
    metadata: NotRequired["capo_s3tables.types.table_metadata.TableMetadata"]
    """<p>The metadata for the table.</p>"""
    encryption_configuration: NotRequired[
        "capo_s3tables.types.encryption_configuration.EncryptionConfiguration"
    ]
    """<p>The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table. </p> <note> <p>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>.</p> </note>"""
    storage_class_configuration: NotRequired[
        "capo_s3tables.types.storage_class_configuration.StorageClassConfiguration"
    ]
    """<p>The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.</p>"""
    tags: NotRequired["capo_s3tables.types.tags.Tags"]
    """<p>A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see <a href="https://docs.aws.amazon.com/AmazonS3/latest/userguide/tagging.html">Tagging for cost allocation or attribute-based access control (ABAC)</a>.</p> <note> <p>You must have the <code>s3tables:TagResource</code> permission in addition to <code>s3tables:CreateTable</code> permission to create a table with tags.</p> </note>"""

encryption_configuration instance-attribute

encryption_configuration: NotRequired[EncryptionConfiguration]

The encryption configuration to use for the table. This configuration specifies the encryption algorithm and, if using SSE-KMS, the KMS key to use for encrypting the table.

If you choose SSE-KMS encryption you must grant the S3 Tables maintenance principal access to your KMS key. For more information, see Permissions requirements for S3 Tables SSE-KMS encryption.

format instance-attribute

The format for the table.

metadata instance-attribute

metadata: NotRequired[TableMetadata]

The metadata for the table.

name instance-attribute

name: TableName

The name for the table.

namespace instance-attribute

namespace: NamespaceName

The namespace to associated with the table.

storage_class_configuration instance-attribute

storage_class_configuration: NotRequired[StorageClassConfiguration]

The storage class configuration for the table. If not specified, the table inherits the storage class configuration from its table bucket. Specify this parameter to override the bucket's default storage class for this table.

table_bucket_arn instance-attribute

table_bucket_arn: TableBucketARN

The Amazon Resource Name (ARN) of the table bucket to create the table in.

tags instance-attribute

tags: NotRequired[Tags]

A map of user-defined tags that you would like to apply to the table that you are creating. A tag is a key-value pair that you apply to your resources. Tags can help you organize, track costs for, and control access to resources. For more information, see Tagging for cost allocation or attribute-based access control (ABAC).

You must have the s3tables:TagResource permission in addition to s3tables:CreateTable permission to create a table with tags.