@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
300 lines • 12.3 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* An OdbSubnet resource which represents a subnet under an OdbNetwork.
*
* To get more information about OdbSubnet, see:
* * How-to Guides
* * [OracleDatabase@Google Cloud](https://cloud.google.com/oracle/database/docs/overview')
*
* ## Example Usage
*
* ### Oracledatabase Odbsubnet
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const my_odbsubnet = new gcp.oracledatabase.OdbSubnet("my-odbsubnet", {
* odbSubnetId: "my-odbsubnet",
* location: "europe-west2",
* project: "my-project",
* odbnetwork: "my-odbnetwork",
* cidrRange: "10.1.1.0/24",
* purpose: "CLIENT_SUBNET",
* labels: {
* terraform_created: "true",
* },
* deletionProtection: true,
* });
* ```
*
* ## Import
*
* OdbSubnet can be imported using any of these accepted formats:
*
* * `projects/{{project}}/locations/{{location}}/odbNetworks/{{odbnetwork}}/odbSubnets/{{odb_subnet_id}}`
* * `{{project}}/{{location}}/{{odbnetwork}}/{{odb_subnet_id}}`
* * `{{location}}/{{odbnetwork}}/{{odb_subnet_id}}`
*
* When using the `pulumi import` command, OdbSubnet can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:oracledatabase/odbSubnet:OdbSubnet default projects/{{project}}/locations/{{location}}/odbNetworks/{{odbnetwork}}/odbSubnets/{{odb_subnet_id}}
* $ pulumi import gcp:oracledatabase/odbSubnet:OdbSubnet default {{project}}/{{location}}/{{odbnetwork}}/{{odb_subnet_id}}
* $ pulumi import gcp:oracledatabase/odbSubnet:OdbSubnet default {{location}}/{{odbnetwork}}/{{odb_subnet_id}}
* ```
*/
export declare class OdbSubnet extends pulumi.CustomResource {
/**
* Get an existing OdbSubnet 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?: OdbSubnetState, opts?: pulumi.CustomResourceOptions): OdbSubnet;
/**
* Returns true if the given object is an instance of OdbSubnet. 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 OdbSubnet;
/**
* The CIDR range of the subnet.
*/
readonly cidrRange: pulumi.Output<string>;
/**
* The date and time that the OdbNetwork 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>;
/**
* 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;
}>;
/**
* 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 OdbSubnet resource in the following format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the OdbSubnet 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 odbSubnetId: pulumi.Output<string>;
/**
* Resource ID segment making up resource `name`. It identifies the resource within its parent collection as described in https://google.aip.dev/122.
*/
readonly odbnetwork: 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;
}>;
/**
* Purpose of the subnet.
* Possible values:
* CLIENT_SUBNET
* BACKUP_SUBNET
*/
readonly purpose: pulumi.Output<string>;
/**
* State of the ODB Subnet.
* Possible values:
* PROVISIONING
* AVAILABLE
* TERMINATING
* FAILED
*/
readonly state: pulumi.Output<string>;
/**
* Create a OdbSubnet 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: OdbSubnetArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering OdbSubnet resources.
*/
export interface OdbSubnetState {
/**
* The CIDR range of the subnet.
*/
cidrRange?: pulumi.Input<string | undefined>;
/**
* The date and time that the OdbNetwork 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>;
/**
* 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>;
/**
* 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>;
} | 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 OdbSubnet resource in the following format:
* projects/{project}/locations/{location}/odbNetworks/{odb_network}/odbSubnets/{odb_subnet}
*/
name?: pulumi.Input<string | undefined>;
/**
* The ID of the OdbSubnet 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.
*/
odbSubnetId?: 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.
*/
odbnetwork?: 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 combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
} | undefined>;
/**
* Purpose of the subnet.
* Possible values:
* CLIENT_SUBNET
* BACKUP_SUBNET
*/
purpose?: pulumi.Input<string | undefined>;
/**
* State of the ODB Subnet.
* Possible values:
* PROVISIONING
* AVAILABLE
* TERMINATING
* FAILED
*/
state?: pulumi.Input<string | undefined>;
}
/**
* The set of arguments for constructing a OdbSubnet resource.
*/
export interface OdbSubnetArgs {
/**
* The CIDR range of the subnet.
*/
cidrRange: 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>;
/**
* 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>;
} | 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 OdbSubnet 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.
*/
odbSubnetId: 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.
*/
odbnetwork: 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>;
/**
* Purpose of the subnet.
* Possible values:
* CLIENT_SUBNET
* BACKUP_SUBNET
*/
purpose: pulumi.Input<string>;
}
//# sourceMappingURL=odbSubnet.d.ts.map