@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
454 lines (453 loc) • 17.2 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* An AutonomousDatabase resource.
*
* To get more information about AutonomousDatabase, see:
*
* * [API documentation](https://cloud.google.com/oracle/database/docs/reference/rest/v1/projects.locations.autonomousDatabases)
* * How-to Guides
* * [Create Autonomous databases](https://cloud.google.com/oracle/database/docs/create-databases)
*
* ## Example Usage
*
* ### Oracledatabase Autonomous Database Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.compute.getNetwork({
* name: "new",
* project: "my-project",
* });
* const myADB = new gcp.oracledatabase.AutonomousDatabase("myADB", {
* autonomousDatabaseId: "my-instance",
* location: "us-east4",
* project: "my-project",
* database: "mydatabase",
* adminPassword: "123Abpassword",
* network: _default.then(_default => _default.id),
* cidr: "10.5.0.0/24",
* properties: {
* computeCount: 2,
* dataStorageSizeTb: 1,
* dbVersion: "19c",
* dbWorkload: "OLTP",
* licenseType: "LICENSE_INCLUDED",
* },
* deletionProtection: true,
* });
* ```
* ### Oracledatabase Autonomous Database Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = gcp.compute.getNetwork({
* name: "new",
* project: "my-project",
* });
* const myADB = new gcp.oracledatabase.AutonomousDatabase("myADB", {
* autonomousDatabaseId: "my-instance",
* location: "us-east4",
* project: "my-project",
* displayName: "autonomousDatabase displayname",
* database: "mydatabase",
* adminPassword: "123Abpassword",
* network: _default.then(_default => _default.id),
* cidr: "10.5.0.0/24",
* labels: {
* "label-one": "value-one",
* },
* properties: {
* computeCount: 2,
* dataStorageSizeGb: 48,
* dbVersion: "19c",
* dbEdition: "STANDARD_EDITION",
* dbWorkload: "OLTP",
* isAutoScalingEnabled: true,
* licenseType: "BRING_YOUR_OWN_LICENSE",
* backupRetentionPeriodDays: 60,
* characterSet: "AL32UTF8",
* isStorageAutoScalingEnabled: false,
* maintenanceScheduleType: "REGULAR",
* mtlsConnectionRequired: false,
* nCharacterSet: "AL16UTF16",
* operationsInsightsState: "NOT_ENABLED",
* customerContacts: [{
* email: "xyz@example.com",
* }],
* privateEndpointIp: "10.5.0.11",
* privateEndpointLabel: "myendpoint",
* },
* deletionProtection: true,
* });
* ```
* ### Oracledatabase Autonomous Database Odbnetwork
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myADB = new gcp.oracledatabase.AutonomousDatabase("myADB", {
* autonomousDatabaseId: "my-instance",
* location: "europe-west2",
* project: "my-project",
* database: "mydatabase",
* adminPassword: "123Abpassword",
* odbNetwork: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork",
* odbSubnet: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork/odbSubnets/my-odbsubnet",
* properties: {
* computeCount: 2,
* dataStorageSizeTb: 1,
* dbVersion: "19c",
* dbWorkload: "OLTP",
* licenseType: "LICENSE_INCLUDED",
* },
* deletionProtection: true,
* });
* ```
* ### Oracledatabase Autonomous Database Publicip
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myADB = new gcp.oracledatabase.AutonomousDatabase("myADB", {
* autonomousDatabaseId: "my-instance",
* location: "europe-west2",
* project: "my-project",
* database: "mydatabase",
* adminPassword: "123Abpassword",
* properties: {
* computeCount: 2,
* dataStorageSizeTb: 1,
* dbVersion: "19c",
* dbWorkload: "OLTP",
* licenseType: "LICENSE_INCLUDED",
* mtlsConnectionRequired: true,
* },
* deletionProtection: true,
* });
* ```
*
* ## Import
*
* AutonomousDatabase can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/autonomousDatabases/{{autonomous_database_id}}`
*
* * `{{project}}/{{location}}/{{autonomous_database_id}}`
*
* * `{{location}}/{{autonomous_database_id}}`
*
* When using the `pulumi import` command, AutonomousDatabase can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:oracledatabase/autonomousDatabase:AutonomousDatabase default projects/{{project}}/locations/{{location}}/autonomousDatabases/{{autonomous_database_id}}
* ```
*
* ```sh
* $ pulumi import gcp:oracledatabase/autonomousDatabase:AutonomousDatabase default {{project}}/{{location}}/{{autonomous_database_id}}
* ```
*
* ```sh
* $ pulumi import gcp:oracledatabase/autonomousDatabase:AutonomousDatabase default {{location}}/{{autonomous_database_id}}
* ```
*/
export declare class AutonomousDatabase extends pulumi.CustomResource {
/**
* Get an existing AutonomousDatabase resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: AutonomousDatabaseState, opts?: pulumi.CustomResourceOptions): AutonomousDatabase;
/**
* Returns true if the given object is an instance of AutonomousDatabase. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AutonomousDatabase;
/**
* The password for the default ADMIN user.
*/
readonly adminPassword: pulumi.Output<string | undefined>;
/**
* The ID of the Autonomous Database to create. This value is restricted
* to (^a-z?$) and must be a maximum of 63
* characters in length. The value must start with a letter and end with
* a letter or a number.
*/
readonly autonomousDatabaseId: pulumi.Output<string>;
/**
* The subnet CIDR range for the Autonmous Database.
*/
readonly cidr: pulumi.Output<string | undefined>;
/**
* The date and time that the Autonomous Database was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* The name of the Autonomous Database. The database name must be unique in
* the project. The name must begin with a letter and can
* contain a maximum of 30 alphanumeric characters.
*/
readonly database: pulumi.Output<string>;
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The display name for the Autonomous Database. The name does not have to
* be unique within your project.
*/
readonly displayName: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The ID of the subscription entitlement associated with the Autonomous
* Database.
*/
readonly entitlementId: pulumi.Output<string>;
/**
* The labels or tags associated with the Autonomous Database.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Resource ID segment making up resource `name`. See documentation for resource type `oracledatabase.googleapis.com/AutonomousDatabaseBackup`.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The name of the Autonomous Database resource in the following format:
* projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
*/
readonly name: pulumi.Output<string>;
/**
* The name of the VPC network used by the Autonomous Database.
* Format: projects/{project}/global/networks/{network}
*/
readonly network: pulumi.Output<string | undefined>;
/**
* The name of the OdbNetwork associated with the Autonomous Database.
* Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the odbSubnet and backup_odb_subnet.
*/
readonly odbNetwork: pulumi.Output<string>;
/**
* The name of the OdbSubnet associated with the Autonomous Database for
* IP allocation. Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
readonly odbSubnet: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The properties of an Autonomous Database.
* Structure is documented below.
*/
readonly properties: pulumi.Output<outputs.oracledatabase.AutonomousDatabaseProperties>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* Create a AutonomousDatabase resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AutonomousDatabaseArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering AutonomousDatabase resources.
*/
export interface AutonomousDatabaseState {
/**
* The password for the default ADMIN user.
*/
adminPassword?: pulumi.Input<string>;
/**
* The ID of the Autonomous Database to create. This value is restricted
* to (^a-z?$) and must be a maximum of 63
* characters in length. The value must start with a letter and end with
* a letter or a number.
*/
autonomousDatabaseId?: pulumi.Input<string>;
/**
* The subnet CIDR range for the Autonmous Database.
*/
cidr?: pulumi.Input<string>;
/**
* The date and time that the Autonomous Database was created.
*/
createTime?: pulumi.Input<string>;
/**
* The name of the Autonomous Database. The database name must be unique in
* the project. The name must begin with a letter and can
* contain a maximum of 30 alphanumeric characters.
*/
database?: pulumi.Input<string>;
deletionProtection?: pulumi.Input<boolean>;
/**
* The display name for the Autonomous Database. The name does not have to
* be unique within your project.
*/
displayName?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The ID of the subscription entitlement associated with the Autonomous
* Database.
*/
entitlementId?: pulumi.Input<string>;
/**
* The labels or tags associated with the Autonomous Database.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Resource ID segment making up resource `name`. See documentation for resource type `oracledatabase.googleapis.com/AutonomousDatabaseBackup`.
*/
location?: pulumi.Input<string>;
/**
* Identifier. The name of the Autonomous Database resource in the following format:
* projects/{project}/locations/{region}/autonomousDatabases/{autonomous_database}
*/
name?: pulumi.Input<string>;
/**
* The name of the VPC network used by the Autonomous Database.
* Format: projects/{project}/global/networks/{network}
*/
network?: pulumi.Input<string>;
/**
* The name of the OdbNetwork associated with the Autonomous Database.
* Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the odbSubnet and backup_odb_subnet.
*/
odbNetwork?: pulumi.Input<string>;
/**
* The name of the OdbSubnet associated with the Autonomous Database for
* IP allocation. Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
odbSubnet?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The properties of an Autonomous Database.
* Structure is documented below.
*/
properties?: pulumi.Input<inputs.oracledatabase.AutonomousDatabaseProperties>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
}
/**
* The set of arguments for constructing a AutonomousDatabase resource.
*/
export interface AutonomousDatabaseArgs {
/**
* The password for the default ADMIN user.
*/
adminPassword?: pulumi.Input<string>;
/**
* The ID of the Autonomous Database to create. This value is restricted
* to (^a-z?$) and must be a maximum of 63
* characters in length. The value must start with a letter and end with
* a letter or a number.
*/
autonomousDatabaseId: pulumi.Input<string>;
/**
* The subnet CIDR range for the Autonmous Database.
*/
cidr?: pulumi.Input<string>;
/**
* The name of the Autonomous Database. The database name must be unique in
* the project. The name must begin with a letter and can
* contain a maximum of 30 alphanumeric characters.
*/
database: pulumi.Input<string>;
deletionProtection?: pulumi.Input<boolean>;
/**
* The display name for the Autonomous Database. The name does not have to
* be unique within your project.
*/
displayName?: pulumi.Input<string>;
/**
* The labels or tags associated with the Autonomous Database.
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Resource ID segment making up resource `name`. See documentation for resource type `oracledatabase.googleapis.com/AutonomousDatabaseBackup`.
*/
location: pulumi.Input<string>;
/**
* The name of the VPC network used by the Autonomous Database.
* Format: projects/{project}/global/networks/{network}
*/
network?: pulumi.Input<string>;
/**
* The name of the OdbNetwork associated with the Autonomous Database.
* Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the odbSubnet and backup_odb_subnet.
*/
odbNetwork?: pulumi.Input<string>;
/**
* The name of the OdbSubnet associated with the Autonomous Database for
* IP allocation. Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
odbSubnet?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The properties of an Autonomous Database.
* Structure is documented below.
*/
properties: pulumi.Input<inputs.oracledatabase.AutonomousDatabaseProperties>;
}