Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Google Cloud Native
  3. API Docs
  4. biglake
  5. biglake/v1
  6. Database

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

google-native.biglake/v1.Database

Explore with Pulumi AI

google-native logo

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
pulumi/pulumi-google-native

    Creates a new database. Auto-naming is currently not supported for this resource.

    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_id: Optional[str] = None,
             hive_options: Optional[HiveDatabaseOptionsArgs] = None,
             location: Optional[str] = None,
             project: Optional[str] = None,
             type: Optional[DatabaseType] = 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: google-native:biglake/v1: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.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var databaseResource = new GoogleNative.BigLake.V1.Database("databaseResource", new()
{
    CatalogId = "string",
    DatabaseId = "string",
    HiveOptions = new GoogleNative.BigLake.V1.Inputs.HiveDatabaseOptionsArgs
    {
        LocationUri = "string",
        Parameters = 
        {
            { "string", "string" },
        },
    },
    Location = "string",
    Project = "string",
    Type = GoogleNative.BigLake.V1.DatabaseType.TypeUnspecified,
});

    example, err := biglake.NewDatabase(ctx, "databaseResource", &biglake.DatabaseArgs{
	CatalogId:  pulumi.String("string"),
	DatabaseId: pulumi.String("string"),
	HiveOptions: &biglake.HiveDatabaseOptionsArgs{
		LocationUri: pulumi.String("string"),
		Parameters: pulumi.StringMap{
			"string": pulumi.String("string"),
		},
	},
	Location: pulumi.String("string"),
	Project:  pulumi.String("string"),
	Type:     biglake.DatabaseTypeTypeUnspecified,
})

    var databaseResource = new Database("databaseResource", DatabaseArgs.builder()
    .catalogId("string")
    .databaseId("string")
    .hiveOptions(HiveDatabaseOptionsArgs.builder()
        .locationUri("string")
        .parameters(Map.of("string", "string"))
        .build())
    .location("string")
    .project("string")
    .type("TYPE_UNSPECIFIED")
    .build());

    database_resource = google_native.biglake.v1.Database("databaseResource",
    catalog_id="string",
    database_id="string",
    hive_options={
        "location_uri": "string",
        "parameters": {
            "string": "string",
        },
    },
    location="string",
    project="string",
    type=google_native.biglake.v1.DatabaseType.TYPE_UNSPECIFIED)

    const databaseResource = new google_native.biglake.v1.Database("databaseResource", {
    catalogId: "string",
    databaseId: "string",
    hiveOptions: {
        locationUri: "string",
        parameters: {
            string: "string",
        },
    },
    location: "string",
    project: "string",
    type: google_native.biglake.v1.DatabaseType.TypeUnspecified,
});

    type: google-native:biglake/v1:Database
