1. Packages
  2. Kong
  3. API Docs
  4. Target
Kong v4.5.4 published on Monday, Jun 24, 2024 by Pulumi

kong.Target

Explore with Pulumi AI

kong logo
Kong v4.5.4 published on Monday, Jun 24, 2024 by Pulumi

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as kong from "@pulumi/kong";
    
    const target = new kong.Target("target", {
        target: "sample_target:80",
        weight: 10,
        upstreamId: upstream.id,
    });
    
    import pulumi
    import pulumi_kong as kong
    
    target = kong.Target("target",
        target="sample_target:80",
        weight=10,
        upstream_id=upstream["id"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-kong/sdk/v4/go/kong"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := kong.NewTarget(ctx, "target", &kong.TargetArgs{
    			Target:     pulumi.String("sample_target:80"),
    			Weight:     pulumi.Int(10),
    			UpstreamId: pulumi.Any(upstream.Id),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Kong = Pulumi.Kong;
    
    return await Deployment.RunAsync(() => 
    {
        var target = new Kong.Target("target", new()
        {
            TargetAddress = "sample_target:80",
            Weight = 10,
            UpstreamId = upstream.Id,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.kong.Target;
    import com.pulumi.kong.TargetArgs;
    import java.util.List;
    import java.util.ArrayList;
    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 target = new Target("target", TargetArgs.builder()
                .target("sample_target:80")
                .weight(10)
                .upstreamId(upstream.id())
                .build());
    
        }
    }
    
    resources:
      target:
        type: kong:Target
        properties:
          target: sample_target:80
          weight: 10
          upstreamId: ${upstream.id}
    

    Create Target Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new Target(name: string, args: TargetArgs, opts?: CustomResourceOptions);
    @overload
    def Target(resource_name: str,
               args: TargetArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Target(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               target: Optional[str] = None,
               upstream_id: Optional[str] = None,
               weight: Optional[int] = None,
               tags: Optional[Sequence[str]] = None)
    func NewTarget(ctx *Context, name string, args TargetArgs, opts ...ResourceOption) (*Target, error)
    public Target(string name, TargetArgs args, CustomResourceOptions? opts = null)
    public Target(String name, TargetArgs args)
    public Target(String name, TargetArgs args, CustomResourceOptions options)
    
    type: kong:Target
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args TargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args TargetArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args TargetArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args TargetArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args TargetArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var targetResource = new Kong.Target("targetResource", new()
    {
        TargetAddress = "string",
        UpstreamId = "string",
        Weight = 0,
        Tags = new[]
        {
            "string",
        },
    });
    
    example, err := kong.NewTarget(ctx, "targetResource", &kong.TargetArgs{
    	Target:     pulumi.String("string"),
    	UpstreamId: pulumi.String("string"),
    	Weight:     pulumi.Int(0),
    	Tags: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    })
    
    var targetResource = new Target("targetResource", TargetArgs.builder()
        .target("string")
        .upstreamId("string")
        .weight(0)
        .tags("string")
        .build());
    
    target_resource = kong.Target("targetResource",
        target="string",
        upstream_id="string",
        weight=0,
        tags=["string"])
    
    const targetResource = new kong.Target("targetResource", {
        target: "string",
        upstreamId: "string",
        weight: 0,
        tags: ["string"],
    });
    
    type: kong:Target
    properties:
        tags:
            - string
        target: string
        upstreamId: string
        weight: 0
    

    Target Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The Target resource accepts the following input properties:

    TargetAddress string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    UpstreamId string
    is the id of the upstream to apply this target to.
    Weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    Tags List<string>
    A list set of strings associated with the Plugin for grouping and filtering
    Target string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    UpstreamId string
    is the id of the upstream to apply this target to.
    Weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    Tags []string
    A list set of strings associated with the Plugin for grouping and filtering
    target String
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId String
    is the id of the upstream to apply this target to.
    weight Integer
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags List<String>
    A list set of strings associated with the Plugin for grouping and filtering
    target string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId string
    is the id of the upstream to apply this target to.
    weight number
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags string[]
    A list set of strings associated with the Plugin for grouping and filtering
    target str
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstream_id str
    is the id of the upstream to apply this target to.
    weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags Sequence[str]
    A list set of strings associated with the Plugin for grouping and filtering
    target String
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId String
    is the id of the upstream to apply this target to.
    weight Number
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags List<String>
    A list set of strings associated with the Plugin for grouping and filtering

    Outputs

    All input properties are implicitly available as output properties. Additionally, the Target resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing Target Resource

    Get an existing Target resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: TargetState, opts?: CustomResourceOptions): Target
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            tags: Optional[Sequence[str]] = None,
            target: Optional[str] = None,
            upstream_id: Optional[str] = None,
            weight: Optional[int] = None) -> Target
    func GetTarget(ctx *Context, name string, id IDInput, state *TargetState, opts ...ResourceOption) (*Target, error)
    public static Target Get(string name, Input<string> id, TargetState? state, CustomResourceOptions? opts = null)
    public static Target get(String name, Output<String> id, TargetState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    Tags List<string>
    A list set of strings associated with the Plugin for grouping and filtering
    TargetAddress string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    UpstreamId string
    is the id of the upstream to apply this target to.
    Weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    Tags []string
    A list set of strings associated with the Plugin for grouping and filtering
    Target string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    UpstreamId string
    is the id of the upstream to apply this target to.
    Weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags List<String>
    A list set of strings associated with the Plugin for grouping and filtering
    target String
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId String
    is the id of the upstream to apply this target to.
    weight Integer
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags string[]
    A list set of strings associated with the Plugin for grouping and filtering
    target string
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId string
    is the id of the upstream to apply this target to.
    weight number
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags Sequence[str]
    A list set of strings associated with the Plugin for grouping and filtering
    target str
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstream_id str
    is the id of the upstream to apply this target to.
    weight int
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).
    tags List<String>
    A list set of strings associated with the Plugin for grouping and filtering
    target String
    is the target address (IP or hostname) and port. If omitted the port defaults to 8000.
    upstreamId String
    is the id of the upstream to apply this target to.
    weight Number
    is the weight this target gets within the upstream load balancer (0-1000, defaults to 100).

    Import

    To import a target use a combination of the upstream id and the target id as follows:

    $ pulumi import kong:index/target:Target <target_identifier> <upstream_id>/<target_id>
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Kong pulumi/pulumi-kong
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the kong Terraform Provider.
    kong logo
    Kong v4.5.4 published on Monday, Jun 24, 2024 by Pulumi