Ready to level-up your engineering skills? Join a Pulumi Workshop. Register Now

Route

Create a Route Resource

new Route(name: string, args: RouteArgs, opts?: CustomResourceOptions);
def Route(resource_name: str, opts: Optional[ResourceOptions] = None, destinations: Optional[Sequence[RouteDestinationArgs]] = None, hosts: Optional[Sequence[str]] = None, methods: Optional[Sequence[str]] = None, name: Optional[str] = None, paths: Optional[Sequence[str]] = None, preserve_host: Optional[bool] = None, protocols: Optional[Sequence[str]] = None, regex_priority: Optional[int] = None, service_id: Optional[str] = None, snis: Optional[Sequence[str]] = None, sources: Optional[Sequence[RouteSourceArgs]] = None, strip_path: Optional[bool] = 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:

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
@staticmethod
def get(resource_name: str, id: str, opts: Optional[ResourceOptions] = None, destinations: Optional[Sequence[RouteDestinationArgs]] = None, hosts: Optional[Sequence[str]] = None, methods: Optional[Sequence[str]] = None, name: Optional[str] = None, paths: Optional[Sequence[str]] = None, preserve_host: Optional[bool] = None, protocols: Optional[Sequence[str]] = None, regex_priority: Optional[int] = None, service_id: Optional[str] = None, snis: Optional[Sequence[str]] = None, sources: Optional[Sequence[RouteSourceArgs]] = None, strip_path: Optional[bool] = None) -> Route
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:

Supporting Types

RouteDestination

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

RouteSource

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

Package Details

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