properties:
    catalogId: string
    databaseId: string
    hiveOptions:
        locationUri: string
        parameters:
            string: string
    location: string
    project: string
    type: TYPE_UNSPECIFIED

    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
    DatabaseId string
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    HiveOptions Pulumi.GoogleNative.BigLake.V1.Inputs.HiveDatabaseOptions
    Options of a Hive database.
    Location string
    Project string
    Type Pulumi.GoogleNative.BigLake.V1.DatabaseType
    The database type.
    CatalogId string
    DatabaseId string
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    HiveOptions HiveDatabaseOptionsArgs
    Options of a Hive database.
    Location string
    Project string
    Type DatabaseType
    The database type.
    catalogId String
    databaseId String
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    hiveOptions HiveDatabaseOptions
    Options of a Hive database.
    location String
    project String
    type DatabaseType
    The database type.
    catalogId string
    databaseId string
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    hiveOptions HiveDatabaseOptions
    Options of a Hive database.
    location string
    project string
    type DatabaseType
    The database type.
    catalog_id str
    database_id str
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    hive_options HiveDatabaseOptionsArgs
    Options of a Hive database.
    location str
    project str
    type DatabaseType
    The database type.
    catalogId String
    databaseId String
    Required. The ID to use for the database, which will become the final component of the database's resource name.
    hiveOptions Property Map
    Options of a Hive database.
    location String
    project String
    type "TYPE_UNSPECIFIED" | "HIVE"
    The database type.

    Outputs

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

    CreateTime string
    The creation time of the database.
    DeleteTime string
    The deletion time of the database. Only set after the database is deleted.
    ExpireTime string
    The time when this database is considered expired. Only set after the database is deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    UpdateTime string
    The last modification time of the database.
    CreateTime string
    The creation time of the database.
    DeleteTime string
    The deletion time of the database. Only set after the database is deleted.
    ExpireTime string
    The time when this database is considered expired. Only set after the database is deleted.
    Id string
    The provider-assigned unique ID for this managed resource.
    Name string
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    UpdateTime string
    The last modification time of the database.
    createTime String
    The creation time of the database.
    deleteTime String
    The deletion time of the database. Only set after the database is deleted.
    expireTime String
    The time when this database is considered expired. Only set after the database is deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    updateTime String
    The last modification time of the database.
    createTime string
    The creation time of the database.
    deleteTime string
    The deletion time of the database. Only set after the database is deleted.
    expireTime string
    The time when this database is considered expired. Only set after the database is deleted.
    id string
    The provider-assigned unique ID for this managed resource.
    name string
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    updateTime string
    The last modification time of the database.
    create_time str
    The creation time of the database.
    delete_time str
    The deletion time of the database. Only set after the database is deleted.
    expire_time str
    The time when this database is considered expired. Only set after the database is deleted.
    id str
    The provider-assigned unique ID for this managed resource.
    name str
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    update_time str
    The last modification time of the database.
    createTime String
    The creation time of the database.
    deleteTime String
    The deletion time of the database. Only set after the database is deleted.
    expireTime String
    The time when this database is considered expired. Only set after the database is deleted.
    id String
    The provider-assigned unique ID for this managed resource.
    name String
    The resource name. Format: projects/{project_id_or_number}/locations/{location_id}/catalogs/{catalog_id}/databases/{database_id}
    updateTime String
    The last modification time of the database.

    Supporting Types

    DatabaseType, DatabaseTypeArgs

    TypeUnspecified
    TYPE_UNSPECIFIEDThe type is not specified.
    Hive
    HIVERepresents a database storing tables compatible with Hive Metastore tables.
    DatabaseTypeTypeUnspecified
    TYPE_UNSPECIFIEDThe type is not specified.
    DatabaseTypeHive
    HIVERepresents a database storing tables compatible with Hive Metastore tables.
    TypeUnspecified
    TYPE_UNSPECIFIEDThe type is not specified.
    Hive
    HIVERepresents a database storing tables compatible with Hive Metastore tables.
    TypeUnspecified
    TYPE_UNSPECIFIEDThe type is not specified.
    Hive
    HIVERepresents a database storing tables compatible with Hive Metastore tables.
    TYPE_UNSPECIFIED
    TYPE_UNSPECIFIEDThe type is not specified.
    HIVE
    HIVERepresents a database storing tables compatible with Hive Metastore tables.
    "TYPE_UNSPECIFIED"
    TYPE_UNSPECIFIEDThe type is not specified.
    "HIVE"
    HIVERepresents a database storing tables compatible with Hive Metastore tables.

    HiveDatabaseOptions, HiveDatabaseOptionsArgs

    LocationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    Parameters Dictionary<string, string>
    Stores user supplied Hive database parameters.
    LocationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    Parameters map[string]string
    Stores user supplied Hive database parameters.
    locationUri String
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Map<String,String>
    Stores user supplied Hive database parameters.
    locationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters {[key: string]: string}
    Stores user supplied Hive database parameters.
    location_uri str
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Mapping[str, str]
    Stores user supplied Hive database parameters.
    locationUri String
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Map<String>
    Stores user supplied Hive database parameters.

    HiveDatabaseOptionsResponse, HiveDatabaseOptionsResponseArgs

    LocationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    Parameters Dictionary<string, string>
    Stores user supplied Hive database parameters.
    LocationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    Parameters map[string]string
    Stores user supplied Hive database parameters.
    locationUri String
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Map<String,String>
    Stores user supplied Hive database parameters.
    locationUri string
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters {[key: string]: string}
    Stores user supplied Hive database parameters.
    location_uri str
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Mapping[str, str]
    Stores user supplied Hive database parameters.
    locationUri String
    Cloud Storage folder URI where the database data is stored, starting with "gs://".
    parameters Map<String>
    Stores user supplied Hive database parameters.

    Package Details

    Repository
    Google Cloud Native pulumi/pulumi-google-native
    License
    Apache-2.0
    google-native logo

    Google Cloud Native is in preview. Google Cloud Classic is fully supported.

    Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi
    pulumi/pulumi-google-native