Class PreparedQueryArgs

Inheritance
System.Object
InputArgs
ResourceArgs
PreparedQueryArgs
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.ToString()
Namespace: Pulumi.Consul
Assembly: Pulumi.Consul.dll
Syntax
public sealed class PreparedQueryArgs : ResourceArgs

Constructors

View Source

PreparedQueryArgs()

Declaration
public PreparedQueryArgs()

Properties

View Source

Connect

When true the prepared query will return connect proxy services for a queried service. Conditions such as tags in the prepared query will be matched against the proxy service. Defaults to false.

Declaration
public Input<bool> Connect { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Datacenter

The datacenter to use. This overrides the agent's default datacenter and the datacenter in the provider setup.

Declaration
public Input<string> Datacenter { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Dns

Settings for controlling the DNS response details.

Declaration
public Input<PreparedQueryDnsArgs> Dns { get; set; }
Property Value
Type Description
Input<PreparedQueryDnsArgs>
View Source

Failover

Options for controlling behavior when no healthy nodes are available in the local DC.

Declaration
public Input<PreparedQueryFailoverArgs> Failover { get; set; }
Property Value
Type Description
Input<PreparedQueryFailoverArgs>
View Source

IgnoreCheckIds

Specifies a list of check IDs that should be ignored when filtering unhealthy instances. This is mostly useful in an emergency or as a temporary measure when a health check is found to be unreliable. Being able to ignore it in centrally-defined queries can be simpler than de-registering the check as an interim solution until the check can be fixed.

Declaration
public InputList<string> IgnoreCheckIds { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

Name

The name of the prepared query. Used to identify the prepared query during requests. Can be specified as an empty string to configure the query as a catch-all.

Declaration
public Input<string> Name { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Near

Allows specifying the name of a node to sort results near using Consul's distance sorting and network coordinates. The magic _agent value can be used to always sort nearest the node servicing the request.

Declaration
public Input<string> Near { get; set; }
Property Value
Type Description
Input<System.String>
View Source

NodeMeta

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to nodes with the given metadata values present.

Declaration
public InputMap<string> NodeMeta { get; set; }
Property Value
Type Description
InputMap<System.String>
View Source

OnlyPassing

When true, the prepared query will only return nodes with passing health checks in the result.

Declaration
public Input<bool> OnlyPassing { get; set; }
Property Value
Type Description
Input<System.Boolean>
View Source

Service

The name of the service to query.

Declaration
public Input<string> Service { get; set; }
Property Value
Type Description
Input<System.String>
View Source

ServiceMeta

Specifies a list of user-defined key/value pairs that will be used for filtering the query results to services with the given metadata values present.

Declaration
public InputMap<string> ServiceMeta { get; set; }
Property Value
Type Description
InputMap<System.String>
View Source

Session

The name of the Consul session to tie this query's lifetime to. This is an advanced parameter that should not be used without a complete understanding of Consul sessions and the implications of their use (it is recommended to leave this blank in nearly all cases). If this parameter is omitted the query will not expire.

Declaration
public Input<string> Session { get; set; }
Property Value
Type Description
Input<System.String>
View Source

StoredToken

The ACL token to store with the prepared query. This token will be used by default whenever the query is executed.

Declaration
public Input<string> StoredToken { get; set; }
Property Value
Type Description
Input<System.String>
View Source

Tags

The list of required and/or disallowed tags. If a tag is in this list it must be present. If the tag is preceded with a "!" then it is disallowed.

Declaration
public InputList<string> Tags { get; set; }
Property Value
Type Description
InputList<System.String>
View Source

Template

Query templating options. This is used to make a single prepared query respond to many different requests.

Declaration
public Input<PreparedQueryTemplateArgs> Template { get; set; }
Property Value
Type Description
Input<PreparedQueryTemplateArgs>
View Source

Token

The ACL token to use when saving the prepared query. This overrides the token that the agent provides by default.

Declaration
public Input<string> Token { get; set; }
Property Value
Type Description
Input<System.String>