@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
265 lines • 12.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
/**
* This resource helps to assign a GoldengateConnection to a GoldengateDeployment used for actual data replication and transformations.
*
* ## Example Usage
*
* ### Oracledatabase Goldengate Connection Assignment Full
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const assignment = new gcp.oracledatabase.GoldengateConnectionAssignment("assignment", {
* goldengateConnectionAssignmentId: "my-assignment",
* displayName: "my-assignment",
* location: "us-east4",
* project: "my-project",
* labels: {
* "label-one": "value-one",
* },
* properties: {
* goldengateConnection: "projects/my-project/locations/us-east4/goldengateConnections/my-connection",
* goldengateDeployment: "projects/my-project/locations/us-east4/goldengateDeployments/my-deployment",
* },
* deletionProtection: true,
* });
* ```
*
* ## Import
*
* GoldengateConnectionAssignment can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/goldengateConnectionAssignments/{{goldengate_connection_assignment_id}}`
* * `{{project}}/{{location}}/{{goldengate_connection_assignment_id}}`
* * `{{location}}/{{goldengate_connection_assignment_id}}`
*
* When using the `pulumi import` command, GoldengateConnectionAssignment can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:oracledatabase/goldengateConnectionAssignment:GoldengateConnectionAssignment default projects/{{project}}/locations/{{location}}/goldengateConnectionAssignments/{{goldengate_connection_assignment_id}}
* $ pulumi import gcp:oracledatabase/goldengateConnectionAssignment:GoldengateConnectionAssignment default {{project}}/{{location}}/{{goldengate_connection_assignment_id}}
* $ pulumi import gcp:oracledatabase/goldengateConnectionAssignment:GoldengateConnectionAssignment default {{location}}/{{goldengate_connection_assignment_id}}
* ```
*/
export declare class GoldengateConnectionAssignment extends pulumi.CustomResource {
/**
* Get an existing GoldengateConnectionAssignment 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?: GoldengateConnectionAssignmentState, opts?: pulumi.CustomResourceOptions): GoldengateConnectionAssignment;
/**
* Returns true if the given object is an instance of GoldengateConnectionAssignment. 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 GoldengateConnectionAssignment;
/**
* The time when the connection assignment was created.
*/
readonly createTime: 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 GoldengateConnectionAssignment.
*/
readonly displayName: pulumi.Output<string | undefined>;
/**
* 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 OCID of the entitlement linked to this resource.
*/
readonly entitlementId: pulumi.Output<string>;
/**
* The ID of the GoldengateConnectionAssignment to create.
*/
readonly goldengateConnectionAssignmentId: pulumi.Output<string>;
/**
* The labels or tags associated with the GoldengateConnectionAssignment.
* **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 GoldengateConnectionAssignment resource in the following
* format:
* projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
*/
readonly name: 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 GoldengateConnectionAssignment.
* Structure is documented below.
*/
readonly properties: pulumi.Output<outputs.oracledatabase.GoldengateConnectionAssignmentProperties>;
/**
* 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 GoldengateConnectionAssignment 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: GoldengateConnectionAssignmentArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering GoldengateConnectionAssignment resources.
*/
export interface GoldengateConnectionAssignmentState {
/**
* The time when the connection assignment was created.
*/
createTime?: 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 GoldengateConnectionAssignment.
*/
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 OCID of the entitlement linked to this resource.
*/
entitlementId?: pulumi.Input<string | undefined>;
/**
* The ID of the GoldengateConnectionAssignment to create.
*/
goldengateConnectionAssignmentId?: pulumi.Input<string | undefined>;
/**
* The labels or tags associated with the GoldengateConnectionAssignment.
* **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 GoldengateConnectionAssignment resource in the following
* format:
* projects/{project}/locations/{region}/goldengateConnectionAssignments/{goldengate_connection_assignment}
*/
name?: 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 GoldengateConnectionAssignment.
* Structure is documented below.
*/
properties?: pulumi.Input<inputs.oracledatabase.GoldengateConnectionAssignmentProperties | 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 GoldengateConnectionAssignment resource.
*/
export interface GoldengateConnectionAssignmentArgs {
/**
* 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 GoldengateConnectionAssignment.
*/
displayName?: pulumi.Input<string | undefined>;
/**
* The ID of the GoldengateConnectionAssignment to create.
*/
goldengateConnectionAssignmentId: pulumi.Input<string>;
/**
* The labels or tags associated with the GoldengateConnectionAssignment.
* **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 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 GoldengateConnectionAssignment.
* Structure is documented below.
*/
properties: pulumi.Input<inputs.oracledatabase.GoldengateConnectionAssignmentProperties>;
}
//# sourceMappingURL=goldengateConnectionAssignment.d.ts.map