Package software.amazon.awscdk.services.glue

Class CfnPartition

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.glue.CfnPartition
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:30:42.441Z") @Stability(Stable) public class CfnPartition extends CfnResource implements IInspectable
A CloudFormation AWS::Glue::Partition.

The AWS::Glue::Partition resource creates an AWS Glue partition, which represents a slice of table data. For more information, see CreatePartition Action and Partition 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;
 CfnPartition cfnPartition = CfnPartition.Builder.create(this, "MyCfnPartition")
         .catalogId("catalogId")
         .databaseName("databaseName")
         .partitionInput(PartitionInputProperty.builder()
                 .values(List.of("values"))
                 // the properties below are optional
                 .parameters(parameters)
                 .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")
                                 // the properties below are optional
                                 .sortOrder(123)
                                 .build()))
                         .storedAsSubDirectories(false)
                         .build())
                 .build())
         .tableName("tableName")
         .build();

  • 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

    • CfnPartition

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

    • CfnPartition

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

    • CfnPartition

      @Stability(Stable) public CfnPartition(@NotNull Construct scope, @NotNull String id, @NotNull CfnPartitionProps props)
      Create a new AWS::Glue::Partition.

      Parameters:
      scope -
      • scope in which this resource is defined.
      This parameter is required.
      id -
      • scoped id of the resource.
      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.

    • getCfnProperties

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

    • getCatalogId

      @Stability(Stable) @NotNull public String getCatalogId()
      The AWS account ID of the catalog in which the partion is to be created.

      To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

    • setCatalogId

      @Stability(Stable) public void setCatalogId(@NotNull String value)
      The AWS account ID of the catalog in which the partion is to be created.

      To specify the account ID, you can use the Ref intrinsic function with the AWS::AccountId pseudo parameter. For example: !Ref AWS::AccountId

    • getDatabaseName

      @Stability(Stable) @NotNull public String getDatabaseName()
      The name of the catalog database in which to create the partition.

    • setDatabaseName

      @Stability(Stable) public void setDatabaseName(@NotNull String value)
      The name of the catalog database in which to create the partition.

    • getPartitionInput

      @Stability(Stable) @NotNull public Object getPartitionInput()
      The structure used to create and update a partition.

    • setPartitionInput

      @Stability(Stable) public void setPartitionInput(@NotNull IResolvable value)
      The structure used to create and update a partition.

    • setPartitionInput

      @Stability(Stable) public void setPartitionInput(@NotNull CfnPartition.PartitionInputProperty value)
      The structure used to create and update a partition.

    • getTableName

      @Stability(Stable) @NotNull public String getTableName()
      The name of the metadata table in which the partition is to be created.

    • setTableName

      @Stability(Stable) public void setTableName(@NotNull String value)
      The name of the metadata table in which the partition is to be created.