Class: Aws::Glue::Types::Catalog

Inherits:

Struct

• Object
• Struct
• Aws::Glue::Types::Catalog

Defined in:

gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb

Overview

The catalog object represents a logical grouping of databases in the 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.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

• #allow_full_table_external_data_access ⇒ String

  Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

• #catalog_id ⇒ String

  The ID of the catalog.

• #catalog_properties ⇒ Types::CatalogPropertiesOutput

  A CatalogProperties object that specifies data lake access properties and other custom properties.

• #create_database_default_permissions ⇒ Array<Types::PrincipalPermissions>

  An array of PrincipalPermissions objects.

• #create_table_default_permissions ⇒ Array<Types::PrincipalPermissions>

  An array of PrincipalPermissions objects.

• #create_time ⇒ Time

  The time at which the catalog was created.

• #description ⇒ String

  Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern.

• #federated_catalog ⇒ Types::FederatedCatalog

  A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

• #name ⇒ String

  The name of the catalog.

• #parameters ⇒ Hash<String,String>

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

• #resource_arn ⇒ String

  The Amazon Resource Name (ARN) assigned to the catalog resource.

• #target_redshift_catalog ⇒ Types::TargetRedshiftCatalog

  A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

• #update_time ⇒ Time

  The time at which the catalog was last updated.

Instance Attribute Details

#allow_full_table_external_data_access ⇒ String

Allows third-party engines to access data in Amazon S3 locations that are registered with Lake Formation.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_id ⇒ String

The ID of the catalog. To grant access to the default catalog, this field should not be provided.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_properties ⇒ Types::CatalogPropertiesOutput

A CatalogProperties object that specifies data lake access properties and other custom properties.

Returns:

• (Types::CatalogPropertiesOutput)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#create_database_default_permissions ⇒ Array<Types::PrincipalPermissions>

An array of PrincipalPermissions objects. Creates a set of default permissions on the database(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

Returns:

• (Array<Types::PrincipalPermissions>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#create_table_default_permissions ⇒ Array<Types::PrincipalPermissions>

An array of PrincipalPermissions objects. Creates a set of default permissions on the table(s) for principals. Used by Amazon Web Services Lake Formation. Not used in the normal course of Glue operations.

Returns:

• (Array<Types::PrincipalPermissions>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time at which the catalog was created.

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ String

Description string, not more than 2048 bytes long, matching the URI address multi-line string pattern. A description of the catalog.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#federated_catalog ⇒ Types::FederatedCatalog

A FederatedCatalog object that points to an entity outside the Glue Data Catalog.

Returns:

• (Types::FederatedCatalog)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

The name of the catalog. Cannot be the same as the account ID.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#parameters ⇒ Hash<String,String>

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

Returns:

• (Hash<String,String>)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

The Amazon Resource Name (ARN) assigned to the catalog resource.

Returns:

• (String)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#target_redshift_catalog ⇒ Types::TargetRedshiftCatalog

A TargetRedshiftCatalog object that describes a target catalog for database resource linking.

Returns:

• (Types::TargetRedshiftCatalog)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The time at which the catalog was last updated.

Returns:

• (Time)

# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 2028

class Catalog < Struct.new(
  :catalog_id,
  :name,
  :resource_arn,
  :description,
  :parameters,
  :create_time,
  :update_time,
  :target_redshift_catalog,
  :federated_catalog,
  :catalog_properties,
  :create_table_default_permissions,
  :create_database_default_permissions,
  :allow_full_table_external_data_access)
  SENSITIVE = []
  include Aws::Structure
end