TargetServer class
TargetServer configuration. TargetServers are used to decouple a proxy TargetEndpoint HTTPTargetConnections from concrete URLs for backend services.
To get more information about TargetServer, see:
- API documentation
- How-to Guides
- Load balancing across backend servers
Example Usage
Apigee Target Server Test Basic
import * as pulumi from "@pulumi/pulumi";
import * as gcp from "@pulumi/gcp";
const project = new gcp.organizations.Project("project", {
projectId: "my-project",
name: "my-project",
orgId: "123456789",
billingAccount: "000000-0000000-0000000-000000",
deletionPolicy: "DELETE",
});
const apigee = new gcp.projects.Service("apigee", {
project: project.projectId,
service: "apigee.googleapis.com",
});
const servicenetworking = new gcp.projects.Service("servicenetworking", {
project: project.projectId,
service: "servicenetworking.googleapis.com",
}, {
dependsOn: [apigee],
});
const compute = new gcp.projects.Service("compute", {
project: project.projectId,
service: "compute.googleapis.com",
}, {
dependsOn: [servicenetworking],
});
const apigeeNetwork = new gcp.compute.Network("apigee_network", {
name: "apigee-network",
project: project.projectId,
}, {
dependsOn: [compute],
});
const apigeeRange = new gcp.compute.GlobalAddress("apigee_range", {
name: "apigee-range",
purpose: "VPC_PEERING",
addressType: "INTERNAL",
prefixLength: 16,
network: apigeeNetwork.id,
project: project.projectId,
});
const apigeeVpcConnection = new gcp.servicenetworking.Connection("apigee_vpc_connection", {
network: apigeeNetwork.id,
service: "servicenetworking.googleapis.com",
reservedPeeringRanges: [apigeeRange.name],
}, {
dependsOn: [servicenetworking],
});
const apigeeOrg = new gcp.apigee.Organization("apigee_org", {
analyticsRegion: "us-central1",
projectId: project.projectId,
authorizedNetwork: apigeeNetwork.id,
}, {
dependsOn: [
apigeeVpcConnection,
apigee,
],
});
const apigeeEnvironment = new gcp.apigee.Environment("apigee_environment", {
orgId: apigeeOrg.id,
name: "my-environment-name",
description: "Apigee Environment",
displayName: "environment-1",
});
const apigeeTargetServer = new gcp.apigee.TargetServer("apigee_target_server", {
name: "my-target-server",
description: "Apigee Target Server",
protocol: "HTTP",
host: "abc.foo.com",
port: 8080,
envId: apigeeEnvironment.id,
});
import pulumi
import pulumi_gcp as gcp
project = gcp.organizations.Project("project",
project_id="my-project",
name="my-project",
org_id="123456789",
billing_account="000000-0000000-0000000-000000",
deletion_policy="DELETE")
apigee = gcp.projects.Service("apigee",
project=project.project_id,
service="apigee.googleapis.com")
servicenetworking = gcp.projects.Service("servicenetworking",
project=project.project_id,
service="servicenetworking.googleapis.com",
opts = pulumi.ResourceOptions(depends_on=[apigee]))
compute = gcp.projects.Service("compute",
project=project.project_id,
service="compute.googleapis.com",
opts = pulumi.ResourceOptions(depends_on=[servicenetworking]))
apigee_network = gcp.compute.Network("apigee_network",
name="apigee-network",
project=project.project_id,
opts = pulumi.ResourceOptions(depends_on=[compute]))
apigee_range = gcp.compute.GlobalAddress("apigee_range",
name="apigee-range",
purpose="VPC_PEERING",
address_type="INTERNAL",
prefix_length=16,
network=apigee_network.id,
project=project.project_id)
apigee_vpc_connection = gcp.servicenetworking.Connection("apigee_vpc_connection",
network=apigee_network.id,
service="servicenetworking.googleapis.com",
reserved_peering_ranges=[apigee_range.name],
opts = pulumi.ResourceOptions(depends_on=[servicenetworking]))
apigee_org = gcp.apigee.Organization("apigee_org",
analytics_region="us-central1",
project_id=project.project_id,
authorized_network=apigee_network.id,
opts = pulumi.ResourceOptions(depends_on=[
apigee_vpc_connection,
apigee,
]))
apigee_environment = gcp.apigee.Environment("apigee_environment",
org_id=apigee_org.id,
name="my-environment-name",
description="Apigee Environment",
display_name="environment-1")
apigee_target_server = gcp.apigee.TargetServer("apigee_target_server",
name="my-target-server",
description="Apigee Target Server",
protocol="HTTP",
host="abc.foo.com",
port=8080,
env_id=apigee_environment.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Gcp = Pulumi.Gcp;
return await Deployment.RunAsync(() =>
{
var project = new Gcp.Organizations.Project("project", new()
{
ProjectId = "my-project",
Name = "my-project",
OrgId = "123456789",
BillingAccount = "000000-0000000-0000000-000000",
DeletionPolicy = "DELETE",
});
var apigee = new Gcp.Projects.Service("apigee", new()
{
Project = project.ProjectId,
ServiceName = "apigee.googleapis.com",
});
var servicenetworking = new Gcp.Projects.Service("servicenetworking", new()
{
Project = project.ProjectId,
ServiceName = "servicenetworking.googleapis.com",
}, new CustomResourceOptions
{
DependsOn =
{
apigee,
},
});
var compute = new Gcp.Projects.Service("compute", new()
{
Project = project.ProjectId,
ServiceName = "compute.googleapis.com",
}, new CustomResourceOptions
{
DependsOn =
{
servicenetworking,
},
});
var apigeeNetwork = new Gcp.Compute.Network("apigee_network", new()
{
Name = "apigee-network",
Project = project.ProjectId,
}, new CustomResourceOptions
{
DependsOn =
{
compute,
},
});
var apigeeRange = new Gcp.Compute.GlobalAddress("apigee_range", new()
{
Name = "apigee-range",
Purpose = "VPC_PEERING",
AddressType = "INTERNAL",
PrefixLength = 16,
Network = apigeeNetwork.Id,
Project = project.ProjectId,
});
var apigeeVpcConnection = new Gcp.ServiceNetworking.Connection("apigee_vpc_connection", new()
{
Network = apigeeNetwork.Id,
Service = "servicenetworking.googleapis.com",
ReservedPeeringRanges = new[]
{
apigeeRange.Name,
},
}, new CustomResourceOptions
{
DependsOn =
{
servicenetworking,
},
});
var apigeeOrg = new Gcp.Apigee.Organization("apigee_org", new()
{
AnalyticsRegion = "us-central1",
ProjectId = project.ProjectId,
AuthorizedNetwork = apigeeNetwork.Id,
}, new CustomResourceOptions
{
DependsOn =
{
apigeeVpcConnection,
apigee,
},
});
var apigeeEnvironment = new Gcp.Apigee.Environment("apigee_environment", new()
{
OrgId = apigeeOrg.Id,
Name = "my-environment-name",
Description = "Apigee Environment",
DisplayName = "environment-1",
});
var apigeeTargetServer = new Gcp.Apigee.TargetServer("apigee_target_server", new()
{
Name = "my-target-server",
Description = "Apigee Target Server",
Protocol = "HTTP",
Host = "abc.foo.com",
Port = 8080,
EnvId = apigeeEnvironment.Id,
});
});
package main
import (
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/apigee"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/compute"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/organizations"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/projects"
"github.com/pulumi/pulumi-gcp/sdk/v9/go/gcp/servicenetworking"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
project, err := organizations.NewProject(ctx, "project", &organizations.ProjectArgs{
ProjectId: pulumi.String("my-project"),
Name: pulumi.String("my-project"),
OrgId: pulumi.String("123456789"),
BillingAccount: pulumi.String("000000-0000000-0000000-000000"),
DeletionPolicy: pulumi.String("DELETE"),
})
if err != nil {
return err
}
apigee2, err := projects.NewService(ctx, "apigee", &projects.ServiceArgs{
Project: project.ProjectId,
Service: pulumi.String("apigee.googleapis.com"),
})
if err != nil {
return err
}
servicenetworking2, err := projects.NewService(ctx, "servicenetworking", &projects.ServiceArgs{
Project: project.ProjectId,
Service: pulumi.String("servicenetworking.googleapis.com"),
}, pulumi.DependsOn([]pulumi.Resource{
apigee2,
}))
if err != nil {
return err
}
compute2, err := projects.NewService(ctx, "compute", &projects.ServiceArgs{
Project: project.ProjectId,
Service: pulumi.String("compute.googleapis.com"),
}, pulumi.DependsOn([]pulumi.Resource{
servicenetworking2,
}))
if err != nil {
return err
}
apigeeNetwork, err := compute.NewNetwork(ctx, "apigee_network", &compute.NetworkArgs{
Name: pulumi.String("apigee-network"),
Project: project.ProjectId,
}, pulumi.DependsOn([]pulumi.Resource{
compute2,
}))
if err != nil {
return err
}
apigeeRange, err := compute.NewGlobalAddress(ctx, "apigee_range", &compute.GlobalAddressArgs{
Name: pulumi.String("apigee-range"),
Purpose: pulumi.String("VPC_PEERING"),
AddressType: pulumi.String("INTERNAL"),
PrefixLength: pulumi.Int(16),
Network: apigeeNetwork.ID().ToIDOutput().ToStringOutput(),
Project: project.ProjectId,
})
if err != nil {
return err
}
apigeeVpcConnection, err := servicenetworking.NewConnection(ctx, "apigee_vpc_connection", &servicenetworking.ConnectionArgs{
Network: apigeeNetwork.ID().ToIDOutput().ToStringOutput(),
Service: pulumi.String("servicenetworking.googleapis.com"),
ReservedPeeringRanges: pulumi.StringArray{
apigeeRange.Name,
},
}, pulumi.DependsOn([]pulumi.Resource{
servicenetworking2,
}))
if err != nil {
return err
}
apigeeOrg, err := apigee.NewOrganization(ctx, "apigee_org", &apigee.OrganizationArgs{
AnalyticsRegion: pulumi.String("us-central1"),
ProjectId: project.ProjectId,
AuthorizedNetwork: apigeeNetwork.ID().ToIDOutput().ToStringOutput(),
}, pulumi.DependsOn([]pulumi.Resource{
apigeeVpcConnection,
apigee2,
}))
if err != nil {
return err
}
apigeeEnvironment, err := apigee.NewEnvironment(ctx, "apigee_environment", &apigee.EnvironmentArgs{
OrgId: apigeeOrg.ID().ToIDOutput().ToStringOutput(),
Name: pulumi.String("my-environment-name"),
Description: pulumi.String("Apigee Environment"),
DisplayName: pulumi.String("environment-1"),
})
if err != nil {
return err
}
_, err = apigee.NewTargetServer(ctx, "apigee_target_server", &apigee.TargetServerArgs{
Name: pulumi.String("my-target-server"),
Description: pulumi.String("Apigee Target Server"),
Protocol: pulumi.String("HTTP"),
Host: pulumi.String("abc.foo.com"),
Port: pulumi.Int(8080),
EnvId: apigeeEnvironment.ID().ToIDOutput().ToStringOutput(),
})
if err != nil {
return err
}
return nil
})
}
pulumi {
required_providers {
gcp = {
source = "pulumi/gcp"
}
}
}
resource "gcp_organizations_project" "project" {
project_id = "my-project"
name = "my-project"
org_id = "123456789"
billing_account = "000000-0000000-0000000-000000"
deletion_policy = "DELETE"
}
resource "gcp_projects_service" "apigee" {
project = gcp_organizations_project.project.project_id
service = "apigee.googleapis.com"
}
resource "gcp_projects_service" "servicenetworking" {
depends_on = [gcp_projects_service.apigee]
project = gcp_organizations_project.project.project_id
service = "servicenetworking.googleapis.com"
}
resource "gcp_projects_service" "compute" {
depends_on = [gcp_projects_service.servicenetworking]
project = gcp_organizations_project.project.project_id
service = "compute.googleapis.com"
}
resource "gcp_compute_network" "apigee_network" {
depends_on = [gcp_projects_service.compute]
name = "apigee-network"
project = gcp_organizations_project.project.project_id
}
resource "gcp_compute_globaladdress" "apigee_range" {
name = "apigee-range"
purpose = "VPC_PEERING"
address_type = "INTERNAL"
prefix_length = 16
network = gcp_compute_network.apigee_network.id
project = gcp_organizations_project.project.project_id
}
resource "gcp_servicenetworking_connection" "apigee_vpc_connection" {
depends_on = [gcp_projects_service.servicenetworking]
network = gcp_compute_network.apigee_network.id
service = "servicenetworking.googleapis.com"
reserved_peering_ranges = [gcp_compute_globaladdress.apigee_range.name]
}
resource "gcp_apigee_organization" "apigee_org" {
depends_on = [gcp_servicenetworking_connection.apigee_vpc_connection, gcp_projects_service.apigee]
analytics_region = "us-central1"
project_id = gcp_organizations_project.project.project_id
authorized_network = gcp_compute_network.apigee_network.id
}
resource "gcp_apigee_environment" "apigee_environment" {
org_id = gcp_apigee_organization.apigee_org.id
name = "my-environment-name"
description = "Apigee Environment"
display_name = "environment-1"
}
resource "gcp_apigee_targetserver" "apigee_target_server" {
name = "my-target-server"
description = "Apigee Target Server"
protocol = "HTTP"
host = "abc.foo.com"
port = 8080
env_id = gcp_apigee_environment.apigee_environment.id
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.gcp.organizations.Project;
import com.pulumi.gcp.organizations.ProjectArgs;
import com.pulumi.gcp.projects.Service;
import com.pulumi.gcp.projects.ServiceArgs;
import com.pulumi.gcp.compute.Network;
import com.pulumi.gcp.compute.NetworkArgs;
import com.pulumi.gcp.compute.GlobalAddress;
import com.pulumi.gcp.compute.GlobalAddressArgs;
import com.pulumi.gcp.servicenetworking.Connection;
import com.pulumi.gcp.servicenetworking.ConnectionArgs;
import com.pulumi.gcp.apigee.Organization;
import com.pulumi.gcp.apigee.OrganizationArgs;
import com.pulumi.gcp.apigee.Environment;
import com.pulumi.gcp.apigee.EnvironmentArgs;
import com.pulumi.gcp.apigee.TargetServer;
import com.pulumi.gcp.apigee.TargetServerArgs;
import com.pulumi.resources.CustomResourceOptions;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var project = new Project("project", ProjectArgs.builder()
.projectId("my-project")
.name("my-project")
.orgId("123456789")
.billingAccount("000000-0000000-0000000-000000")
.deletionPolicy("DELETE")
.build());
var apigee = new Service("apigee", ServiceArgs.builder()
.project(project.projectId())
.service("apigee.googleapis.com")
.build());
var servicenetworking = new Service("servicenetworking", ServiceArgs.builder()
.project(project.projectId())
.service("servicenetworking.googleapis.com")
.build(), CustomResourceOptions.builder()
.dependsOn(apigee)
.build());
var compute = new Service("compute", ServiceArgs.builder()
.project(project.projectId())
.service("compute.googleapis.com")
.build(), CustomResourceOptions.builder()
.dependsOn(servicenetworking)
.build());
var apigeeNetwork = new Network("apigeeNetwork", NetworkArgs.builder()
.name("apigee-network")
.project(project.projectId())
.build(), CustomResourceOptions.builder()
.dependsOn(compute)
.build());
var apigeeRange = new GlobalAddress("apigeeRange", GlobalAddressArgs.builder()
.name("apigee-range")
.purpose("VPC_PEERING")
.addressType("INTERNAL")
.prefixLength(16)
.network(apigeeNetwork.id())
.project(project.projectId())
.build());
var apigeeVpcConnection = new Connection("apigeeVpcConnection", ConnectionArgs.builder()
.network(apigeeNetwork.id())
.service("servicenetworking.googleapis.com")
.reservedPeeringRanges(apigeeRange.name())
.build(), CustomResourceOptions.builder()
.dependsOn(servicenetworking)
.build());
var apigeeOrg = new Organization("apigeeOrg", OrganizationArgs.builder()
.analyticsRegion("us-central1")
.projectId(project.projectId())
.authorizedNetwork(apigeeNetwork.id())
.build(), CustomResourceOptions.builder()
.dependsOn(
apigeeVpcConnection,
apigee)
.build());
var apigeeEnvironment = new Environment("apigeeEnvironment", EnvironmentArgs.builder()
.orgId(apigeeOrg.id())
.name("my-environment-name")
.description("Apigee Environment")
.displayName("environment-1")
.build());
var apigeeTargetServer = new TargetServer("apigeeTargetServer", TargetServerArgs.builder()
.name("my-target-server")
.description("Apigee Target Server")
.protocol("HTTP")
.host("abc.foo.com")
.port(8080)
.envId(apigeeEnvironment.id())
.build());
}
}
resources:
project:
type: gcp:organizations:Project
properties:
projectId: my-project
name: my-project
orgId: '123456789'
billingAccount: 000000-0000000-0000000-000000
deletionPolicy: DELETE
apigee:
type: gcp:projects:Service
properties:
project: ${project.projectId}
service: apigee.googleapis.com
servicenetworking:
type: gcp:projects:Service
properties:
project: ${project.projectId}
service: servicenetworking.googleapis.com
options:
dependsOn:
- ${apigee}
compute:
type: gcp:projects:Service
properties:
project: ${project.projectId}
service: compute.googleapis.com
options:
dependsOn:
- ${servicenetworking}
apigeeNetwork:
type: gcp:compute:Network
name: apigee_network
properties:
name: apigee-network
project: ${project.projectId}
options:
dependsOn:
- ${compute}
apigeeRange:
type: gcp:compute:GlobalAddress
name: apigee_range
properties:
name: apigee-range
purpose: VPC_PEERING
addressType: INTERNAL
prefixLength: 16
network: ${apigeeNetwork.id}
project: ${project.projectId}
apigeeVpcConnection:
type: gcp:servicenetworking:Connection
name: apigee_vpc_connection
properties:
network: ${apigeeNetwork.id}
service: servicenetworking.googleapis.com
reservedPeeringRanges:
- ${apigeeRange.name}
options:
dependsOn:
- ${servicenetworking}
apigeeOrg:
type: gcp:apigee:Organization
name: apigee_org
properties:
analyticsRegion: us-central1
projectId: ${project.projectId}
authorizedNetwork: ${apigeeNetwork.id}
options:
dependsOn:
- ${apigeeVpcConnection}
- ${apigee}
apigeeEnvironment:
type: gcp:apigee:Environment
name: apigee_environment
properties:
orgId: ${apigeeOrg.id}
name: my-environment-name
description: Apigee Environment
displayName: environment-1
apigeeTargetServer:
type: gcp:apigee:TargetServer
name: apigee_target_server
properties:
name: my-target-server
description: Apigee Target Server
protocol: HTTP
host: abc.foo.com
port: 8080
envId: ${apigeeEnvironment.id}
Import
TargetServer can be imported using any of these accepted formats:
{{env_id}}/targetservers/{{name}}{{env_id}}/{{name}}
When using the pulumi import command, TargetServer can be imported using one of the formats above. For example:
$ pulumi import gcp:apigee/targetServer:TargetServer default {{env_id}}/targetservers/{{name}}
$ pulumi import gcp:apigee/targetServer:TargetServer default {{env_id}}/{{name}}
Constructors
- TargetServer(String name, {TargetServerArgs? args, CustomResourceOptions? options})
-
Creates a new TargetServer.
nameThe Pulumi resource name.argsArguments used to configure this TargetServer. The set of arguments for TargetServer.optionsResource options controlling this resource's behavior. - TargetServer.reference(String urn)
- Creates a typed reference to an existing TargetServer resource.
Properties
-
childResources
→ Set<
Resource> -
finalinherited
-
completionSources
↔ Map<
String, IOutputCompletionSource> -
latefinalinherited
-
deletionPolicy
↔ 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.
latefinal
-
description
↔ Output<
String?> -
A human-readable description of this TargetServer.
latefinal
-
envId
↔ Output<
String> -
The Apigee environment group associated with the Apigee environment,
in the format
organizations/{{org_name}}/environments/{{env_name}}.latefinal - hashCode → int
-
The hash code for this object.
no setterinherited
-
host
↔ Output<
String> -
The host name this target connects to. Value must be a valid hostname as described by RFC-1123.
latefinal
-
id
↔ Output<
String> -
getter/setter pairinherited
- isCustom → bool
-
Returns whether this resource is provider-managed.
no setterinherited
-
isEnabled
↔ Output<
bool?> -
Enabling/disabling a TargetServer is useful when TargetServers are used in load balancing configurations, and one or more TargetServers need to taken out of rotation periodically. Defaults to true.
latefinal
- isProtected → bool
-
Returns whether this resource is protected from deletion.
no setterinherited
- isRemote → bool
-
Whether this resource is registered as remote.
no setterinherited
- isResourceReference → bool
-
Whether this instance represents a resource value returned over RPC.
finalinherited
-
name
↔ Output<
String> -
The resource id of this reference. Values must match the regular expression
\w\s-.+.latefinal -
port
↔ Output<
int> -
The port number this target connects to on the given host. Value must be between 1 and 65535, inclusive.
latefinal
-
protocol
↔ Output<
String> -
Immutable. The protocol used by this TargetServer.
Possible values are:
HTTP,HTTP2,GRPC_TARGET,GRPC,EXTERNAL_CALLOUT.latefinal -
resourceTransforms
→ List<
ResourceTransform> -
Inherited/explicit async transforms.
no setterinherited
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
-
sSlInfo
↔ Output<
TargetServerSSlInfo?> -
Specifies TLS configuration info for this TargetServer. The JSON name is sSLInfo for legacy/backwards compatibility reasons -- Edge originally supported SSL, and the name is still used for TLS configuration.
Structure is documented below.
latefinal
-
transformations
→ List<
ResourceTransformation> -
Inherited/explicit legacy transformations.
no setterinherited
-
urn
↔ Output<
String> -
latefinalinherited
Methods
-
failId(
Object error) → void -
Completes this resource ID with an error when registration fails.
inherited
-
failOutputs(
Object error) → void -
Completes all output properties with
error.inherited -
failUrn(
Object error) → void -
Completes this resource URN with an error when registration fails.
inherited
-
getProvider(
String moduleMember) → ProviderResource? -
Returns provider for
moduleMember's package, if configured.inherited -
getResourceName(
) → String -
Returns this resource's logical name.
inherited
-
getResourceType(
) → String -
Returns this resource's Pulumi type token.
inherited
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
registerOutput<
T> (String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output< T> -
Registers a dynamic output property for this resource.
inherited
-
resolveId(
String? value, {required bool isKnown}) → void -
Resolves the provider-assigned ID for this resource.
inherited
-
resolveOutputs(
Struct outputs) → void -
Resolves all output properties from a monitor response payload.
inherited
-
resolveUrn(
String value) → void -
Resolves this resource's URN once assigned by the engine.
inherited
-
serializeProperties(
Map< String, dynamic> properties) → Future<Struct> -
Serializes resource properties for RPC transmission.
inherited
-
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited
Static Methods
-
get(
String name, Input< String> id, {TargetServerState? state, CustomResourceOptions? options}) → TargetServer -
Gets an existing TargetServer resource's state with the given
nameandid.