Package software.amazon.awscdk.services.glue
package software.amazon.awscdk.services.glue
AWS Glue Construct Library
This module is part of the AWS Cloud Development Kit project.
import software.amazon.awscdk.services.glue.*;
There are no official hand-written (L2) constructs for this service yet. Here are some suggestions on how to proceed:
- Search Construct Hub for Glue construct libraries
- Use the automatically generated L1 constructs, in the same way you would use the CloudFormation AWS::Glue resources directly.
An experimental construct library for this service is available in preview. Since it is not stable yet, it is distributed as a separate package so that you can pin its version independently of the rest of the CDK. See the package:
@aws-cdk/aws-glue-alpha
There are no hand-written (L2) constructs for this service yet. However, you can still use the automatically generated L1 constructs, and use this service exactly as you would using CloudFormation directly.
For more information on the resources and properties available for this service, see the CloudFormation documentation for AWS::Glue.
(Read the CDK Contributing Guide and submit an RFC if you are interested in contributing to this construct library.)
-
ClassDescriptionThe
AWS::Glue::Classifierresource creates an AWS Glue classifier that categorizes data sources and specifies schemas.A fluent builder forCfnClassifier.A classifier for customCSVcontent.A builder forCfnClassifier.CsvClassifierPropertyAn implementation forCfnClassifier.CsvClassifierPropertyA classifier that usesgrokpatterns.A builder forCfnClassifier.GrokClassifierPropertyAn implementation forCfnClassifier.GrokClassifierPropertyA classifier forJSONcontent.A builder forCfnClassifier.JsonClassifierPropertyAn implementation forCfnClassifier.JsonClassifierPropertyA classifier forXMLcontent.A builder forCfnClassifier.XMLClassifierPropertyAn implementation forCfnClassifier.XMLClassifierPropertyProperties for defining aCfnClassifier.A builder forCfnClassifierPropsAn implementation forCfnClassifierPropsTheAWS::Glue::Connectionresource specifies an AWS Glue connection to a data source.A structure containing the authentication configuration in the CreateConnection request.A builder forCfnConnection.AuthenticationConfigurationInputPropertyAn implementation forCfnConnection.AuthenticationConfigurationInputPropertyThe set of properties required for the the OAuth2AUTHORIZATION_CODEgrant type workflow.A builder forCfnConnection.AuthorizationCodePropertiesPropertyAn implementation forCfnConnection.AuthorizationCodePropertiesPropertyFor supplying basic auth credentials when not providing aSecretArnvalue.A builder forCfnConnection.BasicAuthenticationCredentialsPropertyAn implementation forCfnConnection.BasicAuthenticationCredentialsPropertyA fluent builder forCfnConnection.A structure that is used to specify a connection to create or update.A builder forCfnConnection.ConnectionInputPropertyAn implementation forCfnConnection.ConnectionInputPropertyThe OAuth2 client app used for the connection.A builder forCfnConnection.OAuth2ClientApplicationPropertyAn implementation forCfnConnection.OAuth2ClientApplicationPropertyThe credentials used when the authentication type is OAuth2 authentication.A builder forCfnConnection.OAuth2CredentialsPropertyAn implementation forCfnConnection.OAuth2CredentialsPropertyA structure containing properties for OAuth2 in the CreateConnection request.A builder forCfnConnection.OAuth2PropertiesInputPropertyAn implementation forCfnConnection.OAuth2PropertiesInputPropertyThe OAuth client app in GetConnection response.A builder forCfnConnection.PhysicalConnectionRequirementsPropertyAn implementation forCfnConnection.PhysicalConnectionRequirementsPropertyProperties for defining aCfnConnection.A builder forCfnConnectionPropsAn implementation forCfnConnectionPropsTheAWS::Glue::Crawlerresource specifies an AWS Glue crawler.A fluent builder forCfnCrawler.Specifies an AWS Glue Data Catalog target.A builder forCfnCrawler.CatalogTargetPropertyAn implementation forCfnCrawler.CatalogTargetPropertySpecifies a Delta data store to crawl one or more Delta tables.A builder forCfnCrawler.DeltaTargetPropertyAn implementation forCfnCrawler.DeltaTargetPropertySpecifies an Amazon DynamoDB table to crawl.A builder forCfnCrawler.DynamoDBTargetPropertyAn implementation forCfnCrawler.DynamoDBTargetPropertySpecifies an Apache Hudi data source.A builder forCfnCrawler.HudiTargetPropertyAn implementation forCfnCrawler.HudiTargetPropertySpecifies Apache Iceberg data store targets.A builder forCfnCrawler.IcebergTargetPropertyAn implementation forCfnCrawler.IcebergTargetPropertySpecifies a JDBC data store to crawl.A builder forCfnCrawler.JdbcTargetPropertyAn implementation forCfnCrawler.JdbcTargetPropertySpecifies AWS Lake Formation configuration settings for the crawler.A builder forCfnCrawler.LakeFormationConfigurationPropertyAn implementation forCfnCrawler.LakeFormationConfigurationPropertySpecifies an Amazon DocumentDB or MongoDB data store to crawl.A builder forCfnCrawler.MongoDBTargetPropertyAn implementation forCfnCrawler.MongoDBTargetPropertyWhen crawling an Amazon S3 data source after the first crawl is complete, specifies whether to crawl the entire dataset again or to crawl only folders that were added since the last crawler run.A builder forCfnCrawler.RecrawlPolicyPropertyAn implementation forCfnCrawler.RecrawlPolicyPropertySpecifies a data store in Amazon Simple Storage Service (Amazon S3).A builder forCfnCrawler.S3TargetPropertyAn implementation forCfnCrawler.S3TargetPropertyA scheduling object using acronstatement to schedule an event.A builder forCfnCrawler.SchedulePropertyAn implementation forCfnCrawler.SchedulePropertyThe policy that specifies update and delete behaviors for the crawler.A builder forCfnCrawler.SchemaChangePolicyPropertyAn implementation forCfnCrawler.SchemaChangePolicyPropertySpecifies data stores to crawl.A builder forCfnCrawler.TargetsPropertyAn implementation forCfnCrawler.TargetsPropertyProperties for defining aCfnCrawler.A builder forCfnCrawlerPropsAn implementation forCfnCrawlerPropsCreates a custom pattern that is used to detect sensitive data across the columns and rows of your structured data.A fluent builder forCfnCustomEntityType.Properties for defining aCfnCustomEntityType.A builder forCfnCustomEntityTypePropsAn implementation forCfnCustomEntityTypePropsTheAWS::Glue::Databaseresource specifies a logical grouping of tables in AWS Glue .A fluent builder forCfnDatabase.A structure that describes a target database for resource linking.A builder forCfnDatabase.DatabaseIdentifierPropertyAn implementation forCfnDatabase.DatabaseIdentifierPropertyThe structure used to create or update a database.A builder forCfnDatabase.DatabaseInputPropertyAn implementation forCfnDatabase.DatabaseInputPropertyThe AWS Lake Formation principal.A builder forCfnDatabase.DataLakePrincipalPropertyAn implementation forCfnDatabase.DataLakePrincipalPropertyAFederatedDatabasestructure that references an entity outside the AWS Glue Data Catalog .A builder forCfnDatabase.FederatedDatabasePropertyAn implementation forCfnDatabase.FederatedDatabasePropertythe permissions granted to a principal.A builder forCfnDatabase.PrincipalPrivilegesPropertyAn implementation forCfnDatabase.PrincipalPrivilegesPropertyProperties for defining aCfnDatabase.A builder forCfnDatabasePropsAn implementation forCfnDatabasePropsSets the security configuration for a specified catalog.A fluent builder forCfnDataCatalogEncryptionSettings.The data structure used by the Data Catalog to encrypt the password as part ofCreateConnectionorUpdateConnectionand store it in theENCRYPTED_PASSWORDfield in the connection properties.An implementation forCfnDataCatalogEncryptionSettings.ConnectionPasswordEncryptionPropertyContains configuration information for maintaining Data Catalog security.An implementation forCfnDataCatalogEncryptionSettings.DataCatalogEncryptionSettingsPropertySpecifies the encryption-at-rest configuration for the Data Catalog.An implementation forCfnDataCatalogEncryptionSettings.EncryptionAtRestPropertyProperties for defining aCfnDataCatalogEncryptionSettings.A builder forCfnDataCatalogEncryptionSettingsPropsAn implementation forCfnDataCatalogEncryptionSettingsPropsTheAWS::Glue::DataQualityRulesetresource specifies a data quality ruleset with DQDL rules applied to a specified AWS Glue table.A fluent builder forCfnDataQualityRuleset.An object representing an AWS Glue table.A builder forCfnDataQualityRuleset.DataQualityTargetTablePropertyAn implementation forCfnDataQualityRuleset.DataQualityTargetTablePropertyProperties for defining aCfnDataQualityRuleset.A builder forCfnDataQualityRulesetPropsAn implementation forCfnDataQualityRulesetPropsTheAWS::Glue::DevEndpointresource specifies a development endpoint where a developer can remotely debug ETL scripts for AWS Glue .A fluent builder forCfnDevEndpoint.Properties for defining aCfnDevEndpoint.A builder forCfnDevEndpointPropsAn implementation forCfnDevEndpointPropsResource Type definition for AWS::Glue::IdentityCenterConfiguration.A fluent builder forCfnIdentityCenterConfiguration.Properties for defining aCfnIdentityCenterConfiguration.A builder forCfnIdentityCenterConfigurationPropsAn implementation forCfnIdentityCenterConfigurationPropsTheAWS::Glue::Integrationresource specifies an AWS Glue zero-ETL integration from a data source to a target.A fluent builder forCfnIntegration.Properties associated with the integration.A builder forCfnIntegration.IntegrationConfigPropertyAn implementation forCfnIntegration.IntegrationConfigPropertyProperties for defining aCfnIntegration.A builder forCfnIntegrationPropsAn implementation forCfnIntegrationPropsTheAWS::Glue::IntegrationResourcePropertyresource type can be used to setupResourcePropertyof the AWS Glue connection (for the SaaS source), DynamoDB Database (for DynamoDB source), or AWS Glue database ARN (for the target).A fluent builder forCfnIntegrationResourceProperty.The structure used to define the resource properties associated with the integration source.An implementation forCfnIntegrationResourceProperty.SourceProcessingPropertiesPropertyThe structure used to define the resource properties associated with the integration target.An implementation forCfnIntegrationResourceProperty.TargetProcessingPropertiesPropertyProperties for defining aCfnIntegrationResourceProperty.A builder forCfnIntegrationResourcePropertyPropsAn implementation forCfnIntegrationResourcePropertyPropsTheAWS::Glue::Jobresource specifies an AWS Glue job in the data catalog.A fluent builder forCfnJob.Specifies the connections used by a job.A builder forCfnJob.ConnectionsListPropertyAn implementation forCfnJob.ConnectionsListPropertyAn execution property of a job.A builder forCfnJob.ExecutionPropertyPropertyAn implementation forCfnJob.ExecutionPropertyPropertySpecifies code executed when a job is run.A builder forCfnJob.JobCommandPropertyAn implementation forCfnJob.JobCommandPropertySpecifies configuration properties of a notification.A builder forCfnJob.NotificationPropertyPropertyAn implementation forCfnJob.NotificationPropertyPropertyProperties for defining aCfnJob.A builder forCfnJobPropsAn implementation forCfnJobPropsThe AWS::Glue::MLTransform is an AWS Glue resource type that manages machine learning transforms.A fluent builder forCfnMLTransform.The parameters to configure the find matches transform.A builder forCfnMLTransform.FindMatchesParametersPropertyAn implementation forCfnMLTransform.FindMatchesParametersPropertyThe database and table in the AWS Glue Data Catalog that is used for input or output data.A builder forCfnMLTransform.GlueTablesPropertyAn implementation forCfnMLTransform.GlueTablesPropertyA list of AWS Glue table definitions used by the transform.A builder forCfnMLTransform.InputRecordTablesPropertyAn implementation forCfnMLTransform.InputRecordTablesPropertyThe encryption-at-rest settings of the transform that apply to accessing user data.A builder forCfnMLTransform.MLUserDataEncryptionPropertyAn implementation forCfnMLTransform.MLUserDataEncryptionPropertyThe encryption-at-rest settings of the transform that apply to accessing user data.A builder forCfnMLTransform.TransformEncryptionPropertyAn implementation forCfnMLTransform.TransformEncryptionPropertyThe algorithm-specific parameters that are associated with the machine learning transform.A builder forCfnMLTransform.TransformParametersPropertyAn implementation forCfnMLTransform.TransformParametersPropertyProperties for defining aCfnMLTransform.A builder forCfnMLTransformPropsAn implementation forCfnMLTransformPropsTheAWS::Glue::Partitionresource creates an AWS Glue partition, which represents a slice of table data.A fluent builder forCfnPartition.A column in aTable.A builder forCfnPartition.ColumnPropertyAn implementation forCfnPartition.ColumnPropertySpecifies the sort order of a sorted column.A builder forCfnPartition.OrderPropertyAn implementation forCfnPartition.OrderPropertyThe structure used to create and update a partition.A builder forCfnPartition.PartitionInputPropertyAn implementation forCfnPartition.PartitionInputPropertyA structure that contains schema identity fields.A builder forCfnPartition.SchemaIdPropertyAn implementation forCfnPartition.SchemaIdPropertyAn object that references a schema stored in the AWS Glue Schema Registry.A builder forCfnPartition.SchemaReferencePropertyAn implementation forCfnPartition.SchemaReferencePropertyInformation about a serialization/deserialization program (SerDe) that serves as an extractor and loader.A builder forCfnPartition.SerdeInfoPropertyAn implementation forCfnPartition.SerdeInfoPropertySpecifies skewed values in a table.A builder forCfnPartition.SkewedInfoPropertyAn implementation forCfnPartition.SkewedInfoPropertyDescribes the physical storage of table data.A builder forCfnPartition.StorageDescriptorPropertyAn implementation forCfnPartition.StorageDescriptorPropertyProperties for defining aCfnPartition.A builder forCfnPartitionPropsAn implementation forCfnPartitionPropsThe AWS::Glue::Registry is an AWS Glue resource type that manages registries of schemas in the AWS Glue Schema Registry.A fluent builder forCfnRegistry.Properties for defining aCfnRegistry.A builder forCfnRegistryPropsAn implementation forCfnRegistryPropsTheAWS::Glue::Schemais an AWS Glue resource type that manages schemas in the AWS Glue Schema Registry.A fluent builder forCfnSchema.Specifies a registry in the AWS Glue Schema Registry.A builder forCfnSchema.RegistryPropertyAn implementation forCfnSchema.RegistryPropertySpecifies the version of a schema.A builder forCfnSchema.SchemaVersionPropertyAn implementation forCfnSchema.SchemaVersionPropertyProperties for defining aCfnSchema.A builder forCfnSchemaPropsAn implementation forCfnSchemaPropsTheAWS::Glue::SchemaVersionis an AWS Glue resource type that manages schema versions of schemas in the AWS Glue Schema Registry.A fluent builder forCfnSchemaVersion.A wrapper structure to contain schema identity fields.A builder forCfnSchemaVersion.SchemaPropertyAn implementation forCfnSchemaVersion.SchemaPropertyTheAWS::Glue::SchemaVersionMetadatais an AWS Glue resource type that defines the metadata key-value pairs for a schema version in AWS Glue Schema Registry.A fluent builder forCfnSchemaVersionMetadata.Properties for defining aCfnSchemaVersionMetadata.A builder forCfnSchemaVersionMetadataPropsAn implementation forCfnSchemaVersionMetadataPropsProperties for defining aCfnSchemaVersion.A builder forCfnSchemaVersionPropsAn implementation forCfnSchemaVersionPropsCreates a new security configuration.A fluent builder forCfnSecurityConfiguration.Specifies how Amazon CloudWatch data should be encrypted.A builder forCfnSecurityConfiguration.CloudWatchEncryptionPropertyAn implementation forCfnSecurityConfiguration.CloudWatchEncryptionPropertySpecifies an encryption configuration.A builder forCfnSecurityConfiguration.EncryptionConfigurationPropertyAn implementation forCfnSecurityConfiguration.EncryptionConfigurationPropertySpecifies how job bookmark data should be encrypted.A builder forCfnSecurityConfiguration.JobBookmarksEncryptionPropertyAn implementation forCfnSecurityConfiguration.JobBookmarksEncryptionPropertySpecifies how Amazon Simple Storage Service (Amazon S3) data should be encrypted.A builder forCfnSecurityConfiguration.S3EncryptionPropertyAn implementation forCfnSecurityConfiguration.S3EncryptionPropertyProperties for defining aCfnSecurityConfiguration.A builder forCfnSecurityConfigurationPropsAn implementation forCfnSecurityConfigurationPropsTheAWS::Glue::Tableresource specifies tabular data in the AWS Glue data catalog.A fluent builder forCfnTable.A column in aTable.A builder forCfnTable.ColumnPropertyAn implementation forCfnTable.ColumnPropertySpecifies an input structure that defines an Apache Iceberg metadata table.A builder forCfnTable.IcebergInputPropertyAn implementation forCfnTable.IcebergInputPropertySpecifies anOpenTableFormatInputstructure when creating an open format table.A builder forCfnTable.OpenTableFormatInputPropertyAn implementation forCfnTable.OpenTableFormatInputPropertySpecifies the sort order of a sorted column.A builder forCfnTable.OrderPropertyAn implementation forCfnTable.OrderPropertyA structure that contains schema identity fields.A builder forCfnTable.SchemaIdPropertyAn implementation forCfnTable.SchemaIdPropertyAn object that references a schema stored in the AWS Glue Schema Registry.A builder forCfnTable.SchemaReferencePropertyAn implementation forCfnTable.SchemaReferencePropertyInformation about a serialization/deserialization program (SerDe) that serves as an extractor and loader.A builder forCfnTable.SerdeInfoPropertyAn implementation forCfnTable.SerdeInfoPropertySpecifies skewed values in a table.A builder forCfnTable.SkewedInfoPropertyAn implementation forCfnTable.SkewedInfoPropertyDescribes the physical storage of table data.A builder forCfnTable.StorageDescriptorPropertyAn implementation forCfnTable.StorageDescriptorPropertyA structure that describes a target table for resource linking.A builder forCfnTable.TableIdentifierPropertyAn implementation forCfnTable.TableIdentifierPropertyA structure used to define a table.A builder forCfnTable.TableInputPropertyAn implementation forCfnTable.TableInputPropertyAn AWS Glue resource for enabling table optimizers to improve read performance for open table formats.A fluent builder forCfnTableOptimizer.IcebergConfiguration is a property type within theAWS::Glue::TableOptimizerresource in AWS CloudFormation.A builder forCfnTableOptimizer.IcebergConfigurationPropertyAn implementation forCfnTableOptimizer.IcebergConfigurationPropertyExample:A builder forCfnTableOptimizer.IcebergRetentionConfigurationPropertyAn implementation forCfnTableOptimizer.IcebergRetentionConfigurationPropertyConfiguration for removing files that are are not tracked by the Iceberg table metadata, and are older than your configured age limit.An implementation forCfnTableOptimizer.OrphanFileDeletionConfigurationPropertyThe configuration for a snapshot retention optimizer for Apache Iceberg tables.A builder forCfnTableOptimizer.RetentionConfigurationPropertyAn implementation forCfnTableOptimizer.RetentionConfigurationPropertySpecifies configuration details of a table optimizer.A builder forCfnTableOptimizer.TableOptimizerConfigurationPropertyAn implementation forCfnTableOptimizer.TableOptimizerConfigurationPropertyAn object that describes the VPC configuration for a table optimizer.A builder forCfnTableOptimizer.VpcConfigurationPropertyAn implementation forCfnTableOptimizer.VpcConfigurationPropertyProperties for defining aCfnTableOptimizer.A builder forCfnTableOptimizerPropsAn implementation forCfnTableOptimizerPropsProperties for defining aCfnTable.A builder forCfnTablePropsAn implementation forCfnTablePropsTheAWS::Glue::Triggerresource specifies triggers that run AWS Glue jobs.Defines an action to be initiated by a trigger.A builder forCfnTrigger.ActionPropertyAn implementation forCfnTrigger.ActionPropertyA fluent builder forCfnTrigger.Defines a condition under which a trigger fires.A builder forCfnTrigger.ConditionPropertyAn implementation forCfnTrigger.ConditionPropertyBatch condition that must be met (specified number of events received or batch time window expired) before EventBridge event trigger fires.A builder forCfnTrigger.EventBatchingConditionPropertyAn implementation forCfnTrigger.EventBatchingConditionPropertySpecifies configuration properties of a job run notification.A builder forCfnTrigger.NotificationPropertyPropertyAn implementation forCfnTrigger.NotificationPropertyPropertyDefines the predicate of the trigger, which determines when it fires.A builder forCfnTrigger.PredicatePropertyAn implementation forCfnTrigger.PredicatePropertyProperties for defining aCfnTrigger.A builder forCfnTriggerPropsAn implementation forCfnTriggerPropsCreates an AWS Glue usage profile.A fluent builder forCfnUsageProfile.Specifies the values that an admin sets for each job or session parameter configured in a AWS Glue usage profile.A builder forCfnUsageProfile.ConfigurationObjectPropertyAn implementation forCfnUsageProfile.ConfigurationObjectPropertySpecifies the job and session values that an admin configures in an AWS Glue usage profile.A builder forCfnUsageProfile.ProfileConfigurationPropertyAn implementation forCfnUsageProfile.ProfileConfigurationPropertyProperties for defining aCfnUsageProfile.A builder forCfnUsageProfilePropsAn implementation forCfnUsageProfilePropsTheAWS::Glue::Workflowis an AWS Glue resource type that manages AWS Glue workflows.A fluent builder forCfnWorkflow.Properties for defining aCfnWorkflow.A builder forCfnWorkflowPropsAn implementation forCfnWorkflowProps