software.amazon.awscdk.services.glue

Class CfnPartition

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.CfnPartition

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:39.565Z")
 @Stability(value=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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnPartition.Builder A fluent builder for CfnPartition.
static interface	CfnPartition.ColumnProperty A column in a `Table` .
static interface	CfnPartition.OrderProperty Specifies the sort order of a sorted column.
static interface	CfnPartition.PartitionInputProperty The structure used to create and update a partition.
static interface	CfnPartition.SchemaIdProperty A structure that contains schema identity fields.
static interface	CfnPartition.SchemaReferenceProperty An object that references a schema stored in the AWS Glue Schema Registry.
static interface	CfnPartition.SerdeInfoProperty Information about a serialization/deserialization program (SerDe) that serves as an extractor and loader.
static interface	CfnPartition.SkewedInfoProperty Specifies skewed values in a table.
static interface	CfnPartition.StorageDescriptorProperty Describes the physical storage of table data.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnPartition(software.constructs.Construct scope, String id, CfnPartitionProps props) Create a new `AWS::Glue::Partition`.
protected	CfnPartition(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnPartition(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getCatalogId() The AWS account ID of the catalog in which the partion is to be created.
protected Map<String,Object>	getCfnProperties()
String	getDatabaseName() The name of the catalog database in which to create the partition.
Object	getPartitionInput() The structure used to create and update a partition.
String	getTableName() The name of the metadata table in which the partition is to be created.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setCatalogId(String value) The AWS account ID of the catalog in which the partion is to be created.
void	setDatabaseName(String value) The name of the catalog database in which to create the partition.
void	setPartitionInput(CfnPartition.PartitionInputProperty value) The structure used to create and update a partition.
void	setPartitionInput(IResolvable value) The structure used to create and update a partition.
void	setTableName(String value) The name of the metadata table in which the partition is to be created.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnPartition

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

CfnPartition

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

CfnPartition

@Stability(value=Stable)
public CfnPartition(@NotNull
                                             software.constructs.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 Detail

inspect

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getCatalogId

@Stability(value=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(value=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(value=Stable)
 @NotNull
public String getDatabaseName()

The name of the catalog database in which to create the partition.

setDatabaseName

@Stability(value=Stable)
public void setDatabaseName(@NotNull
                                                     String value)

The name of the catalog database in which to create the partition.

getPartitionInput

@Stability(value=Stable)
 @NotNull
public Object getPartitionInput()

The structure used to create and update a partition.

setPartitionInput

@Stability(value=Stable)
public void setPartitionInput(@NotNull
                                                       CfnPartition.PartitionInputProperty value)

The structure used to create and update a partition.

setPartitionInput

@Stability(value=Stable)
public void setPartitionInput(@NotNull
                                                       IResolvable value)

The structure used to create and update a partition.

getTableName

@Stability(value=Stable)
 @NotNull
public String getTableName()

The name of the metadata table in which the partition is to be created.

setTableName

@Stability(value=Stable)
public void setTableName(@NotNull
                                                  String value)

The name of the metadata table in which the partition is to be created.