This is the new CloudFormation Template Reference Guide. Please update your bookmarks and links. For help getting started with CloudFormation, see the AWS CloudFormation User Guide.
AWS::Glue::Catalog
The AWS::Glue::Catalog resource specifies a catalog object that
represents a logical grouping of databases in the AWS Glue Data Catalog
or a federated source. You can create a Redshift-federated catalog or a catalog containing
resource links to Redshift databases in another account or region.
Syntax
To declare this entity in your CloudFormation template, use the following syntax:
JSON
{ "Type" : "AWS::Glue::Catalog", "Properties" : { "AllowFullTableExternalDataAccess" :String, "CatalogProperties" :CatalogProperties, "CreateDatabaseDefaultPermissions" :[ PrincipalPermissions, ... ], "CreateTableDefaultPermissions" :[ PrincipalPermissions, ... ], "Description" :String, "FederatedCatalog" :FederatedCatalog, "Name" :String, "OverwriteChildResourcePermissionsWithDefault" :String, "Parameters" :{, "Tags" :Key:Value, ...}[ Tag, ... ], "TargetRedshiftCatalog" :TargetRedshiftCatalog} }
YAML
Type: AWS::Glue::Catalog Properties: AllowFullTableExternalDataAccess:StringCatalogProperties:CatalogPropertiesCreateDatabaseDefaultPermissions:- PrincipalPermissionsCreateTableDefaultPermissions:- PrincipalPermissionsDescription:StringFederatedCatalog:FederatedCatalogName:StringOverwriteChildResourcePermissionsWithDefault:StringParameters:Tags:Key:Value- TagTargetRedshiftCatalog:TargetRedshiftCatalog
Properties
AllowFullTableExternalDataAccess-
Allows third-party engines to access data in Amazon S3 locations that are registered with AWS Lake Formation.
Note
This property is write-only. The value is not returned by
Fn::GetAttorRef.Required: No
Type: String
Allowed values:
True | FalseUpdate requires: No interruption
CatalogProperties-
A
CatalogPropertiesobject that specifies data lake access properties and other custom properties.Required: No
Type: CatalogProperties
Update requires: No interruption
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.Required: No
Type: Array of PrincipalPermissions
Update requires: No interruption
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.Required: No
Type: Array of PrincipalPermissions
Update requires: No interruption
Description-
A description of the catalog, not more than 2048 bytes long.
Required: No
Type: String
Maximum:
2048Update requires: No interruption
FederatedCatalog-
A
FederatedCatalogobject that points to an entity outside the AWS Glue Data Catalog.Required: No
Type: FederatedCatalog
Update requires: No interruption
Name-
The name of the catalog. Cannot be the same as the account ID.
Update requires: Replacement
Required: Yes
Type: String
Minimum:
1Maximum:
255Update requires: Replacement
OverwriteChildResourcePermissionsWithDefault-
Specifies whether to overwrite child resource permissions with the default permissions. Valid values are
AcceptandDeny.Note
This property is write-only. The value is not returned by
Fn::GetAttorRef.Required: No
Type: String
Allowed values:
Accept | DenyUpdate requires: No interruption
Parameters-
A map array of key-value pairs that define parameters and properties of the catalog.
Required: No
Type: Object of String
Pattern:
^.+$Update requires: No interruption
-
An array of key-value pairs to apply to this resource.
For more information, see Tag.
Required: No
Type: Array of Tag
Update requires: No interruption
TargetRedshiftCatalog-
A
TargetRedshiftCatalogobject that describes a target catalog for database resource linking.Required: No
Type: TargetRedshiftCatalog
Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns the Amazon Resource Name (ARN) of the catalog, such as
arn:aws:glue:us-east-1:123456789012:catalog/my-catalog.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
CatalogId-
The ID of the catalog.
CatalogProperties.DataLakeAccessProperties.ManagedWorkgroupName-
The name of the managed workgroup associated with the catalog.
CatalogProperties.DataLakeAccessProperties.ManagedWorkgroupStatus-
The status of the managed workgroup.
CatalogProperties.DataLakeAccessProperties.RedshiftDatabaseName-
The name of the Redshift database associated with the catalog.
CreateTime-
The time at which the catalog was created.
ResourceArn-
The Amazon Resource Name (ARN) assigned to the catalog resource.
UpdateTime-
The time at which the catalog was last updated.
