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

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.Database

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

    Create Database Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Database(name: string, args: DatabaseArgs, opts?: CustomResourceOptions);
    @overload
def Database(resource_name: str,
             args: DatabaseArgs,
             opts: Optional[ResourceOptions] = None)

@overload
def Database(resource_name: str,
             opts: Optional[ResourceOptions] = None,
             catalog_id: Optional[str] = None,
             database_input: Optional[DatabaseInputArgs] = None,
             database_name: Optional[str] = None)
    func NewDatabase(ctx *Context, name string, args DatabaseArgs, opts ...ResourceOption) (*Database, error)
    public Database(string name, DatabaseArgs args, CustomResourceOptions? opts = null)
    public Database(String name, DatabaseArgs args)
public Database(String name, DatabaseArgs args, CustomResourceOptions options)

    type: aws-native:glue:Database
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

    Parameters

    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DatabaseArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Database Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The Database resource accepts the following input properties:

    CatalogId string
    The AWS account ID for the account in which to create the catalog object.
    DatabaseInput Pulumi.AwsNative.Glue.Inputs.DatabaseInput
    The metadata for the database.
    DatabaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    CatalogId string
    The AWS account ID for the account in which to create the catalog object.
    DatabaseInput DatabaseInputTypeArgs
    The metadata for the database.
    DatabaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    catalogId String
    The AWS account ID for the account in which to create the catalog object.
    databaseInput DatabaseInput
    The metadata for the database.
    databaseName String
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    catalogId string
    The AWS account ID for the account in which to create the catalog object.
    databaseInput DatabaseInput
    The metadata for the database.
    databaseName string
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    catalog_id str
    The AWS account ID for the account in which to create the catalog object.
    database_input DatabaseInputArgs
    The metadata for the database.
    database_name str
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.
    catalogId String
    The AWS account ID for the account in which to create the catalog object.
    databaseInput Property Map
    The metadata for the database.
    databaseName String
    The name of the database. For hive compatibility, this is folded to lowercase when it is store.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Database resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DatabaseDataLakePrincipal, DatabaseDataLakePrincipalArgs

    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, DatabaseFederatedDatabaseArgs

    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, DatabaseIdentifierArgs

    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, DatabaseInputArgs

    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, DatabasePrincipalPrivilegesArgs

    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