interface CfnCatalogProps

Language	Type name
.NET	Amazon.CDK.AWS.Glue.CfnCatalogProps
Go	github.com/aws/aws-cdk-go/awscdk/v2/awsglue#CfnCatalogProps
Java	software.amazon.awscdk.services.glue.CfnCatalogProps
Python	aws_cdk.aws_glue.CfnCatalogProps
TypeScript	aws-cdk-lib » aws_glue » CfnCatalogProps

Properties for defining a CfnCatalog.

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

Example

// 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

Name	Type	Description
name	string	The name of the catalog to create.
allowFullTableExternalDataAccess?	string	Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.
catalogProperties?	IResolvable | CatalogPropertiesProperty	A structure that specifies data lake access properties and other custom properties.
createDatabaseDefaultPermissions?	IResolvable | (IResolvable | PrincipalPermissionsProperty)[]	An array of PrincipalPermissions objects for default database permissions.
createTableDefaultPermissions?	IResolvable | (IResolvable | PrincipalPermissionsProperty)[]	An array of PrincipalPermissions objects for default table permissions.
description?	string	A description of the catalog.
federatedCatalog?	IResolvable | FederatedCatalogProperty	A FederatedCatalog structure that references an entity outside the Glue Data Catalog.
overwriteChildResourcePermissionsWithDefault?	string	Specifies whether to overwrite child resource permissions with the default permissions.
parameters?	{ [string]: string } | IResolvable	A map of key-value pairs that define parameters and properties of the catalog.
tags?	CfnTag[]	An array of key-value pairs to apply to this resource.
targetRedshiftCatalog?	IResolvable | TargetRedshiftCatalogProperty	A structure that describes a target catalog for resource linking.

---

name

Type: string

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

---

allowFullTableExternalDataAccess?

Type: string (optional)

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

---

catalogProperties?

Type: IResolvable | CatalogPropertiesProperty (optional)

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

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

---

createDatabaseDefaultPermissions?

Type: IResolvable | (IResolvable | PrincipalPermissionsProperty)[] (optional)

An array of PrincipalPermissions objects for default database permissions.

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

---

createTableDefaultPermissions?

Type: IResolvable | (IResolvable | PrincipalPermissionsProperty)[] (optional)

An array of PrincipalPermissions objects for default table permissions.

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

---

description?

Type: string (optional)

A description of the catalog.

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

---

federatedCatalog?

Type: IResolvable | FederatedCatalogProperty (optional)

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

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

---

overwriteChildResourcePermissionsWithDefault?

Type: string (optional)

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

---

parameters?

Type: { [string]: string } | IResolvable (optional)

A map of key-value pairs that define parameters and properties of the catalog.

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

---

tags?

Type: CfnTag[] (optional)

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

---

targetRedshiftCatalog?

Type: IResolvable | TargetRedshiftCatalogProperty (optional)

A structure that describes a target catalog for resource linking.

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