konnect 2.4.1, Mar 13 25

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

konnect.GatewayPluginCanary

Explore with Pulumi AI

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

Example Usage

Coming soon!

Coming soon!

Coming soon!

Coming soon!

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.konnect.GatewayPluginCanary;
import com.pulumi.konnect.GatewayPluginCanaryArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryConfigArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryOrderingArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryOrderingAfterArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryOrderingBeforeArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryRouteArgs;
import com.pulumi.konnect.inputs.GatewayPluginCanaryServiceArgs;
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 myGatewayplugincanary = new GatewayPluginCanary("myGatewayplugincanary", GatewayPluginCanaryArgs.builder()
            .config(GatewayPluginCanaryConfigArgs.builder()
                .canary_by_header_name("...my_canary_by_header_name...")
                .duration(0.88)
                .groups("...")
                .hash("ip")
                .hash_header("...my_hash_header...")
                .percentage(35.35)
                .start(7.39)
                .steps(5.98)
                .upstream_fallback(false)
                .upstream_host("...my_upstream_host...")
                .upstream_port(15742)
                .upstream_uri("...my_upstream_uri...")
                .build())
            .controlPlaneId("9524ec7d-36d9-465d-a8c5-83a3c9390458")
            .enabled(false)
            .gatewayPluginCanaryId("...my_id...")
            .instanceName("...my_instance_name...")
            .ordering(GatewayPluginCanaryOrderingArgs.builder()
                .after(GatewayPluginCanaryOrderingAfterArgs.builder()
                    .access("...")
                    .build())
                .before(GatewayPluginCanaryOrderingBeforeArgs.builder()
                    .access("...")
                    .build())
                .build())
            .protocols("grpc")
            .route(GatewayPluginCanaryRouteArgs.builder()
                .id("...my_id...")
                .build())
            .service(GatewayPluginCanaryServiceArgs.builder()
                .id("...my_id...")
                .build())
            .tags("...")
            .build());

    }
}

resources:
  myGatewayplugincanary:
    type: konnect:GatewayPluginCanary
    properties:
      config:
        canary_by_header_name: '...my_canary_by_header_name...'
        duration: 0.88
        groups:
          - '...'
        hash: ip
        hash_header: '...my_hash_header...'
        percentage: 35.35
        start: 7.39
        steps: 5.98
        upstream_fallback: false
        upstream_host: '...my_upstream_host...'
        upstream_port: 15742
        upstream_uri: '...my_upstream_uri...'
      controlPlaneId: 9524ec7d-36d9-465d-a8c5-83a3c9390458
      enabled: false
      gatewayPluginCanaryId: '...my_id...'
      instanceName: '...my_instance_name...'
      ordering:
        after:
          access:
            - '...'
        before:
          access:
            - '...'
      protocols:
        - grpc
      route:
        id: '...my_id...'
      service:
        id: '...my_id...'
      tags:
        - '...'

Create GatewayPluginCanary Resource

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

Constructor syntax

new GatewayPluginCanary(name: string, args: GatewayPluginCanaryArgs, opts?: CustomResourceOptions);

@overload
def GatewayPluginCanary(resource_name: str,
                        args: GatewayPluginCanaryArgs,
                        opts: Optional[ResourceOptions] = None)

@overload
def GatewayPluginCanary(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        config: Optional[GatewayPluginCanaryConfigArgs] = None,
                        control_plane_id: Optional[str] = None,
                        enabled: Optional[bool] = None,
                        gateway_plugin_canary_id: Optional[str] = None,
                        instance_name: Optional[str] = None,
                        ordering: Optional[GatewayPluginCanaryOrderingArgs] = None,
                        protocols: Optional[Sequence[str]] = None,
                        route: Optional[GatewayPluginCanaryRouteArgs] = None,
                        service: Optional[GatewayPluginCanaryServiceArgs] = None,
                        tags: Optional[Sequence[str]] = None)

func NewGatewayPluginCanary(ctx *Context, name string, args GatewayPluginCanaryArgs, opts ...ResourceOption) (*GatewayPluginCanary, error)

