1. Packages
  2. HashiCorp Consul
  3. API Docs
  4. getCatalogNodes
Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi

consul.getCatalogNodes

Explore with Pulumi AI

consul logo
Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi

    Using getCatalogNodes

    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 getCatalogNodes(args: GetCatalogNodesArgs, opts?: InvokeOptions): Promise<GetCatalogNodesResult>
    function getCatalogNodesOutput(args: GetCatalogNodesOutputArgs, opts?: InvokeOptions): Output<GetCatalogNodesResult>
    def get_catalog_nodes(query_options: Optional[Sequence[GetCatalogNodesQueryOption]] = None,
                          opts: Optional[InvokeOptions] = None) -> GetCatalogNodesResult
    def get_catalog_nodes_output(query_options: Optional[pulumi.Input[Sequence[pulumi.Input[GetCatalogNodesQueryOptionArgs]]]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetCatalogNodesResult]
    func GetCatalogNodes(ctx *Context, args *GetCatalogNodesArgs, opts ...InvokeOption) (*GetCatalogNodesResult, error)
    func GetCatalogNodesOutput(ctx *Context, args *GetCatalogNodesOutputArgs, opts ...InvokeOption) GetCatalogNodesResultOutput

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

    public static class GetCatalogNodes 
    {
        public static Task<GetCatalogNodesResult> InvokeAsync(GetCatalogNodesArgs args, InvokeOptions? opts = null)
        public static Output<GetCatalogNodesResult> Invoke(GetCatalogNodesInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetCatalogNodesResult> getCatalogNodes(GetCatalogNodesArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: consul:index/getCatalogNodes:getCatalogNodes
      arguments:
        # arguments dictionary

    The following arguments are supported:

    getCatalogNodes Result

    The following output properties are available:

    Datacenter string
    Id string

    The provider-assigned unique ID for this managed resource.

    NodeIds List<string>
    NodeNames List<string>
    Nodes List<GetCatalogNodesNode>
    QueryOptions List<GetCatalogNodesQueryOption>
    Datacenter string
    Id string

    The provider-assigned unique ID for this managed resource.

    NodeIds []string
    NodeNames []string
    Nodes []GetCatalogNodesNode
    QueryOptions []GetCatalogNodesQueryOption
    datacenter String
    id String

    The provider-assigned unique ID for this managed resource.

    nodeIds List<String>
    nodeNames List<String>
    nodes List<GetCatalogNodesNode>
    queryOptions List<GetCatalogNodesQueryOption>
    datacenter string
    id string

    The provider-assigned unique ID for this managed resource.

    nodeIds string[]
    nodeNames string[]
    nodes GetCatalogNodesNode[]
    queryOptions GetCatalogNodesQueryOption[]
    datacenter str
    id str

    The provider-assigned unique ID for this managed resource.

    node_ids Sequence[str]
    node_names Sequence[str]
    nodes Sequence[GetCatalogNodesNode]
    query_options Sequence[GetCatalogNodesQueryOption]
    datacenter String
    id String

    The provider-assigned unique ID for this managed resource.

    nodeIds List<String>
    nodeNames List<String>
    nodes List<Property Map>
    queryOptions List<Property Map>

    Supporting Types

    GetCatalogNodesNode

    Address string
    Id string
    Meta Dictionary<string, string>
    Name string
    TaggedAddresses Dictionary<string, string>
    Address string
    Id string
    Meta map[string]string
    Name string
    TaggedAddresses map[string]string
    address String
    id String
    meta Map<String,String>
    name String
    taggedAddresses Map<String,String>
    address string
    id string
    meta {[key: string]: string}
    name string
    taggedAddresses {[key: string]: string}
    address str
    id str
    meta Mapping[str, str]
    name str
    tagged_addresses Mapping[str, str]
    address String
    id String
    meta Map<String>
    name String
    taggedAddresses Map<String>

    GetCatalogNodesQueryOption

    AllowStale bool
    Datacenter string
    Near string
    NodeMeta Dictionary<string, string>
    Partition string
    RequireConsistent bool
    Token string
    WaitIndex int
    WaitTime string
    AllowStale bool
    Datacenter string
    Near string
    NodeMeta map[string]string
    Partition string
    RequireConsistent bool
    Token string
    WaitIndex int
    WaitTime string
    allowStale Boolean
    datacenter String
    near String
    nodeMeta Map<String,String>
    partition String
    requireConsistent Boolean
    token String
    waitIndex Integer
    waitTime String
    allowStale boolean
    datacenter string
    near string
    nodeMeta {[key: string]: string}
    partition string
    requireConsistent boolean
    token string
    waitIndex number
    waitTime string
    allowStale Boolean
    datacenter String
    near String
    nodeMeta Map<String>
    partition String
    requireConsistent Boolean
    token String
    waitIndex Number
    waitTime String

    Package Details

    Repository
    HashiCorp Consul pulumi/pulumi-consul
    License
    Apache-2.0
    Notes

    This Pulumi package is based on the consul Terraform Provider.

    consul logo
    Consul v3.8.0 published on Friday, Mar 3, 2023 by Pulumi