Skip to content
v2.274.0

CfnCatalogProps Struct ​

Properties for defining a CfnCatalog.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_glue as glue } from 'aws-cdk-lib';
const cfnCatalogProps: glue.CfnCatalogProps = {
  name: 'name',

  // the properties below are optional
  allowFullTableExternalDataAccess: 'allowFullTableExternalDataAccess',
  catalogProperties: {
    customProperties: {
      customPropertiesKey: 'customProperties',
    },
    dataLakeAccessProperties: {
      allowFullTableExternalDataAccess: 'allowFullTableExternalDataAccess',
      catalogType: 'catalogType',
      dataLakeAccess: false,
      dataTransferRole: 'dataTransferRole',
      kmsKey: 'kmsKey',
      managedWorkgroupName: 'managedWorkgroupName',
      managedWorkgroupStatus: 'managedWorkgroupStatus',
      redshiftDatabaseName: 'redshiftDatabaseName',
    },
  },
  createDatabaseDefaultPermissions: [{
    permissions: ['permissions'],
    principal: {
      dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
    },
  }],
  createTableDefaultPermissions: [{
    permissions: ['permissions'],
    principal: {
      dataLakePrincipalIdentifier: 'dataLakePrincipalIdentifier',
    },
  }],
  description: 'description',
  federatedCatalog: {
    connectionName: 'connectionName',
    identifier: 'identifier',
  },
  overwriteChildResourcePermissionsWithDefault: 'overwriteChildResourcePermissionsWithDefault',
  parameters: {
    parametersKey: 'parameters',
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
  targetRedshiftCatalog: {
    catalogArn: 'catalogArn',
  },
};

Properties ​

allowFullTableExternalDataAccessoptionalstringallow_full_table_external_data_accessoptionalstrallowFullTableExternalDataAccessoptionalStringAllowFullTableExternalDataAccessoptionalstringAllowFullTableExternalDataAccessoptional*string#
Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
catalogPropertiesoptionalIResolvable | CfnCatalog.CatalogPropertiesPropertycatalog_propertiesoptionaltyping.Union[IResolvable, CatalogPropertiesProperty]catalogPropertiesoptionalIResolvableCatalogPropertiesoptionalIResolvableCatalogPropertiesoptionalinterface{}#
A structure that specifies data lake access properties and other custom properties.
createDatabaseDefaultPermissionsoptionalIResolvable | IResolvable | CfnCatalog.PrincipalPermissionsProperty[]create_database_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createDatabaseDefaultPermissionsoptionalIResolvableCreateDatabaseDefaultPermissionsoptionalIResolvableCreateDatabaseDefaultPermissionsoptionalinterface{}#
An array of PrincipalPermissions objects for default database permissions.
createTableDefaultPermissionsoptionalIResolvable | IResolvable | CfnCatalog.PrincipalPermissionsProperty[]create_table_default_permissionsoptionaltyping.Union[IResolvable, typing.List[typing.Union[IResolvable, PrincipalPermissionsProperty]]]createTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalIResolvableCreateTableDefaultPermissionsoptionalinterface{}#
An array of PrincipalPermissions objects for default table permissions.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
A description of the catalog.
federatedCatalogoptionalIResolvable | CfnCatalog.FederatedCatalogPropertyfederated_catalogoptionaltyping.Union[IResolvable, FederatedCatalogProperty]federatedCatalogoptionalIResolvableFederatedCatalogoptionalIResolvableFederatedCatalogoptionalinterface{}#
A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
namestringnamestrnameStringNamestringName*stringrequired#
The name of the catalog to create.
overwriteChildResourcePermissionsWithDefaultoptionalstringoverwrite_child_resource_permissions_with_defaultoptionalstroverwriteChildResourcePermissionsWithDefaultoptionalStringOverwriteChildResourcePermissionsWithDefaultoptionalstringOverwriteChildResourcePermissionsWithDefaultoptional*string#
Specifies whether to overwrite child resource permissions with the default permissions.
parametersoptionalIResolvable | { [key: string]: string }parametersoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]parametersoptionalIResolvableParametersoptionalIResolvableParametersoptionalinterface{}#
A map of key-value pairs that define parameters and properties of the catalog.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
An array of key-value pairs to apply to this resource.
targetRedshiftCatalogoptionalIResolvable | CfnCatalog.TargetRedshiftCatalogPropertytarget_redshift_catalogoptionaltyping.Union[IResolvable, TargetRedshiftCatalogProperty]targetRedshiftCatalogoptionalIResolvableTargetRedshiftCatalogoptionalIResolvableTargetRedshiftCatalogoptionalinterface{}#
A structure that describes a target catalog for resource linking.