@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
361 lines • 15 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource helps to create a GoldengateDeployment which enables running Oracle GoldenGate in Google Cloud.
*
* ## Example Usage
*
* ### Oracledatabase Goldengate Deployment Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const deployment = new gcp.oracledatabase.GoldengateDeployment("deployment", {
* goldengateDeploymentId: "my-deployment",
* displayName: "my-deployment display name",
* location: "us-east4",
* project: "my-project",
* odbSubnet: "projects/my-project/locations/us-east4/odbNetworks/my-network/odbSubnets/my-subnet",
* properties: {
* deploymentType: "DATABASE_ORACLE",
* oggData: {
* adminUsername: "admin",
* adminPassword: "123Abpassword!",
* deployment: "deployment",
* },
* },
* deletionPolicy: "PREVENT",
* });
* ```
* ### Oracledatabase Goldengate Deployment Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const deployment = new gcp.oracledatabase.GoldengateDeployment("deployment", {
* goldengateDeploymentId: "my-deployment",
* displayName: "my-deployment display name",
* location: "us-east4",
* project: "my-project",
* odbSubnet: "projects/my-project/locations/us-east4/odbNetworks/my-network/odbSubnets/my-subnet",
* odbNetwork: "projects/my-project/locations/us-east4/odbNetworks/my-network",
* gcpOracleZone: "us-east4-b-r1",
* labels: {
* "label-one": "value-one",
* },
* properties: {
* deploymentType: "DATABASE_ORACLE",
* cpuCoreCount: 1,
* isAutoScalingEnabled: false,
* licenseModel: "LICENSE_INCLUDED",
* environmentType: "PRODUCTION",
* description: "This is a test deployment",
* oggData: {
* adminUsername: "admin",
* adminPassword: "123Abpassword!",
* deployment: "deployment",
* },
* maintenanceWindow: {
* day: "MONDAY",
* startHour: 23,
* },
* maintenanceConfig: {
* isInterimReleaseAutoUpgradeEnabled: false,
* interimReleaseUpgradePeriodDays: 0,
* bundleReleaseUpgradePeriodDays: 1,
* majorReleaseUpgradePeriodDays: 2,
* securityPatchUpgradePeriodDays: 1,
* },
* },
* deletionPolicy: "PREVENT",
* });
* ```
*
* ## Import
*
* GoldengateDeployment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/goldengateDeployments/{{goldengate_deployment_id}}`
* * `{{project}}/{{location}}/{{goldengate_deployment_id}}`
* * `{{location}}/{{goldengate_deployment_id}}`
*
* When using the `pulumi import` command, GoldengateDeployment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:oracledatabase/goldengateDeployment:GoldengateDeployment default projects/{{project}}/locations/{{location}}/goldengateDeployments/{{goldengate_deployment_id}}
* $ pulumi import gcp:oracledatabase/goldengateDeployment:GoldengateDeployment default {{project}}/{{location}}/{{goldengate_deployment_id}}
* $ pulumi import gcp:oracledatabase/goldengateDeployment:GoldengateDeployment default {{location}}/{{goldengate_deployment_id}}
* ```
*/
export declare class GoldengateDeployment extends pulumi.CustomResource {
/**
* Get an existing GoldengateDeployment 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?: GoldengateDeploymentState, opts?: pulumi.CustomResourceOptions): GoldengateDeployment;
/**
* Returns true if the given object is an instance of GoldengateDeployment. 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 GoldengateDeployment;
/**
* The date and time that the GoldengateDeployment was created.
*/
readonly createTime: pulumi.Output<string>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to PREVENT.
* 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>;
/**
* The display name for the GoldengateDeployment.
*/
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
* GoldengateDeployment
*/
readonly entitlementId: pulumi.Output<string>;
/**
* The GCP Oracle zone where Oracle GoldengateDeployment 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 ID of the GoldengateDeployment 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 goldengateDeploymentId: pulumi.Output<string>;
/**
* The labels or tags associated with the GoldengateDeployment.
* **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 GoldengateDeployment resource in the following format:
* projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
*/
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 GoldengateDeployment.
*/
readonly odbNetwork: pulumi.Output<string>;
/**
* The name of the OdbSubnet associated with the GoldengateDeployment for IP
* allocation.
*/
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>;
/**
* Properties of GoldengateDeployment.
* Structure is documented below.
*/
readonly properties: pulumi.Output<outputs.oracledatabase.GoldengateDeploymentProperties>;
/**
* 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 GoldengateDeployment 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: GoldengateDeploymentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GoldengateDeployment resources.
*/
export interface GoldengateDeploymentState {
/**
* The date and time that the GoldengateDeployment was created.
*/
createTime?: pulumi.Input<string | undefined>;
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to PREVENT.
* 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>;
/**
* The display name for the GoldengateDeployment.
*/
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
* GoldengateDeployment
*/
entitlementId?: pulumi.Input<string | undefined>;
/**
* The GCP Oracle zone where Oracle GoldengateDeployment 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 ID of the GoldengateDeployment 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.
*/
goldengateDeploymentId?: pulumi.Input<string | undefined>;
/**
* The labels or tags associated with the GoldengateDeployment.
* **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 GoldengateDeployment resource in the following format:
* projects/{project}/locations/{region}/goldengateDeployments/{goldengate_deployment}
*/
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 GoldengateDeployment.
*/
odbNetwork?: pulumi.Input<string | undefined>;
/**
* The name of the OdbSubnet associated with the GoldengateDeployment for IP
* allocation.
*/
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>;
/**
* Properties of GoldengateDeployment.
* Structure is documented below.
*/
properties?: pulumi.Input<inputs.oracledatabase.GoldengateDeploymentProperties | 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 GoldengateDeployment resource.
*/
export interface GoldengateDeploymentArgs {
/**
* Whether Terraform will be prevented from destroying the resource. Defaults to PREVENT.
* 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>;
/**
* The display name for the GoldengateDeployment.
*/
displayName: pulumi.Input<string>;
/**
* The GCP Oracle zone where Oracle GoldengateDeployment 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 ID of the GoldengateDeployment 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.
*/
goldengateDeploymentId: pulumi.Input<string>;
/**
* The labels or tags associated with the GoldengateDeployment.
* **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 GoldengateDeployment.
*/
odbNetwork?: pulumi.Input<string | undefined>;
/**
* The name of the OdbSubnet associated with the GoldengateDeployment for IP
* allocation.
*/
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>;
/**
* Properties of GoldengateDeployment.
* Structure is documented below.
*/
properties: pulumi.Input<inputs.oracledatabase.GoldengateDeploymentProperties>;
}
//# sourceMappingURL=goldengateDeployment.d.ts.map