Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. AWS Cloud Control
  3. API Docs
  4. glue
  5. getDatabase

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.glue.getDatabase

Explore with Pulumi AI

aws-native logo

We recommend new projects start with resources from the AWS provider.

AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::Glue::Database

    Using getDatabase

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDatabase(args: GetDatabaseArgs, opts?: InvokeOptions): Promise<GetDatabaseResult>
function getDatabaseOutput(args: GetDatabaseOutputArgs, opts?: InvokeOptions): Output<GetDatabaseResult>
    def get_database(database_name: Optional[str] = None,
                 opts: Optional[InvokeOptions] = None) -> GetDatabaseResult
def get_database_output(database_name: Optional[pulumi.Input[str]] = None,
                 opts: Optional[InvokeOptions] = None) -> Output[GetDatabaseResult]
    func LookupDatabase(ctx *Context, args *LookupDatabaseArgs, opts ...InvokeOption) (*LookupDatabaseResult, error)
func LookupDatabaseOutput(ctx *Context, args *LookupDatabaseOutputArgs, opts ...InvokeOption) LookupDatabaseResultOutput

    > Note: This function is named LookupDatabase in the Go SDK.

    public static class GetDatabase 
{
    public static Task<GetDatabaseResult> InvokeAsync(GetDatabaseArgs args, InvokeOptions? opts = null)
    public static Output<GetDatabaseResult> Invoke(GetDatabaseInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDatabaseResult> getDatabase(GetDatabaseArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:glue:getDatabase
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DatabaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    DatabaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    databaseName String
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    databaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    database_name str
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    databaseName String
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.

    getDatabase Result

    The following output properties are available:

    CatalogId string
    The AWS account ID for the account in which to create the catalog object.
    DatabaseInput Pulumi.AwsNative.Glue.Outputs.DatabaseInput
    The metadata for the database.
    CatalogId string
    The AWS account ID for the account in which to create the catalog object.
    DatabaseInput DatabaseInputType
    The metadata for the database.
    catalogId String
    The AWS account ID for the account in which to create the catalog object.
    databaseInput DatabaseInput
    The metadata for the database.
    catalogId string
    The AWS account ID for the account in which to create the catalog object.
    databaseInput DatabaseInput
    The metadata for the database.
    catalog_id str
    The AWS account ID for the account in which to create the catalog object.
    database_input DatabaseInput
    The metadata for the database.
    catalogId String
    The AWS account ID for the account in which to create the catalog object.
    databaseInput Property Map
    The metadata for the database.

    Supporting Types

    DatabaseDataLakePrincipal

    DataLakePrincipalIdentifier string
    An identifier for the AWS Lake Formation principal.
    DataLakePrincipalIdentifier string
    An identifier for the AWS Lake Formation principal.
    dataLakePrincipalIdentifier String
    An identifier for the AWS Lake Formation principal.
    dataLakePrincipalIdentifier string
    An identifier for the AWS Lake Formation principal.
    data_lake_principal_identifier str
    An identifier for the AWS Lake Formation principal.
    dataLakePrincipalIdentifier String
    An identifier for the AWS Lake Formation principal.

    DatabaseFederatedDatabase

    ConnectionName string
    The name of the connection to the external metastore.
    Identifier string
    A unique identifier for the federated database.
    ConnectionName string
    The name of the connection to the external metastore.
    Identifier string
    A unique identifier for the federated database.
    connectionName String
    The name of the connection to the external metastore.
    identifier String
    A unique identifier for the federated database.
    connectionName string
    The name of the connection to the external metastore.
    identifier string
    A unique identifier for the federated database.
    connection_name str
    The name of the connection to the external metastore.
    identifier str
    A unique identifier for the federated database.
    connectionName String
    The name of the connection to the external metastore.
    identifier String
    A unique identifier for the federated database.

    DatabaseIdentifier

    CatalogId string
    The ID of the Data Catalog in which the database resides.
    DatabaseName string
    The name of the catalog database.
    Region string
    Region of the target database.
    CatalogId string
    The ID of the Data Catalog in which the database resides.
    DatabaseName string
    The name of the catalog database.
    Region string
    Region of the target database.
    catalogId String
    The ID of the Data Catalog in which the database resides.
    databaseName String
    The name of the catalog database.
    region String
    Region of the target database.
    catalogId string
    The ID of the Data Catalog in which the database resides.
    databaseName string
    The name of the catalog database.
    region string
    Region of the target database.
    catalog_id str
    The ID of the Data Catalog in which the database resides.
    database_name str
    The name of the catalog database.
    region str
    Region of the target database.
    catalogId String
    The ID of the Data Catalog in which the database resides.
    databaseName String
    The name of the catalog database.
    region String
    Region of the target database.

    DatabaseInput

    CreateTableDefaultPermissions List<Pulumi.AwsNative.Glue.Inputs.DatabasePrincipalPrivileges>
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    Description string
    A description of the database.
    FederatedDatabase Pulumi.AwsNative.Glue.Inputs.DatabaseFederatedDatabase
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    LocationUri string
    The location of the database (for example, an HDFS path).
    Name string
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    Parameters object
    These key-value pairs define parameters and properties of the database.
    TargetDatabase Pulumi.AwsNative.Glue.Inputs.DatabaseIdentifier
    A DatabaseIdentifier structure that describes a target database for resource linking.
    CreateTableDefaultPermissions []DatabasePrincipalPrivileges
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    Description string
    A description of the database.
    FederatedDatabase DatabaseFederatedDatabase
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    LocationUri string
    The location of the database (for example, an HDFS path).
    Name string
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    Parameters interface{}
    These key-value pairs define parameters and properties of the database.
    TargetDatabase DatabaseIdentifier
    A DatabaseIdentifier structure that describes a target database for resource linking.
    createTableDefaultPermissions List<DatabasePrincipalPrivileges>
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    description String
    A description of the database.
    federatedDatabase DatabaseFederatedDatabase
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    locationUri String
    The location of the database (for example, an HDFS path).
    name String
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    parameters Object
    These key-value pairs define parameters and properties of the database.
    targetDatabase DatabaseIdentifier
    A DatabaseIdentifier structure that describes a target database for resource linking.
    createTableDefaultPermissions DatabasePrincipalPrivileges[]
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    description string
    A description of the database.
    federatedDatabase DatabaseFederatedDatabase
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    locationUri string
    The location of the database (for example, an HDFS path).
    name string
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    parameters any
    These key-value pairs define parameters and properties of the database.
    targetDatabase DatabaseIdentifier
    A DatabaseIdentifier structure that describes a target database for resource linking.
    create_table_default_permissions Sequence[DatabasePrincipalPrivileges]
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    description str
    A description of the database.
    federated_database DatabaseFederatedDatabase
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    location_uri str
    The location of the database (for example, an HDFS path).
    name str
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    parameters Any
    These key-value pairs define parameters and properties of the database.
    target_database DatabaseIdentifier
    A DatabaseIdentifier structure that describes a target database for resource linking.
    createTableDefaultPermissions List<Property Map>
    Creates a set of default permissions on the table for principals. Used by AWS Lake Formation. Not used in the normal course of AWS Glue operations.
    description String
    A description of the database.
    federatedDatabase Property Map
    A FederatedDatabase structure that references an entity outside the AWS Glue Data Catalog.
    locationUri String
    The location of the database (for example, an HDFS path).
    name String
    The name of the database. For hive compatibility, this is folded to lowercase when it is stored.
    parameters Any
    These key-value pairs define parameters and properties of the database.
    targetDatabase Property Map
    A DatabaseIdentifier structure that describes a target database for resource linking.

    DatabasePrincipalPrivileges

    Permissions List<string>
    The permissions that are granted to the principal.
    Principal Pulumi.AwsNative.Glue.Inputs.DatabaseDataLakePrincipal
    The principal who is granted permissions.
    Permissions []string
    The permissions that are granted to the principal.
    Principal DatabaseDataLakePrincipal
    The principal who is granted permissions.
    permissions List<String>
    The permissions that are granted to the principal.
    principal DatabaseDataLakePrincipal
    The principal who is granted permissions.
    permissions string[]
    The permissions that are granted to the principal.
    principal DatabaseDataLakePrincipal
    The principal who is granted permissions.
    permissions Sequence[str]
    The permissions that are granted to the principal.
    principal DatabaseDataLakePrincipal
    The principal who is granted permissions.
    permissions List<String>
    The permissions that are granted to the principal.
    principal Property Map
    The principal who is granted permissions.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    We recommend new projects start with resources from the AWS provider.

    AWS Cloud Control v1.9.0 published on Monday, Nov 18, 2024 by Pulumi
    pulumi/pulumi-aws-native