@pulumi/gcp/oracledatabase/odbNetwork.d.ts

A Pulumi package for creating and managing Google Cloud Platform resources.

import * as pulumi from "@pulumi/pulumi";
/**
 * An OdbNetwork resource which represents a private network providing connectivity between OracleDatabase resources and Google Cloud VPC network.
 *
 * To get more information about OdbNetwork, see:
 * * How-to Guides
 *     * [OracleDatabase@Google Cloud](https://cloud.google.com/oracle/database/docs/overview')
 *
 * ## Example Usage
 *
 * ### Oracledatabase Odbnetwork
 *
 * ```typescript
 * import * as pulumi from "@pulumi/pulumi";
 * import * as gcp from "@pulumi/gcp";
 *
 * const _default = gcp.compute.getNetwork({
 *     name: "new",
 *     project: "my-project",
 * });
 * const my_odbnetwork = new gcp.oracledatabase.OdbNetwork("my-odbnetwork", {
 *     odbNetworkId: "my-odbnetwork",
 *     location: "us-west3",
 *     project: "my-project",
 *     network: _default.then(_default => _default.id),
 *     labels: {
 *         terraform_created: "true",
 *     },
 *     deletionProtection: true,
 * });
 * ```
 *
 * ## Import
 *
 * OdbNetwork can be imported using any of these accepted formats:
 *
 * * `projects/{{project}}/locations/{{location}}/odbNetworks/{{odb_network_id}}`
 *
 * * `{{project}}/{{location}}/{{odb_network_id}}`
 *
 * * `{{location}}/{{odb_network_id}}`
 *
 * When using the `pulumi import` command, OdbNetwork can be imported using one of the formats above. For example:
 *
 * ```sh
 * $ pulumi import gcp:oracledatabase/odbNetwork:OdbNetwork default projects/{{project}}/locations/{{location}}/odbNetworks/{{odb_network_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:oracledatabase/odbNetwork:OdbNetwork default {{project}}/{{location}}/{{odb_network_id}}
 * ```
 *
 * ```sh
 * $ pulumi import gcp:oracledatabase/odbNetwork:OdbNetwork default {{location}}/{{odb_network_id}}
 * ```
 */
export declare class OdbNetwork extends pulumi.CustomResource {
    /**
     * Get an existing OdbNetwork 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?: OdbNetworkState, opts?: pulumi.CustomResourceOptions): OdbNetwork;
    /**
     * Returns true if the given object is an instance of OdbNetwork.  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 OdbNetwork;
    /**
     * The date and time that the OdbNetwork was created.
     */
    readonly createTime: pulumi.Output<string>;
    readonly deletionProtection: pulumi.Output<boolean | 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 ID of the subscription entitlement associated with the OdbNetwork.
     */
    readonly entitlementId: pulumi.Output<string>;
    /**
     * Labels or tags associated with the resource.
     * **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 OdbNetwork resource in the following format:
     * projects/{project}/locations/{region}/odbNetworks/{odb_network}
     */
    readonly name: pulumi.Output<string>;
    /**
     * The name of the VPC network in the following format:
     * projects/{project}/global/networks/{network}
     */
    readonly network: pulumi.Output<string>;
    /**
     * The ID of the OdbNetwork 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 odbNetworkId: 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 combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    readonly pulumiLabels: pulumi.Output<{
        [key: string]: string;
    }>;
    /**
     * State of the ODB Network.
     * Possible values:
     * PROVISIONING
     * AVAILABLE
     * TERMINATING
     * FAILED
     */
    readonly state: pulumi.Output<string>;
    /**
     * Create a OdbNetwork 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: OdbNetworkArgs, opts?: pulumi.CustomResourceOptions);
}
/**
 * Input properties used for looking up and filtering OdbNetwork resources.
 */
export interface OdbNetworkState {
    /**
     * The date and time that the OdbNetwork was created.
     */
    createTime?: pulumi.Input<string>;
    deletionProtection?: pulumi.Input<boolean>;
    /**
     * 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 OdbNetwork.
     */
    entitlementId?: pulumi.Input<string>;
    /**
     * Labels or tags associated with the resource.
     * **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`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location?: pulumi.Input<string>;
    /**
     * Identifier. The name of the OdbNetwork resource in the following format:
     * projects/{project}/locations/{region}/odbNetworks/{odb_network}
     */
    name?: pulumi.Input<string>;
    /**
     * The name of the VPC network in the following format:
     * projects/{project}/global/networks/{network}
     */
    network?: pulumi.Input<string>;
    /**
     * The ID of the OdbNetwork 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.
     */
    odbNetworkId?: 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 combination of labels configured directly on the resource
     * and default labels configured on the provider.
     */
    pulumiLabels?: pulumi.Input<{
        [key: string]: pulumi.Input<string>;
    }>;
    /**
     * State of the ODB Network.
     * Possible values:
     * PROVISIONING
     * AVAILABLE
     * TERMINATING
     * FAILED
     */
    state?: pulumi.Input<string>;
}
/**
 * The set of arguments for constructing a OdbNetwork resource.
 */
export interface OdbNetworkArgs {
    deletionProtection?: pulumi.Input<boolean>;
    /**
     * Labels or tags associated with the resource.
     * **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`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
     */
    location: pulumi.Input<string>;
    /**
     * The name of the VPC network in the following format:
     * projects/{project}/global/networks/{network}
     */
    network: pulumi.Input<string>;
    /**
     * The ID of the OdbNetwork 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.
     */
    odbNetworkId: 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>;
}