Package software.amazon.awscdk.services.glue

Class CfnCatalog

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.CfnCatalog
All Implemented Interfaces:
IInspectable, ICatalogRef, IEnvironmentAware, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)", date="2026-03-27T13:12:00.620Z") @Stability(Stable) public class CfnCatalog extends CfnResource implements IInspectable, ICatalogRef, ITaggableV2
Creates a catalog in the Glue Data Catalog.

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.*;
 CfnCatalog cfnCatalog = CfnCatalog.Builder.create(this, "MyCfnCatalog")
         .name("name")
         // the properties below are optional
         .allowFullTableExternalDataAccess("allowFullTableExternalDataAccess")
         .catalogProperties(CatalogPropertiesProperty.builder()
                 .customProperties(Map.of(
                         "customPropertiesKey", "customProperties"))
                 .dataLakeAccessProperties(DataLakeAccessPropertiesProperty.builder()
                         .allowFullTableExternalDataAccess("allowFullTableExternalDataAccess")
                         .catalogType("catalogType")
                         .dataLakeAccess(false)
                         .dataTransferRole("dataTransferRole")
                         .kmsKey("kmsKey")
                         .managedWorkgroupName("managedWorkgroupName")
                         .managedWorkgroupStatus("managedWorkgroupStatus")
                         .redshiftDatabaseName("redshiftDatabaseName")
                         .build())
                 .build())
         .createDatabaseDefaultPermissions(List.of(PrincipalPermissionsProperty.builder()
                 .permissions(List.of("permissions"))
                 .principal(DataLakePrincipalProperty.builder()
                         .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                         .build())
                 .build()))
         .createTableDefaultPermissions(List.of(PrincipalPermissionsProperty.builder()
                 .permissions(List.of("permissions"))
                 .principal(DataLakePrincipalProperty.builder()
                         .dataLakePrincipalIdentifier("dataLakePrincipalIdentifier")
                         .build())
                 .build()))
         .description("description")
         .federatedCatalog(FederatedCatalogProperty.builder()
                 .connectionName("connectionName")
                 .identifier("identifier")
                 .build())
         .overwriteChildResourcePermissionsWithDefault("overwriteChildResourcePermissionsWithDefault")
         .parameters(Map.of(
                 "parametersKey", "parameters"))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .targetRedshiftCatalog(TargetRedshiftCatalogProperty.builder()
                 .catalogArn("catalogArn")
                 .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

    • CfnCatalog

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

    • CfnCatalog

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

    • CfnCatalog

      @Stability(Stable) public CfnCatalog(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCatalogProps props)
      Create a new AWS::Glue::Catalog.

      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

    • isCfnCatalog

      @Stability(Stable) @NotNull public static Boolean isCfnCatalog(@NotNull Object x)
      Checks whether the given object is a CfnCatalog.

      Parameters:
      x - This parameter is required.

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

    • getAttrCatalogId

      @Stability(Stable) @NotNull public String getAttrCatalogId()
      The ID of the catalog.

    • getAttrCatalogPropertiesCustomProperties

      @Stability(Stable) @NotNull public IResolvable getAttrCatalogPropertiesCustomProperties()
      Additional key-value properties for the catalog.

    • getAttrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupName

      @Stability(Stable) @NotNull public String getAttrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupName()
      The name of the managed workgroup associated with the catalog.

    • getAttrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupStatus

      @Stability(Stable) @NotNull public String getAttrCatalogPropertiesDataLakeAccessPropertiesManagedWorkgroupStatus()
      The status of the managed workgroup.

    • getAttrCatalogPropertiesDataLakeAccessPropertiesRedshiftDatabaseName

      @Stability(Stable) @NotNull public String getAttrCatalogPropertiesDataLakeAccessPropertiesRedshiftDatabaseName()
      The name of the Redshift database.

    • getAttrCreateTime

      @Stability(Stable) @NotNull public Number getAttrCreateTime()
      The time at which the catalog was created.

    • getAttrResourceArn

      @Stability(Stable) @NotNull public String getAttrResourceArn()
      The Amazon Resource Name (ARN) of the catalog.

    • getAttrUpdateTime

      @Stability(Stable) @NotNull public Number getAttrUpdateTime()
      The time at which the catalog was last updated.

    • getCatalogRef

      @Stability(Stable) @NotNull public CatalogReference getCatalogRef()
      A reference to a Catalog resource.
      Specified by:
      getCatalogRef in interface ICatalogRef

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The name of the catalog to create.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The name of the catalog to create.

    • getAllowFullTableExternalDataAccess

      @Stability(Stable) @Nullable public String getAllowFullTableExternalDataAccess()
      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

    • setAllowFullTableExternalDataAccess

      @Stability(Stable) public void setAllowFullTableExternalDataAccess(@Nullable String value)
      Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

    • getCatalogProperties

      @Stability(Stable) @Nullable public Object getCatalogProperties()
      A structure that specifies data lake access properties and other custom properties.

      Returns union: either IResolvable or CfnCatalog.CatalogPropertiesProperty

    • setCatalogProperties

      @Stability(Stable) public void setCatalogProperties(@Nullable IResolvable value)
      A structure that specifies data lake access properties and other custom properties.

    • setCatalogProperties

      @Stability(Stable) public void setCatalogProperties(@Nullable CfnCatalog.CatalogPropertiesProperty value)
      A structure that specifies data lake access properties and other custom properties.

    • getCreateDatabaseDefaultPermissions

      @Stability(Stable) @Nullable public Object getCreateDatabaseDefaultPermissions()
      An array of PrincipalPermissions objects for default database permissions.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCatalog.PrincipalPermissionsProperty>

    • setCreateDatabaseDefaultPermissions

      @Stability(Stable) public void setCreateDatabaseDefaultPermissions(@Nullable IResolvable value)
      An array of PrincipalPermissions objects for default database permissions.

    • setCreateDatabaseDefaultPermissions

      @Stability(Stable) public void setCreateDatabaseDefaultPermissions(@Nullable List<Object> value)
      An array of PrincipalPermissions objects for default database permissions.

    • getCreateTableDefaultPermissions

      @Stability(Stable) @Nullable public Object getCreateTableDefaultPermissions()
      An array of PrincipalPermissions objects for default table permissions.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnCatalog.PrincipalPermissionsProperty>

    • setCreateTableDefaultPermissions

      @Stability(Stable) public void setCreateTableDefaultPermissions(@Nullable IResolvable value)
      An array of PrincipalPermissions objects for default table permissions.

    • setCreateTableDefaultPermissions

      @Stability(Stable) public void setCreateTableDefaultPermissions(@Nullable List<Object> value)
      An array of PrincipalPermissions objects for default table permissions.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description of the catalog.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description of the catalog.

    • getFederatedCatalog

      @Stability(Stable) @Nullable public Object getFederatedCatalog()
      A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

      Returns union: either IResolvable or CfnCatalog.FederatedCatalogProperty

    • setFederatedCatalog

      @Stability(Stable) public void setFederatedCatalog(@Nullable IResolvable value)
      A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

    • setFederatedCatalog

      @Stability(Stable) public void setFederatedCatalog(@Nullable CfnCatalog.FederatedCatalogProperty value)
      A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

    • getOverwriteChildResourcePermissionsWithDefault

      @Stability(Stable) @Nullable public String getOverwriteChildResourcePermissionsWithDefault()
      Specifies whether to overwrite child resource permissions with the default permissions.

    • setOverwriteChildResourcePermissionsWithDefault

      @Stability(Stable) public void setOverwriteChildResourcePermissionsWithDefault(@Nullable String value)
      Specifies whether to overwrite child resource permissions with the default permissions.

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      A map of key-value pairs that define parameters and properties of the catalog.

      Returns union: either Mapinvalid input: '<'String, String> or IResolvable

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable Map<String,String> value)
      A map of key-value pairs that define parameters and properties of the catalog.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      A map of key-value pairs that define parameters and properties of the catalog.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      An array of key-value pairs to apply to this resource.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      An array of key-value pairs to apply to this resource.

    • getTargetRedshiftCatalog

      @Stability(Stable) @Nullable public Object getTargetRedshiftCatalog()
      A structure that describes a target catalog for resource linking.

      Returns union: either IResolvable or CfnCatalog.TargetRedshiftCatalogProperty

    • setTargetRedshiftCatalog

      @Stability(Stable) public void setTargetRedshiftCatalog(@Nullable IResolvable value)
      A structure that describes a target catalog for resource linking.

    • setTargetRedshiftCatalog

      @Stability(Stable) public void setTargetRedshiftCatalog(@Nullable CfnCatalog.TargetRedshiftCatalogProperty value)
      A structure that describes a target catalog for resource linking.