Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Konnect Provider
  3. API Docs
  4. getGatewayPluginCanary
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

konnect.getGatewayPluginCanary

Explore with Pulumi AI

konnect logo
konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
kong/terraform-provider-konnect

    Using getGatewayPluginCanary

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getGatewayPluginCanary(args: GetGatewayPluginCanaryArgs, opts?: InvokeOptions): Promise<GetGatewayPluginCanaryResult>
function getGatewayPluginCanaryOutput(args: GetGatewayPluginCanaryOutputArgs, opts?: InvokeOptions): Output<GetGatewayPluginCanaryResult>
    def get_gateway_plugin_canary(control_plane_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetGatewayPluginCanaryResult
def get_gateway_plugin_canary_output(control_plane_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetGatewayPluginCanaryResult]
    func LookupGatewayPluginCanary(ctx *Context, args *LookupGatewayPluginCanaryArgs, opts ...InvokeOption) (*LookupGatewayPluginCanaryResult, error)
func LookupGatewayPluginCanaryOutput(ctx *Context, args *LookupGatewayPluginCanaryOutputArgs, opts ...InvokeOption) LookupGatewayPluginCanaryResultOutput

    > Note: This function is named LookupGatewayPluginCanary in the Go SDK.

    public static class GetGatewayPluginCanary 
{
    public static Task<GetGatewayPluginCanaryResult> InvokeAsync(GetGatewayPluginCanaryArgs args, InvokeOptions? opts = null)
    public static Output<GetGatewayPluginCanaryResult> Invoke(GetGatewayPluginCanaryInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetGatewayPluginCanaryResult> getGatewayPluginCanary(GetGatewayPluginCanaryArgs args, InvokeOptions options)
public static Output<GetGatewayPluginCanaryResult> getGatewayPluginCanary(GetGatewayPluginCanaryArgs args, InvokeOptions options)

    fn::invoke:
  function: konnect:index/getGatewayPluginCanary:getGatewayPluginCanary
  arguments:
    # arguments dictionary

    The following arguments are supported:

    getGatewayPluginCanary Result

    The following output properties are available:

    Supporting Types

    GetGatewayPluginCanaryConfig

    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    • consumer: The hash will be based on the consumer.
    • ip: The hash will be based on the client IP address.
    • none: No hash will be applied.
    • allow: Allows the specified groups to access the canary release.
    • deny: Denies the specified groups from accessing the canary release.
    • header: The hash will be based on the specified header value.
    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.

    GetGatewayPluginCanaryOrdering

    GetGatewayPluginCanaryOrderingAfter

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginCanaryOrderingBefore

    Accesses List<string>
    Accesses []string
    accesses List<String>
    accesses string[]
    accesses Sequence[str]
    accesses List<String>

    GetGatewayPluginCanaryRoute

    Id string
    Id string
    id String
    id string
    id str
    id String

    GetGatewayPluginCanaryService

    Id string
    Id string
    id String
    id string
    id str
    id String

    Package Details

    Repository
    konnect kong/terraform-provider-konnect
    License
    Notes
    This Pulumi package is based on the konnect Terraform Provider.
    konnect logo
    konnect 2.4.1 published on Thursday, Mar 13, 2025 by kong
    kong/terraform-provider-konnect