Package software.amazon.awscdk.services.glue

Class CfnTable

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.glue.CfnTable
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:17.788Z") @Stability(Stable) public class CfnTable extends CfnResource implements IInspectable
The AWS::Glue::Table resource specifies tabular data in the AWS Glue data catalog.

For more information, see Defining Tables in the AWS Glue Data Catalog and Table Structure in the AWS Glue Developer Guide .

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.glue.*;
 Object parameters;
 Object skewedColumnValueLocationMaps;
 CfnTable cfnTable = CfnTable.Builder.create(this, "MyCfnTable")
         .catalogId("catalogId")
         .databaseName("databaseName")
         .tableInput(TableInputProperty.builder()
                 .description("description")
                 .name("name")
                 .owner("owner")
                 .parameters(parameters)
                 .partitionKeys(List.of(ColumnProperty.builder()
                         .name("name")
                         // the properties below are optional
                         .comment("comment")
                         .type("type")
                         .build()))
                 .retention(123)
                 .storageDescriptor(StorageDescriptorProperty.builder()
                         .bucketColumns(List.of("bucketColumns"))
                         .columns(List.of(ColumnProperty.builder()
                                 .name("name")
                                 // the properties below are optional
                                 .comment("comment")
                                 .type("type")
                                 .build()))
                         .compressed(false)
                         .inputFormat("inputFormat")
                         .location("location")
                         .numberOfBuckets(123)
                         .outputFormat("outputFormat")
                         .parameters(parameters)
                         .schemaReference(SchemaReferenceProperty.builder()
                                 .schemaId(SchemaIdProperty.builder()
                                         .registryName("registryName")
                                         .schemaArn("schemaArn")
                                         .schemaName("schemaName")
                                         .build())
                                 .schemaVersionId("schemaVersionId")
                                 .schemaVersionNumber(123)
                                 .build())
                         .serdeInfo(SerdeInfoProperty.builder()
                                 .name("name")
                                 .parameters(parameters)
                                 .serializationLibrary("serializationLibrary")
                                 .build())
                         .skewedInfo(SkewedInfoProperty.builder()
                                 .skewedColumnNames(List.of("skewedColumnNames"))
                                 .skewedColumnValueLocationMaps(skewedColumnValueLocationMaps)
                                 .skewedColumnValues(List.of("skewedColumnValues"))
                                 .build())
                         .sortColumns(List.of(OrderProperty.builder()
                                 .column("column")
                                 .sortOrder(123)
                                 .build()))
                         .storedAsSubDirectories(false)
                         .build())
                 .tableType("tableType")
                 .targetTable(TableIdentifierProperty.builder()
                         .catalogId("catalogId")
                         .databaseName("databaseName")
                         .name("name")
                         .region("region")
                         .build())
                 .viewExpandedText("viewExpandedText")
                 .viewOriginalText("viewOriginalText")
                 .build())
         // the properties below are optional
         .openTableFormatInput(OpenTableFormatInputProperty.builder()
                 .icebergInput(IcebergInputProperty.builder()
                         .metadataOperation("metadataOperation")
                         .version("version")
                         .build())
                 .build())
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnTable

      protected CfnTable(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnTable

      protected CfnTable(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnTable

      @Stability(Stable) public CfnTable(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnTableProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCatalogId

      @Stability(Stable) @NotNull public String getCatalogId()
      The ID of the Data Catalog in which to create the Table .

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@NotNull String value)
      The ID of the Data Catalog in which to create the Table .

    • getDatabaseName

      @Stability(Stable) @NotNull public String getDatabaseName()
      The name of the database where the table metadata resides.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@NotNull String value)
      The name of the database where the table metadata resides.

    • getTableInput

      @Stability(Stable) @NotNull public Object getTableInput()
      A structure used to define a table.

    • setTableInput

      @Stability(Stable) public void setTableInput(@NotNull IResolvable value)
      A structure used to define a table.

    • setTableInput

      @Stability(Stable) public void setTableInput(@NotNull CfnTable.TableInputProperty value)
      A structure used to define a table.

    • getOpenTableFormatInput

      @Stability(Stable) @Nullable public Object getOpenTableFormatInput()
      Specifies an OpenTableFormatInput structure when creating an open format table.

    • setOpenTableFormatInput

      @Stability(Stable) public void setOpenTableFormatInput(@Nullable IResolvable value)
      Specifies an OpenTableFormatInput structure when creating an open format table.

    • setOpenTableFormatInput

      @Stability(Stable) public void setOpenTableFormatInput(@Nullable CfnTable.OpenTableFormatInputProperty value)
      Specifies an OpenTableFormatInput structure when creating an open format table.