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

Inherits:
Struct
  • Object
show all
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:

Constant Summary collapse

SENSITIVE = 
[]

Instance Attribute Summary collapse

Instance Attribute Details

#catalog_id ⇒ String

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

Returns:

  • (String) 

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#catalog_properties ⇒ Types::CatalogPropertiesOutput

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

Returns:


1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  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:


1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  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:


1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#create_time ⇒ Time

The time at which the catalog was created.

Returns:

  • (Time) 

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#federated_catalog ⇒ Types::FederatedCatalog

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

Returns:


1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ String

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

Returns:

  • (String) 

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_arn ⇒ String

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

Returns:

  • (String) 

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#target_redshift_catalog ⇒ Types::TargetRedshiftCatalog

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

Returns:


1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end

#update_time ⇒ Time

The time at which the catalog was last updated.

Returns:

  • (Time) 

1996
1997
1998
1999
2000
2001
2002
2003
2004
2005
2006
2007
2008
2009
2010
2011
 
# File 'gems/aws-sdk-glue/lib/aws-sdk-glue/types.rb', line 1996

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)
  SENSITIVE = []
  include Aws::Structure
end