@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
397 lines • 17.9 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* A DbSystem Resource
*
* ## Example Usage
*
* ### Oracledatabase Db System Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myDbSystem = new gcp.oracledatabase.DbSystem("my_db_system", {
* dbSystemId: "my-instance",
* displayName: "my-instance displayname",
* location: "europe-west2",
* project: "my-project",
* odbNetwork: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork",
* odbSubnet: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork/odbSubnets/my-odbsubnet",
* properties: {
* sshPublicKeys: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCz1X2744t+6vRLmE5u6nHi6/QWh8bQDgHmd+OIxRQIGA/IWUtCs2FnaCNZcqvZkaeyjk5v0lTA/n+9jvO42Ipib53athrfVG8gRt8fzPL66C6ZqHq+6zZophhrCdfJh/0G4x9xJh5gdMprlaCR1P8yAaVvhBQSKGc4SiIkyMNBcHJ5YTtMQMTfxaB4G1sHZ6SDAY9a6Cq/zNjDwfPapWLsiP4mRhE5SSjJX6l6EYbkm0JeLQg+AbJiNEPvrvDp1wtTxzlPJtIivthmLMThFxK7+DkrYFuLvN5AHUdo9KTDLvHtDCvV70r8v0gafsrKkM/OE9Jtzoo0e1N/5K/ZdyFRbAkFT4QSF3nwpbmBWLf2Evg//YyEuxnz4CwPqFST2mucnrCCGCVWp1vnHZ0y30nM35njLOmWdRDFy5l27pKUTwLp02y3UYiiZyP7d3/u5pKiN4vC27VuvzprSdJxWoAvluOiDeRh+/oeQDowxoT/Oop8DzB9uJmjktXw8jyMW2+Rpg+ENQqeNgF1OGlEzypaWiRskEFlkpLb4v/s3ZDYkL1oW0Nv/J8LTjTOTEaYt2Udjoe9x2xWiGnQixhdChWuG+MaoWffzUgx1tsVj/DBXijR5DjkPkrA1GA98zd3q8GKEaAdcDenJjHhNYSd4+rE9pIsnYn7fo5X/tFfcQH1XQ== nobody@google.com"],
* computeCount: 4,
* hostnamePrefix: "hostname1",
* shape: "VM.Standard.x86",
* initialDataStorageSizeGb: 256,
* databaseEdition: "STANDARD_EDITION",
* licenseModel: "LICENSE_INCLUDED",
* timeZone: {
* id: "UTC",
* },
* dbHome: {
* dbVersion: "19.0.0.0",
* database: {
* adminPassword: "ABcde_1#234",
* databaseId: "mydb",
* dbName: "db",
* dbUniqueName: "db",
* },
* },
* },
* deletionProtection: true,
* });
* ```
* ### Oracledatabase Db System Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const myDbSystem = new gcp.oracledatabase.DbSystem("my_db_system", {
* dbSystemId: "my-instance",
* displayName: "my-instance displayname",
* location: "europe-west2",
* project: "my-project",
* odbNetwork: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork",
* odbSubnet: "projects/my-project/locations/europe-west2/odbNetworks/my-odbnetwork/odbSubnets/my-odbsubnet",
* properties: {
* sshPublicKeys: ["ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAACAQCz1X2744t+6vRLmE5u6nHi6/QWh8bQDgHmd+OIxRQIGA/IWUtCs2FnaCNZcqvZkaeyjk5v0lTA/n+9jvO42Ipib53athrfVG8gRt8fzPL66C6ZqHq+6zZophhrCdfJh/0G4x9xJh5gdMprlaCR1P8yAaVvhBQSKGc4SiIkyMNBcHJ5YTtMQMTfxaB4G1sHZ6SDAY9a6Cq/zNjDwfPapWLsiP4mRhE5SSjJX6l6EYbkm0JeLQg+AbJiNEPvrvDp1wtTxzlPJtIivthmLMThFxK7+DkrYFuLvN5AHUdo9KTDLvHtDCvV70r8v0gafsrKkM/OE9Jtzoo0e1N/5K/ZdyFRbAkFT4QSF3nwpbmBWLf2Evg//YyEuxnz4CwPqFST2mucnrCCGCVWp1vnHZ0y30nM35njLOmWdRDFy5l27pKUTwLp02y3UYiiZyP7d3/u5pKiN4vC27VuvzprSdJxWoAvluOiDeRh+/oeQDowxoT/Oop8DzB9uJmjktXw8jyMW2+Rpg+ENQqeNgF1OGlEzypaWiRskEFlkpLb4v/s3ZDYkL1oW0Nv/J8LTjTOTEaYt2Udjoe9x2xWiGnQixhdChWuG+MaoWffzUgx1tsVj/DBXijR5DjkPkrA1GA98zd3q8GKEaAdcDenJjHhNYSd4+rE9pIsnYn7fo5X/tFfcQH1XQ== nobody@google.com"],
* computeCount: 4,
* hostnamePrefix: "hostname4",
* computeModel: "ECPU",
* dataStorageSizeGb: 256,
* memorySizeGb: 8,
* shape: "VM.Standard.x86",
* initialDataStorageSizeGb: 256,
* databaseEdition: "STANDARD_EDITION",
* licenseModel: "LICENSE_INCLUDED",
* dbHome: {
* dbVersion: "19.0.0.0",
* database: {
* dbName: "db",
* dbUniqueName: "db",
* adminPassword: "ABcde_1#2345",
* tdeWalletPassword: "ABcde_1#2345",
* databaseId: "mydb",
* pluggableDatabaseId: "mypdb",
* pluggableDatabaseName: "mypdb",
* },
* isUnifiedAuditingEnabled: true,
* },
* },
* deletionProtection: true,
* });
* ```
*
* ## Import
*
* DbSystem can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/dbSystems/{{db_system_id}}`
* * `{{project}}/{{location}}/{{db_system_id}}`
* * `{{location}}/{{db_system_id}}`
*
* When using the `pulumi import` command, DbSystem can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:oracledatabase/dbSystem:DbSystem default projects/{{project}}/locations/{{location}}/dbSystems/{{db_system_id}}
* $ pulumi import gcp:oracledatabase/dbSystem:DbSystem default {{project}}/{{location}}/{{db_system_id}}
* $ pulumi import gcp:oracledatabase/dbSystem:DbSystem default {{location}}/{{db_system_id}}
* ```
*/
export declare class DbSystem extends pulumi.CustomResource {
/**
* Get an existing DbSystem 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?: DbSystemState, opts?: pulumi.CustomResourceOptions): DbSystem;
/**
* Returns true if the given object is an instance of DbSystem. 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 DbSystem;
/**
* The date and time that the DbSystem was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* The ID of the DbSystem 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 dbSystemId: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
readonly deletionPolicy: pulumi.Output<string>;
/**
* Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail.
*/
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The display name for the System db. 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 DbSystem
*/
readonly entitlementId: pulumi.Output<string>;
/**
* The GCP Oracle zone where Oracle DbSystem is hosted.
* Example: us-east4-b-r2.
* If not specified, the system will pick a zone based on availability.
*/
readonly gcpOracleZone: pulumi.Output<string>;
/**
* The labels or tags associated with the DbSystem.
* **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`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly location: pulumi.Output<string>;
/**
* Identifier. The name of the DbSystem resource in the following format:
* projects/{project}/locations/{region}/dbSystems/{db_system}
*/
readonly name: pulumi.Output<string>;
/**
* HTTPS link to OCI resources exposed to Customer via UI Interface.
*/
readonly ociUrl: pulumi.Output<string>;
/**
* The name of the OdbNetwork associated with the DbSystem.
* Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the OdbSubnet.
*/
readonly odbNetwork: pulumi.Output<string | undefined>;
/**
* The name of the OdbSubnet associated with the DbSystem 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 a DbSystem.
* Structure is documented below.
*/
readonly properties: pulumi.Output<outputs.oracledatabase.DbSystemProperties | undefined>;
/**
* 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 DbSystem 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: DbSystemArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering DbSystem resources.
*/
export interface DbSystemState {
/**
* The date and time that the DbSystem was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* The ID of the DbSystem 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.
*/
dbSystemId?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* The display name for the System db. The name does not have to
* be unique within your project.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* 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>;
} | undefined>;
/**
* The ID of the subscription entitlement associated with the DbSystem
*/
entitlementId?: pulumi.Input<string | undefined>;
/**
* The GCP Oracle zone where Oracle DbSystem is hosted.
* Example: us-east4-b-r2.
* If not specified, the system will pick a zone based on availability.
*/
gcpOracleZone?: pulumi.Input<string | undefined>;
/**
* The labels or tags associated with the DbSystem.
* **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>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location?: pulumi.Input<string | undefined>;
/**
* Identifier. The name of the DbSystem resource in the following format:
* projects/{project}/locations/{region}/dbSystems/{db_system}
*/
name?: pulumi.Input<string | undefined>;
/**
* HTTPS link to OCI resources exposed to Customer via UI Interface.
*/
ociUrl?: pulumi.Input<string | undefined>;
/**
* The name of the OdbNetwork associated with the DbSystem.
* Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the OdbSubnet.
*/
odbNetwork?: pulumi.Input<string | undefined>;
/**
* The name of the OdbSubnet associated with the DbSystem for IP
* allocation. Format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
odbSubnet?: pulumi.Input<string | undefined>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string | undefined>;
/**
* The properties of a DbSystem.
* Structure is documented below.
*/
properties?: pulumi.Input<inputs.oracledatabase.DbSystemProperties | undefined>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
}
/**
* The set of arguments for constructing a DbSystem resource.
*/
export interface DbSystemArgs {
/**
* The ID of the DbSystem 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.
*/
dbSystemId: pulumi.Input<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to DELETE.
* When a 'terraform destroy' or 'pulumi up' would delete the resource,
* the command will fail if this field is set to "PREVENT" in Terraform state.
* When set to "ABANDON", the command will remove the resource from Terraform
* management without updating or deleting the resource in the API.
* When set to "DELETE", deleting the resource is allowed.
*/
deletionPolicy?: pulumi.Input<string | undefined>;
/**
* Whether or not to allow Terraform to destroy the instance. Unless this field is set to false in Terraform state, a terraform destroy or pulumi up that would delete the instance will fail.
*/
deletionProtection?: pulumi.Input<boolean | undefined>;
/**
* The display name for the System db. The name does not have to
* be unique within your project.
*/
displayName: pulumi.Input<string>;
/**
* The GCP Oracle zone where Oracle DbSystem is hosted.
* Example: us-east4-b-r2.
* If not specified, the system will pick a zone based on availability.
*/
gcpOracleZone?: pulumi.Input<string | undefined>;
/**
* The labels or tags associated with the DbSystem.
* **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>;
} | undefined>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
location: pulumi.Input<string>;
/**
* The name of the OdbNetwork associated with the DbSystem.
* Format: projects/{project}/locations/{location}/odbNetworks/{odb_network}
* It is optional but if specified, this should match the parent ODBNetwork of
* the OdbSubnet.
*/
odbNetwork?: pulumi.Input<string | undefined>;
/**
* The name of the OdbSubnet associated with the DbSystem 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 | undefined>;
/**
* The properties of a DbSystem.
* Structure is documented below.
*/
properties?: pulumi.Input<inputs.oracledatabase.DbSystemProperties | undefined>;
}
//# sourceMappingURL=dbSystem.d.ts.map