@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
314 lines (313 loc) • 12.8 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Network endpoint groups (NEGs) are zonal resources that represent
* collections of IP address and port combinations for GCP resources within a
* single subnet. Each IP address and port combination is called a network
* endpoint.
*
* Network endpoint groups can be used as backends in backend services for
* HTTP(S), TCP proxy, and SSL proxy load balancers. You cannot use NEGs as a
* backend with internal load balancers. Because NEG backends allow you to
* specify IP addresses and ports, you can distribute traffic in a granular
* fashion among applications or containers running within VM instances.
*
* Recreating a network endpoint group that's in use by another resource will give a
* `resourceInUseByAnotherResource` error. Use `lifecycle.create_before_destroy`
* to avoid this type of error.
*
* To get more information about NetworkEndpointGroup, see:
*
* * [API documentation](https://cloud.google.com/compute/docs/reference/rest/beta/networkEndpointGroups)
* * How-to Guides
* * [Official Documentation](https://cloud.google.com/load-balancing/docs/negs/)
*
* ## Example Usage
*
* ### Network Endpoint Group
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.Network("default", {
* name: "neg-network",
* autoCreateSubnetworks: false,
* });
* const defaultSubnetwork = new gcp.compute.Subnetwork("default", {
* name: "neg-subnetwork",
* ipCidrRange: "10.0.0.0/16",
* region: "us-central1",
* network: _default.id,
* });
* const neg = new gcp.compute.NetworkEndpointGroup("neg", {
* name: "my-lb-neg",
* network: _default.id,
* subnetwork: defaultSubnetwork.id,
* defaultPort: 90,
* zone: "us-central1-a",
* });
* ```
* ### Network Endpoint Group Non Gcp
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const _default = new gcp.compute.Network("default", {name: "neg-network"});
* const neg = new gcp.compute.NetworkEndpointGroup("neg", {
* name: "my-lb-neg",
* network: _default.id,
* defaultPort: 90,
* zone: "us-central1-a",
* networkEndpointType: "NON_GCP_PRIVATE_IP_PORT",
* });
* const default_endpoint = new gcp.compute.NetworkEndpoint("default-endpoint", {
* networkEndpointGroup: neg.name,
* port: neg.defaultPort,
* ipAddress: "127.0.0.1",
* });
* ```
*
* ## Import
*
* NetworkEndpointGroup can be imported using any of these accepted formats:
*
* * `projects/{{project}}/zones/{{zone}}/networkEndpointGroups/{{name}}`
*
* * `{{project}}/{{zone}}/{{name}}`
*
* * `{{zone}}/{{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, NetworkEndpointGroup can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:compute/networkEndpointGroup:NetworkEndpointGroup default projects/{{project}}/zones/{{zone}}/networkEndpointGroups/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/networkEndpointGroup:NetworkEndpointGroup default {{project}}/{{zone}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/networkEndpointGroup:NetworkEndpointGroup default {{zone}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:compute/networkEndpointGroup:NetworkEndpointGroup default {{name}}
* ```
*/
export declare class NetworkEndpointGroup extends pulumi.CustomResource {
/**
* Get an existing NetworkEndpointGroup 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?: NetworkEndpointGroupState, opts?: pulumi.CustomResourceOptions): NetworkEndpointGroup;
/**
* Returns true if the given object is an instance of NetworkEndpointGroup. 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 NetworkEndpointGroup;
/**
* The default port used if the port number is not specified in the
* network endpoint.
*/
readonly defaultPort: pulumi.Output<number | undefined>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
readonly description: pulumi.Output<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<string>;
/**
* The network to which all network endpoints in the NEG belong.
* Uses "default" project network if unspecified.
*
*
* - - -
*/
readonly network: pulumi.Output<string>;
/**
* Type of network endpoints in this network endpoint group.
* NON_GCP_PRIVATE_IP_PORT is used for hybrid connectivity network
* endpoint groups (see https://cloud.google.com/load-balancing/docs/hybrid).
* Note that NON_GCP_PRIVATE_IP_PORT can only be used with Backend Services
* that 1) have the following load balancing schemes: EXTERNAL, EXTERNAL_MANAGED,
* INTERNAL_MANAGED, and INTERNAL_SELF_MANAGED and 2) support the RATE or
* CONNECTION balancing modes.
* Possible values include: GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_IP_PORT, INTERNET_FQDN_PORT, SERVERLESS, and PRIVATE_SERVICE_CONNECT.
* Default value is `GCE_VM_IP_PORT`.
* Possible values are: `GCE_VM_IP`, `GCE_VM_IP_PORT`, `NON_GCP_PRIVATE_IP_PORT`, `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`, `SERVERLESS`, `PRIVATE_SERVICE_CONNECT`.
*/
readonly networkEndpointType: pulumi.Output<string | undefined>;
/**
* 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 URI of the created resource.
*/
readonly selfLink: pulumi.Output<string>;
/**
* Number of network endpoints in the network endpoint group.
*/
readonly size: pulumi.Output<number>;
/**
* Optional subnetwork to which all network endpoints in the NEG belong.
*/
readonly subnetwork: pulumi.Output<string | undefined>;
/**
* Zone where the network endpoint group is located.
*/
readonly zone: pulumi.Output<string>;
/**
* Create a NetworkEndpointGroup 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: NetworkEndpointGroupArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering NetworkEndpointGroup resources.
*/
export interface NetworkEndpointGroupState {
/**
* The default port used if the port number is not specified in the
* network endpoint.
*/
defaultPort?: pulumi.Input<number>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* 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<string>;
/**
* The network to which all network endpoints in the NEG belong.
* Uses "default" project network if unspecified.
*
*
* - - -
*/
network?: pulumi.Input<string>;
/**
* Type of network endpoints in this network endpoint group.
* NON_GCP_PRIVATE_IP_PORT is used for hybrid connectivity network
* endpoint groups (see https://cloud.google.com/load-balancing/docs/hybrid).
* Note that NON_GCP_PRIVATE_IP_PORT can only be used with Backend Services
* that 1) have the following load balancing schemes: EXTERNAL, EXTERNAL_MANAGED,
* INTERNAL_MANAGED, and INTERNAL_SELF_MANAGED and 2) support the RATE or
* CONNECTION balancing modes.
* Possible values include: GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_IP_PORT, INTERNET_FQDN_PORT, SERVERLESS, and PRIVATE_SERVICE_CONNECT.
* Default value is `GCE_VM_IP_PORT`.
* Possible values are: `GCE_VM_IP`, `GCE_VM_IP_PORT`, `NON_GCP_PRIVATE_IP_PORT`, `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`, `SERVERLESS`, `PRIVATE_SERVICE_CONNECT`.
*/
networkEndpointType?: 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 URI of the created resource.
*/
selfLink?: pulumi.Input<string>;
/**
* Number of network endpoints in the network endpoint group.
*/
size?: pulumi.Input<number>;
/**
* Optional subnetwork to which all network endpoints in the NEG belong.
*/
subnetwork?: pulumi.Input<string>;
/**
* Zone where the network endpoint group is located.
*/
zone?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a NetworkEndpointGroup resource.
*/
export interface NetworkEndpointGroupArgs {
/**
* The default port used if the port number is not specified in the
* network endpoint.
*/
defaultPort?: pulumi.Input<number>;
/**
* An optional description of this resource. Provide this property when
* you create the resource.
*/
description?: pulumi.Input<string>;
/**
* 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<string>;
/**
* The network to which all network endpoints in the NEG belong.
* Uses "default" project network if unspecified.
*
*
* - - -
*/
network: pulumi.Input<string>;
/**
* Type of network endpoints in this network endpoint group.
* NON_GCP_PRIVATE_IP_PORT is used for hybrid connectivity network
* endpoint groups (see https://cloud.google.com/load-balancing/docs/hybrid).
* Note that NON_GCP_PRIVATE_IP_PORT can only be used with Backend Services
* that 1) have the following load balancing schemes: EXTERNAL, EXTERNAL_MANAGED,
* INTERNAL_MANAGED, and INTERNAL_SELF_MANAGED and 2) support the RATE or
* CONNECTION balancing modes.
* Possible values include: GCE_VM_IP, GCE_VM_IP_PORT, NON_GCP_PRIVATE_IP_PORT, INTERNET_IP_PORT, INTERNET_FQDN_PORT, SERVERLESS, and PRIVATE_SERVICE_CONNECT.
* Default value is `GCE_VM_IP_PORT`.
* Possible values are: `GCE_VM_IP`, `GCE_VM_IP_PORT`, `NON_GCP_PRIVATE_IP_PORT`, `INTERNET_IP_PORT`, `INTERNET_FQDN_PORT`, `SERVERLESS`, `PRIVATE_SERVICE_CONNECT`.
*/
networkEndpointType?: 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>;
/**
* Optional subnetwork to which all network endpoints in the NEG belong.
*/
subnetwork?: pulumi.Input<string>;
/**
* Zone where the network endpoint group is located.
*/
zone?: pulumi.Input<string>;
}