Skip to main content

aws_glue_database Resource

Use the aws_glue_database InSpec audit resource to test properties of a single Glue database.

The AWS::Glue::Database resource specifies a logical grouping of tables in AWS Glue.

For additional information, including details on parameters and properties, see the AWS documentation on Glue Database.

Install

This resource is available in the Chef InSpec AWS resource pack.

For information on configuring your AWS environment for Chef InSpec and creating an InSpec profile that uses the InSpec AWS resource pack, see the Chef InSpec documentation on the AWS cloud platform.

Syntax

Ensure that a database name exists.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME')
  it { should exist }
end

Parameters

name (required)

The name of the Glue database.

Properties

name
The name of the database. For Hive compatibility, this is folded to lowercase when it is stored.
description
A description of the database.
location_uri
The location of the database (for example, an HDFS path).
parameters
These key-value pairs define parameters and properties of the database.
create_time
The time at which the metadata database was created in the catalog.
create_table_default_permissions (principal (data_lake_principal_identifier))
An identifier for the AWS Lake Formation principal.
create_table_default_permissions (permissions)
The permissions that are granted to the principal.
target_database (catalog_id)
The ID of the Data Catalog in which the database resides.
target_database (database_name)
The name of the catalog database.
catalog_id
The ID of the Data Catalog in which the database resides.

Examples

Ensure a database name is available.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME') do
  its('name') { should eq 'GLUE_DATABASE_NAME' }
end

Ensure a target database name is available.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME') do
    its('target_database.database_name') { should eq 'CATALOG_DATABASE_NAME' }
end

Matchers

For a full list of available matchers, see our Universal Matchers page.

This resource has the following special matchers.

exist

Use should to test that the entity exists.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME') do
  it { should exist }
end

Use should_not to test the entity does not exist.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME') do
  it { should_not exist }
end

be_available

Use should to check if the database name is available.

describe aws_glue_database(name: 'GLUE_DATABASE_NAME') do
  it { should be_available }
end

AWS Permissions

Your Principal will need the EC2:Client:GetDatabaseResponse action with Effect set to Allow.

Edit this page on GitHub

Thank you for your feedback!

×










Search Results