1. Docs
  2. Reference
  3. API
  4. Kong
  5. Route

Route

Create a Route Resource

new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);
def Route(resource_name, opts=None, destinations=None, hosts=None, methods=None, name=None, paths=None, preserve_host=None, protocols=None, regex_priority=None, service_id=None, snis=None, sources=None, strip_path=None, __props__=None);
func NewRoute(ctx *Context, name string, args RouteArgs, opts ...ResourceOption) (*Route, error)
public Route(string name, RouteArgs args, CustomResourceOptions? opts = null)
name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
opts ResourceOptions
A bag of options that control this resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args RouteArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.

Route Resource Properties

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

Inputs

The Route resource accepts the following input properties:

Protocols List<string>
ServiceId string
Destinations List<RouteDestinationArgs>
Hosts List<string>
Methods List<string>
Name string
Paths List<string>
PreserveHost bool
RegexPriority int
Snis List<string>
Sources List<RouteSourceArgs>
StripPath bool
Protocols []string
ServiceId string
Destinations []RouteDestination
Hosts []string
Methods []string
Name string
Paths []string
PreserveHost bool
RegexPriority int
Snis []string
Sources []RouteSource
StripPath bool
protocols string[]
serviceId string
destinations RouteDestination[]
hosts string[]
methods string[]
name string
paths string[]
preserveHost boolean
regexPriority number
snis string[]
sources RouteSource[]
stripPath boolean
protocols List[str]
service_id str
destinations List[RouteDestination]
hosts List[str]
methods List[str]
name str
paths List[str]
preserve_host bool
regex_priority float
snis List[str]
sources List[RouteSource]
strip_path bool

Outputs

All input properties are implicitly available as output properties. Additionally, the Route 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 str
The provider-assigned unique ID for this managed resource.

Look up an Existing Route Resource

Get an existing Route 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?: RouteState, opts?: CustomResourceOptions): Route
static get(resource_name, id, opts=None, destinations=None, hosts=None, methods=None, name=None, paths=None, preserve_host=None, protocols=None, regex_priority=None, service_id=None, snis=None, sources=None, strip_path=None, __props__=None);
func GetRoute(ctx *Context, name string, id IDInput, state *RouteState, opts ...ResourceOption) (*Route, error)
public static Route Get(string name, Input<string> id, RouteState? state, CustomResourceOptions? opts = null)
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.

The following state arguments are supported:

Destinations List<RouteDestinationArgs>
Hosts List<string>
Methods List<string>
Name string
Paths List<string>
PreserveHost bool
Protocols List<string>
RegexPriority int
ServiceId string
Snis List<string>
Sources List<RouteSourceArgs>
StripPath bool
Destinations []RouteDestination
Hosts []string
Methods []string
Name string
Paths []string
PreserveHost bool
Protocols []string
RegexPriority int
ServiceId string
Snis []string
Sources []RouteSource
StripPath bool
destinations RouteDestination[]
hosts string[]
methods string[]
name string
paths string[]
preserveHost boolean
protocols string[]
regexPriority number
serviceId string
snis string[]
sources RouteSource[]
stripPath boolean
destinations List[RouteDestination]
hosts List[str]
methods List[str]
name str
paths List[str]
preserve_host bool
protocols List[str]
regex_priority float
service_id str
snis List[str]
sources List[RouteSource]
strip_path bool

Supporting Types

RouteDestination

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Ip string
Port int
Ip string
Port int
ip string
port number
ip str
port float

RouteSource

See the input and output API doc for this type.

See the input and output API doc for this type.

See the input and output API doc for this type.

Ip string
Port int
Ip string
Port int
ip string
port number
ip str
port float

Package Details

Repository
https://github.com/pulumi/pulumi-kong
License
Apache-2.0
Notes
This Pulumi package is based on the kong Terraform Provider.