import * as pulumi from "@pulumi/pulumi"; /** * Represents a Global Address resource. Global addresses are used for * HTTP(S) load balancing. * * To get more information about GlobalAddress, see: * * * [API documentation](https://cloud.google.com/compute/docs/reference/v1/globalAddresses) * * How-to Guides * * [Reserving a Static External IP Address](https://cloud.google.com/compute/docs/ip-addresses/reserve-static-external-ip-address) * * ## Example Usage * * ### Global Address Basic * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const _default = new gcp.compute.GlobalAddress("default", {name: "global-appserver-ip"}); * ``` * ### Global Address Private Services Connect * * ```typescript * import * as pulumi from "@pulumi/pulumi"; * import * as gcp from "@pulumi/gcp"; * * const network = new gcp.compute.Network("network", { * name: "my-network-name", * autoCreateSubnetworks: false, * }); * const _default = new gcp.compute.GlobalAddress("default", { * name: "global-psconnect-ip", * addressType: "INTERNAL", * purpose: "PRIVATE_SERVICE_CONNECT", * network: network.id, * address: "100.100.100.105", * }); * ``` * * ## Import * * GlobalAddress can be imported using any of these accepted formats: * * * `projects/{{project}}/global/addresses/{{name}}` * * `{{project}}/{{name}}` * * `{{name}}` * * When using the `pulumi import` command, GlobalAddress can be imported using one of the formats above. For example: * * ```sh * $ pulumi import gcp:compute/globalAddress:GlobalAddress default projects/{{project}}/global/addresses/{{name}} * $ pulumi import gcp:compute/globalAddress:GlobalAddress default {{project}}/{{name}} * $ pulumi import gcp:compute/globalAddress:GlobalAddress default {{name}} * ``` */ export declare class GlobalAddress extends pulumi.CustomResource { /** * Get an existing GlobalAddress 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, state?: GlobalAddressState, opts?: pulumi.CustomResourceOptions): GlobalAddress; /** * Returns true if the given object is an instance of GlobalAddress. 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 GlobalAddress; /** * The IP address or beginning of the address range represented by this * resource. This can be supplied as an input to reserve a specific * address or omitted to allow GCP to choose a valid one for you. */ readonly address: pulumi.Output; /** * The type of the address to reserve. * * EXTERNAL indicates public/external single IP address. * * INTERNAL indicates internal IP ranges belonging to some network. * Default value is `EXTERNAL`. * Possible values are: `EXTERNAL`, `INTERNAL`. */ readonly addressType: pulumi.Output; /** * Creation timestamp in RFC3339 text format. */ readonly creationTimestamp: pulumi.Output; /** * 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; /** * An optional description of this resource. */ readonly description: pulumi.Output; /** * 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 IP Version that will be used by this address. The default value is `IPV4`. * Possible values are: `IPV4`, `IPV6`. */ readonly ipVersion: pulumi.Output; /** * The fingerprint used for optimistic locking of this resource. Used * internally during updates. */ readonly labelFingerprint: pulumi.Output; /** * Labels to apply to this address. A list of key->value pairs. * * **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>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `a-z?` which means * the first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ readonly name: pulumi.Output; /** * The URL of the network in which to reserve the IP range. The IP range * must be in RFC1918 space. The network cannot be deleted if there are * any reserved IP ranges referring to it. * This should only be set when using an Internal address. */ readonly network: pulumi.Output; /** * The prefix length of the IP range. If not present, it means the * address field is a single IP address. * This field is not applicable to addresses with addressType=INTERNAL * when purpose=PRIVATE_SERVICE_CONNECT */ readonly prefixLength: pulumi.Output; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ readonly project: pulumi.Output; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ readonly pulumiLabels: pulumi.Output<{ [key: string]: string; }>; /** * The purpose of the resource. Possible values include: * * VPC_PEERING - for peer networks * * PRIVATE_SERVICE_CONNECT - for (Beta) only) Private Service Connect networks */ readonly purpose: pulumi.Output; /** * The URI of the created resource. */ readonly selfLink: pulumi.Output; /** * Create a GlobalAddress 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?: GlobalAddressArgs, opts?: pulumi.CustomResourceOptions); } /** * Input properties used for looking up and filtering GlobalAddress resources. */ export interface GlobalAddressState { /** * The IP address or beginning of the address range represented by this * resource. This can be supplied as an input to reserve a specific * address or omitted to allow GCP to choose a valid one for you. */ address?: pulumi.Input; /** * The type of the address to reserve. * * EXTERNAL indicates public/external single IP address. * * INTERNAL indicates internal IP ranges belonging to some network. * Default value is `EXTERNAL`. * Possible values are: `EXTERNAL`, `INTERNAL`. */ addressType?: pulumi.Input; /** * Creation timestamp in RFC3339 text format. */ creationTimestamp?: pulumi.Input; /** * 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; /** * An optional description of this resource. */ description?: pulumi.Input; /** * 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; } | undefined>; /** * The IP Version that will be used by this address. The default value is `IPV4`. * Possible values are: `IPV4`, `IPV6`. */ ipVersion?: pulumi.Input; /** * The fingerprint used for optimistic locking of this resource. Used * internally during updates. */ labelFingerprint?: pulumi.Input; /** * Labels to apply to this address. A list of key->value pairs. * * **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; } | undefined>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `a-z?` which means * the first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input; /** * The URL of the network in which to reserve the IP range. The IP range * must be in RFC1918 space. The network cannot be deleted if there are * any reserved IP ranges referring to it. * This should only be set when using an Internal address. */ network?: pulumi.Input; /** * The prefix length of the IP range. If not present, it means the * address field is a single IP address. * This field is not applicable to addresses with addressType=INTERNAL * when purpose=PRIVATE_SERVICE_CONNECT */ prefixLength?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The combination of labels configured directly on the resource * and default labels configured on the provider. */ pulumiLabels?: pulumi.Input<{ [key: string]: pulumi.Input; } | undefined>; /** * The purpose of the resource. Possible values include: * * VPC_PEERING - for peer networks * * PRIVATE_SERVICE_CONNECT - for (Beta) only) Private Service Connect networks */ purpose?: pulumi.Input; /** * The URI of the created resource. */ selfLink?: pulumi.Input; } /** * The set of arguments for constructing a GlobalAddress resource. */ export interface GlobalAddressArgs { /** * The IP address or beginning of the address range represented by this * resource. This can be supplied as an input to reserve a specific * address or omitted to allow GCP to choose a valid one for you. */ address?: pulumi.Input; /** * The type of the address to reserve. * * EXTERNAL indicates public/external single IP address. * * INTERNAL indicates internal IP ranges belonging to some network. * Default value is `EXTERNAL`. * Possible values are: `EXTERNAL`, `INTERNAL`. */ addressType?: pulumi.Input; /** * 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; /** * An optional description of this resource. */ description?: pulumi.Input; /** * The IP Version that will be used by this address. The default value is `IPV4`. * Possible values are: `IPV4`, `IPV6`. */ ipVersion?: pulumi.Input; /** * Labels to apply to this address. A list of key->value pairs. * * **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; } | undefined>; /** * Name of the resource. Provided by the client when the resource is * created. The name must be 1-63 characters long, and comply with * RFC1035. Specifically, the name must be 1-63 characters long and * match the regular expression `a-z?` which means * the first character must be a lowercase letter, and all following * characters must be a dash, lowercase letter, or digit, except the last * character, which cannot be a dash. */ name?: pulumi.Input; /** * The URL of the network in which to reserve the IP range. The IP range * must be in RFC1918 space. The network cannot be deleted if there are * any reserved IP ranges referring to it. * This should only be set when using an Internal address. */ network?: pulumi.Input; /** * The prefix length of the IP range. If not present, it means the * address field is a single IP address. * This field is not applicable to addresses with addressType=INTERNAL * when purpose=PRIVATE_SERVICE_CONNECT */ prefixLength?: pulumi.Input; /** * The ID of the project in which the resource belongs. * If it is not provided, the provider project is used. */ project?: pulumi.Input; /** * The purpose of the resource. Possible values include: * * VPC_PEERING - for peer networks * * PRIVATE_SERVICE_CONNECT - for (Beta) only) Private Service Connect networks */ purpose?: pulumi.Input; } //# sourceMappingURL=globalAddress.d.ts.map