public GatewayPluginCanary(string name, GatewayPluginCanaryArgs args, CustomResourceOptions? opts = null)

public GatewayPluginCanary(String name, GatewayPluginCanaryArgs args)
public GatewayPluginCanary(String name, GatewayPluginCanaryArgs args, CustomResourceOptions options)

type: konnect:GatewayPluginCanary
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 GatewayPluginCanaryArgs: 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 GatewayPluginCanaryArgs: 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 GatewayPluginCanaryArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args GatewayPluginCanaryArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args GatewayPluginCanaryArgs: 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 gatewayPluginCanaryResource = new Konnect.GatewayPluginCanary("gatewayPluginCanaryResource", new()
{
    Config = new Konnect.Inputs.GatewayPluginCanaryConfigArgs
    {
        CanaryByHeaderName = "string",
        Duration = 0,
        Groups = new[]
        {
            "string",
        },
        Hash = "string",
        HashHeader = "string",
        Percentage = 0,
        Start = 0,
        Steps = 0,
        UpstreamFallback = false,
        UpstreamHost = "string",
        UpstreamPort = 0,
        UpstreamUri = "string",
    },
    ControlPlaneId = "string",
    Enabled = false,
    GatewayPluginCanaryId = "string",
    InstanceName = "string",
    Ordering = new Konnect.Inputs.GatewayPluginCanaryOrderingArgs
    {
        After = new Konnect.Inputs.GatewayPluginCanaryOrderingAfterArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
        Before = new Konnect.Inputs.GatewayPluginCanaryOrderingBeforeArgs
        {
            Accesses = new[]
            {
                "string",
            },
        },
    },
    Protocols = new[]
    {
        "string",
    },
    Route = new Konnect.Inputs.GatewayPluginCanaryRouteArgs
    {
        Id = "string",
    },
    Service = new Konnect.Inputs.GatewayPluginCanaryServiceArgs
    {
        Id = "string",
    },
    Tags = new[]
    {
        "string",
    },
});

example, err := konnect.NewGatewayPluginCanary(ctx, "gatewayPluginCanaryResource", &konnect.GatewayPluginCanaryArgs{
Config: &.GatewayPluginCanaryConfigArgs{
CanaryByHeaderName: pulumi.String("string"),
Duration: pulumi.Float64(0),
Groups: pulumi.StringArray{
pulumi.String("string"),
},
Hash: pulumi.String("string"),
HashHeader: pulumi.String("string"),
Percentage: pulumi.Float64(0),
Start: pulumi.Float64(0),
Steps: pulumi.Float64(0),
UpstreamFallback: pulumi.Bool(false),
UpstreamHost: pulumi.String("string"),
UpstreamPort: pulumi.Float64(0),
UpstreamUri: pulumi.String("string"),
},
ControlPlaneId: pulumi.String("string"),
Enabled: pulumi.Bool(false),
GatewayPluginCanaryId: pulumi.String("string"),
InstanceName: pulumi.String("string"),
Ordering: &.GatewayPluginCanaryOrderingArgs{
After: &.GatewayPluginCanaryOrderingAfterArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
Before: &.GatewayPluginCanaryOrderingBeforeArgs{
Accesses: pulumi.StringArray{
pulumi.String("string"),
},
},
},
Protocols: pulumi.StringArray{
pulumi.String("string"),
},
Route: &.GatewayPluginCanaryRouteArgs{
Id: pulumi.String("string"),
},
Service: &.GatewayPluginCanaryServiceArgs{
Id: pulumi.String("string"),
},
Tags: pulumi.StringArray{
pulumi.String("string"),
},
})

