Package software.amazon.awscdk.services.glue

Interface CfnCatalogProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnCatalogProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.127.0 (build 2117ad5)",
           date="2026-03-27T13:12:00.624Z")
@Stability(Stable)
public interface CfnCatalogProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a CfnCatalog.

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.*;
 CfnCatalogProps cfnCatalogProps = CfnCatalogProps.builder()
         .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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnCatalogProps.Builder	A builder for CfnCatalogProps
static final class	CfnCatalogProps.Jsii$Proxy	An implementation for CfnCatalogProps

Method Summary

Modifier and Type	Method	Description
static CfnCatalogProps.Builder	builder()
default String	getAllowFullTableExternalDataAccess()	Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
default Object	getCatalogProperties()	A structure that specifies data lake access properties and other custom properties.
default Object	getCreateDatabaseDefaultPermissions()	An array of PrincipalPermissions objects for default database permissions.
default Object	getCreateTableDefaultPermissions()	An array of PrincipalPermissions objects for default table permissions.
default String	getDescription()	A description of the catalog.
default Object	getFederatedCatalog()	A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
String	getName()	The name of the catalog to create.
default String	getOverwriteChildResourcePermissionsWithDefault()	Specifies whether to overwrite child resource permissions with the default permissions.
default Object	getParameters()	A map of key-value pairs that define parameters and properties of the catalog.
default List<CfnTag>	getTags()	An array of key-value pairs to apply to this resource.
default Object	getTargetRedshiftCatalog()	A structure that describes a target catalog for resource linking.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The name of the catalog to create.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-name

getAllowFullTableExternalDataAccess

@Stability(Stable)
@Nullable
default String getAllowFullTableExternalDataAccess()

Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-allowfulltableexternaldataaccess

getCatalogProperties

@Stability(Stable)
@Nullable
default Object getCatalogProperties()

A structure that specifies data lake access properties and other custom properties.

Returns union: either IResolvable or CfnCatalog.CatalogPropertiesProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-catalogproperties

getCreateDatabaseDefaultPermissions

@Stability(Stable)
@Nullable
default Object getCreateDatabaseDefaultPermissions()

An array of PrincipalPermissions objects for default database permissions.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-createdatabasedefaultpermissions

getCreateTableDefaultPermissions

@Stability(Stable)
@Nullable
default Object getCreateTableDefaultPermissions()

An array of PrincipalPermissions objects for default table permissions.

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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-createtabledefaultpermissions

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description of the catalog.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-description

getFederatedCatalog

@Stability(Stable)
@Nullable
default Object getFederatedCatalog()

A FederatedCatalog structure that references an entity outside the Glue Data Catalog.

Returns union: either IResolvable or CfnCatalog.FederatedCatalogProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-federatedcatalog

getOverwriteChildResourcePermissionsWithDefault

@Stability(Stable)
@Nullable
default String getOverwriteChildResourcePermissionsWithDefault()

Specifies whether to overwrite child resource permissions with the default permissions.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-overwritechildresourcepermissionswithdefault

getParameters

@Stability(Stable)
@Nullable
default 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

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-parameters

getTags

@Stability(Stable)
@Nullable
default List<CfnTag> getTags()

An array of key-value pairs to apply to this resource.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-tags

getTargetRedshiftCatalog

@Stability(Stable)
@Nullable
default Object getTargetRedshiftCatalog()

A structure that describes a target catalog for resource linking.

Returns union: either IResolvable or CfnCatalog.TargetRedshiftCatalogProperty

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-glue-catalog.html#cfn-glue-catalog-targetredshiftcatalog

builder

@Stability(Stable)
static CfnCatalogProps.Builder builder()

Returns:

a CfnCatalogProps.Builder of CfnCatalogProps