The catalog object represents a logical grouping of databases in the AWS Glue Data Catalog or a federated source. You can now create a Redshift-federated catalog or a catalog containing resource links to Redshift databases in another account or region.
Contents
- Name
-
The name of the catalog. Cannot be the same as the account ID.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 64.
Pattern:
^(?!(.*[.\/\\]|aws:)).*$Required: Yes
- CatalogId
-
The ID of the catalog. To grant access to the default catalog, this field should not be provided.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 255.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Required: No
- CatalogProperties
-
A
CatalogPropertiesobject that specifies data lake access properties and other custom properties.Type: CatalogPropertiesOutput object
Required: No
- CreateDatabaseDefaultPermissions
-
An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the database(s) for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.Type: Array of PrincipalPermissions objects
Required: No
- CreateTableDefaultPermissions
-
An array of
PrincipalPermissionsobjects. Creates a set of default permissions on the table(s) for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.Type: Array of PrincipalPermissions objects
Required: No
- CreateTime
-
The time at which the catalog was created.
Type: Timestamp
Required: No
- Description
-
Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.
Type: String
Length Constraints: Minimum length of 0. Maximum length of 2048.
Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\r\n\t]*Required: No
- FederatedCatalog
-
A
FederatedCatalogobject that points to an entity outside the AWS Glue Data Catalog.Type: FederatedCatalog object
Required: No
- Parameters
-
A map array of key-value pairs that define parameters and properties of the catalog.
Type: String to string map
Key Length Constraints: Minimum length of 1. Maximum length of 255.
Key Pattern:
[\u0020-\uD7FF\uE000-\uFFFD\uD800\uDC00-\uDBFF\uDFFF\t]*Value Length Constraints: Maximum length of 512000.
Required: No
- ResourceArn
-
The Amazon Resource Name (ARN) assigned to the catalog resource.
Type: String
Required: No
- TargetRedshiftCatalog
-
A
TargetRedshiftCatalogobject that describes a target catalog for database resource linking.Type: TargetRedshiftCatalog object
Required: No
- UpdateTime
-
The time at which the catalog was last updated.
Type: Timestamp
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