var gatewayPluginCanaryResource = new GatewayPluginCanary("gatewayPluginCanaryResource", GatewayPluginCanaryArgs.builder()
    .config(GatewayPluginCanaryConfigArgs.builder()
        .canaryByHeaderName("string")
        .duration(0)
        .groups("string")
        .hash("string")
        .hashHeader("string")
        .percentage(0)
        .start(0)
        .steps(0)
        .upstreamFallback(false)
        .upstreamHost("string")
        .upstreamPort(0)
        .upstreamUri("string")
        .build())
    .controlPlaneId("string")
    .enabled(false)
    .gatewayPluginCanaryId("string")
    .instanceName("string")
    .ordering(GatewayPluginCanaryOrderingArgs.builder()
        .after(GatewayPluginCanaryOrderingAfterArgs.builder()
            .accesses("string")
            .build())
        .before(GatewayPluginCanaryOrderingBeforeArgs.builder()
            .accesses("string")
            .build())
        .build())
    .protocols("string")
    .route(GatewayPluginCanaryRouteArgs.builder()
        .id("string")
        .build())
    .service(GatewayPluginCanaryServiceArgs.builder()
        .id("string")
        .build())
    .tags("string")
    .build());

gateway_plugin_canary_resource = konnect.GatewayPluginCanary("gatewayPluginCanaryResource",
    config={
        "canary_by_header_name": "string",
        "duration": 0,
        "groups": ["string"],
        "hash": "string",
        "hash_header": "string",
        "percentage": 0,
        "start": 0,
        "steps": 0,
        "upstream_fallback": False,
        "upstream_host": "string",
        "upstream_port": 0,
        "upstream_uri": "string",
    },
    control_plane_id="string",
    enabled=False,
    gateway_plugin_canary_id="string",
    instance_name="string",
    ordering={
        "after": {
            "accesses": ["string"],
        },
        "before": {
            "accesses": ["string"],
        },
    },
    protocols=["string"],
    route={
        "id": "string",
    },
    service={
        "id": "string",
    },
    tags=["string"])

const gatewayPluginCanaryResource = new konnect.GatewayPluginCanary("gatewayPluginCanaryResource", {
    config: {
        canaryByHeaderName: "string",
        duration: 0,
        groups: ["string"],
        hash: "string",
        hashHeader: "string",
        percentage: 0,
        start: 0,
        steps: 0,
        upstreamFallback: false,
        upstreamHost: "string",
        upstreamPort: 0,
        upstreamUri: "string",
    },
    controlPlaneId: "string",
    enabled: false,
    gatewayPluginCanaryId: "string",
    instanceName: "string",
    ordering: {
        after: {
            accesses: ["string"],
        },
        before: {
            accesses: ["string"],
        },
    },
    protocols: ["string"],
    route: {
        id: "string",
    },
    service: {
        id: "string",
    },
    tags: ["string"],
});

type: konnect:GatewayPluginCanary
properties:
    config:
        canaryByHeaderName: string
        duration: 0
        groups:
            - string
        hash: string
        hashHeader: string
        percentage: 0
        start: 0
        steps: 0
        upstreamFallback: false
        upstreamHost: string
        upstreamPort: 0
        upstreamUri: string
    controlPlaneId: string
    enabled: false
    gatewayPluginCanaryId: string
    instanceName: string
    ordering:
        after:
            accesses:
                - string
        before:
            accesses:
                - string
    protocols:
        - string
    route:
        id: string
    service:
        id: string
    tags:
        - string

GatewayPluginCanary Resource Properties

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

Inputs

In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

The GatewayPluginCanary resource accepts the following input properties:

Config GatewayPluginCanaryConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginCanaryId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCanaryOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.

Config GatewayPluginCanaryConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
Enabled bool: Whether the plugin is applied.
GatewayPluginCanaryId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCanaryOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginCanaryRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginCanaryServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginCanaryConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCanaryId String: The ID of this resource.
instanceName String
ordering GatewayPluginCanaryOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginCanaryConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled boolean: Whether the plugin is applied.
gatewayPluginCanaryId string: The ID of this resource.
instanceName string
ordering GatewayPluginCanaryOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.

config GatewayPluginCanaryConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled bool: Whether the plugin is applied.
gateway_plugin_canary_id str: The ID of this resource.
instance_name str
ordering GatewayPluginCanaryOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.

config Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCanaryId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.

Outputs

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

CreatedAt double: Unix epoch when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt double: Unix epoch when the resource was last updated.

CreatedAt float64: Unix epoch when the resource was created.
Id string: The provider-assigned unique ID for this managed resource.
UpdatedAt float64: Unix epoch when the resource was last updated.

createdAt Double: Unix epoch when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt Double: Unix epoch when the resource was last updated.

createdAt number: Unix epoch when the resource was created.
id string: The provider-assigned unique ID for this managed resource.
updatedAt number: Unix epoch when the resource was last updated.

created_at float: Unix epoch when the resource was created.
id str: The provider-assigned unique ID for this managed resource.
updated_at float: Unix epoch when the resource was last updated.

createdAt Number: Unix epoch when the resource was created.
id String: The provider-assigned unique ID for this managed resource.
updatedAt Number: Unix epoch when the resource was last updated.

Look up Existing GatewayPluginCanary Resource

Get an existing GatewayPluginCanary 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?: GatewayPluginCanaryState, opts?: CustomResourceOptions): GatewayPluginCanary

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config: Optional[GatewayPluginCanaryConfigArgs] = None,
        control_plane_id: Optional[str] = None,
        created_at: Optional[float] = None,
        enabled: Optional[bool] = None,
        gateway_plugin_canary_id: Optional[str] = None,
        instance_name: Optional[str] = None,
        ordering: Optional[GatewayPluginCanaryOrderingArgs] = None,
        protocols: Optional[Sequence[str]] = None,
        route: Optional[GatewayPluginCanaryRouteArgs] = None,
        service: Optional[GatewayPluginCanaryServiceArgs] = None,
        tags: Optional[Sequence[str]] = None,
        updated_at: Optional[float] = None) -> GatewayPluginCanary

func GetGatewayPluginCanary(ctx *Context, name string, id IDInput, state *GatewayPluginCanaryState, opts ...ResourceOption) (*GatewayPluginCanary, error)

public static GatewayPluginCanary Get(string name, Input<string> id, GatewayPluginCanaryState? state, CustomResourceOptions? opts = null)

public static GatewayPluginCanary get(String name, Output<String> id, GatewayPluginCanaryState state, CustomResourceOptions options)

resources:  _:    type: konnect:GatewayPluginCanary    get:      id: ${id}

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:

Config GatewayPluginCanaryConfig
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt double: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginCanaryId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCanaryOrdering
Protocols List<string>: A set of strings representing HTTP protocols.
Route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags List<string>: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt double: Unix epoch when the resource was last updated.

Config GatewayPluginCanaryConfigArgs
ControlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
CreatedAt float64: Unix epoch when the resource was created.
Enabled bool: Whether the plugin is applied.
GatewayPluginCanaryId string: The ID of this resource.
InstanceName string
Ordering GatewayPluginCanaryOrderingArgs
Protocols []string: A set of strings representing HTTP protocols.
Route GatewayPluginCanaryRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
Service GatewayPluginCanaryServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
Tags []string: An optional set of strings associated with the Plugin for grouping and filtering.
UpdatedAt float64: Unix epoch when the resource was last updated.

config GatewayPluginCanaryConfig
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Double: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCanaryId String: The ID of this resource.
instanceName String
ordering GatewayPluginCanaryOrdering
protocols List<String>: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Double: Unix epoch when the resource was last updated.

config GatewayPluginCanaryConfig
controlPlaneId string: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt number: Unix epoch when the resource was created.
enabled boolean: Whether the plugin is applied.
gatewayPluginCanaryId string: The ID of this resource.
instanceName string
ordering GatewayPluginCanaryOrdering
protocols string[]: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRoute: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryService: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags string[]: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt number: Unix epoch when the resource was last updated.

config GatewayPluginCanaryConfigArgs
control_plane_id str: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
created_at float: Unix epoch when the resource was created.
enabled bool: Whether the plugin is applied.
gateway_plugin_canary_id str: The ID of this resource.
instance_name str
ordering GatewayPluginCanaryOrderingArgs
protocols Sequence[str]: A set of strings representing HTTP protocols.
route GatewayPluginCanaryRouteArgs: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service GatewayPluginCanaryServiceArgs: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags Sequence[str]: An optional set of strings associated with the Plugin for grouping and filtering.
updated_at float: Unix epoch when the resource was last updated.

config Property Map
controlPlaneId String: The UUID of your control plane. This variable is available in the Konnect manager. Requires replacement if changed.
createdAt Number: Unix epoch when the resource was created.
enabled Boolean: Whether the plugin is applied.
gatewayPluginCanaryId String: The ID of this resource.
instanceName String
ordering Property Map
protocols List<String>: A set of strings representing HTTP protocols.
route Property Map: If set, the plugin will only activate when receiving requests via the specified route. Leave unset for the plugin to activate regardless of the route being used.
service Property Map: If set, the plugin will only activate when receiving requests via one of the routes belonging to the specified Service. Leave unset for the plugin to activate regardless of the Service being matched.
tags List<String>: An optional set of strings associated with the Plugin for grouping and filtering.
updatedAt Number: Unix epoch when the resource was last updated.

Supporting Types

GatewayPluginCanaryConfig, GatewayPluginCanaryConfigArgs

CanaryByHeaderName string: A string representing an HTTP header name.
Duration double: The duration of the canary release in seconds.
Groups List<string>: The groups allowed to access the canary release.
Hash string: Hash algorithm to be used for canary release.
HashHeader string: A string representing an HTTP header name.
Percentage double: The percentage of traffic to be routed to the canary release.
Start double: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
Steps double: The number of steps for the canary release.
UpstreamFallback bool: Specifies whether to fallback to the upstream server if the canary release fails.
UpstreamHost string: A string representing a host name, such as example.com.
UpstreamPort double: An integer representing a port number between 0 and 65535, inclusive.
UpstreamUri string: The URI of the upstream server to be used for the canary release.

CanaryByHeaderName string: A string representing an HTTP header name.
Duration float64: The duration of the canary release in seconds.
Groups []string: The groups allowed to access the canary release.
Hash string: Hash algorithm to be used for canary release.
HashHeader string: A string representing an HTTP header name.
Percentage float64: The percentage of traffic to be routed to the canary release.
Start float64: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
Steps float64: The number of steps for the canary release.
UpstreamFallback bool: Specifies whether to fallback to the upstream server if the canary release fails.
UpstreamHost string: A string representing a host name, such as example.com.
UpstreamPort float64: An integer representing a port number between 0 and 65535, inclusive.
UpstreamUri string: The URI of the upstream server to be used for the canary release.

canaryByHeaderName String: A string representing an HTTP header name.
duration Double: The duration of the canary release in seconds.
groups List<String>: The groups allowed to access the canary release.
hash String: Hash algorithm to be used for canary release.
hashHeader String: A string representing an HTTP header name.
percentage Double: The percentage of traffic to be routed to the canary release.
start Double: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
steps Double: The number of steps for the canary release.
upstreamFallback Boolean: Specifies whether to fallback to the upstream server if the canary release fails.
upstreamHost String: A string representing a host name, such as example.com.
upstreamPort Double: An integer representing a port number between 0 and 65535, inclusive.
upstreamUri String: The URI of the upstream server to be used for the canary release.

canaryByHeaderName string: A string representing an HTTP header name.
duration number: The duration of the canary release in seconds.
groups string[]: The groups allowed to access the canary release.
hash string: Hash algorithm to be used for canary release.
hashHeader string: A string representing an HTTP header name.
percentage number: The percentage of traffic to be routed to the canary release.
start number: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
steps number: The number of steps for the canary release.
upstreamFallback boolean: Specifies whether to fallback to the upstream server if the canary release fails.
upstreamHost string: A string representing a host name, such as example.com.
upstreamPort number: An integer representing a port number between 0 and 65535, inclusive.
upstreamUri string: The URI of the upstream server to be used for the canary release.

canary_by_header_name str: A string representing an HTTP header name.
duration float: The duration of the canary release in seconds.
groups Sequence[str]: The groups allowed to access the canary release.
hash str: Hash algorithm to be used for canary release.
hash_header str: A string representing an HTTP header name.
percentage float: The percentage of traffic to be routed to the canary release.
start float: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
steps float: The number of steps for the canary release.
upstream_fallback bool: Specifies whether to fallback to the upstream server if the canary release fails.
upstream_host str: A string representing a host name, such as example.com.
upstream_port float: An integer representing a port number between 0 and 65535, inclusive.
upstream_uri str: The URI of the upstream server to be used for the canary release.

canaryByHeaderName String: A string representing an HTTP header name.
duration Number: The duration of the canary release in seconds.
groups List<String>: The groups allowed to access the canary release.
hash String: Hash algorithm to be used for canary release.
hashHeader String: A string representing an HTTP header name.
percentage Number: The percentage of traffic to be routed to the canary release.
start Number: Future time in seconds since epoch, when the canary release will start. Ignored when percentage is set, or when using allow or deny in hash.
steps Number: The number of steps for the canary release.
upstreamFallback Boolean: Specifies whether to fallback to the upstream server if the canary release fails.
upstreamHost String: A string representing a host name, such as example.com.
upstreamPort Number: An integer representing a port number between 0 and 65535, inclusive.
upstreamUri String: The URI of the upstream server to be used for the canary release.

GatewayPluginCanaryOrdering, GatewayPluginCanaryOrderingArgs

After GatewayPluginCanaryOrderingAfter
Before GatewayPluginCanaryOrderingBefore

After GatewayPluginCanaryOrderingAfter
Before GatewayPluginCanaryOrderingBefore

after GatewayPluginCanaryOrderingAfter
before GatewayPluginCanaryOrderingBefore

after GatewayPluginCanaryOrderingAfter
before GatewayPluginCanaryOrderingBefore

after GatewayPluginCanaryOrderingAfter
before GatewayPluginCanaryOrderingBefore

after Property Map
before Property Map

GatewayPluginCanaryOrderingAfter, GatewayPluginCanaryOrderingAfterArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginCanaryOrderingBefore, GatewayPluginCanaryOrderingBeforeArgs

Accesses List<string>

Accesses []string

accesses List<String>

accesses string[]

accesses Sequence[str]

accesses List<String>

GatewayPluginCanaryRoute, GatewayPluginCanaryRouteArgs

Id string

Id string

id String

id string

id str

id String

GatewayPluginCanaryService, GatewayPluginCanaryServiceArgs

Id string

Id string

id String

id string

id str

id String

Import

$ pulumi import konnect:index/gatewayPluginCanary:GatewayPluginCanary my_konnect_gateway_plugin_canary "{ \"control_plane_id\": \"9524ec7d-36d9-465d-a8c5-83a3c9390458\", \"plugin_id\": \"3473c251-5b6c-4f45-b1ff-7ede735a366d\"}"

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

Package Details

Repository: konnect kong/terraform-provider-konnect
License
Notes: This Pulumi package is based on the konnect Terraform Provider.

konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong

kong/terraform-provider-konnect

konnect.GatewayPluginCanary

On this page

On this page

Example Usage

Create GatewayPluginCanary Resource

Constructor syntax

Parameters

Constructor example

GatewayPluginCanary Resource Properties

Inputs

Outputs

Look up Existing GatewayPluginCanary Resource

Supporting Types

GatewayPluginCanaryConfig, GatewayPluginCanaryConfigArgs

GatewayPluginCanaryOrdering, GatewayPluginCanaryOrderingArgs

GatewayPluginCanaryOrderingAfter, GatewayPluginCanaryOrderingAfterArgs

GatewayPluginCanaryOrderingBefore, GatewayPluginCanaryOrderingBeforeArgs

GatewayPluginCanaryRoute, GatewayPluginCanaryRouteArgs

GatewayPluginCanaryService, GatewayPluginCanaryServiceArgs

Import

Package Details

On this page

On this page