1. Packages
  2. Consul Provider
  3. API Docs
  4. getAclAuthMethod
Consul v3.12.1 published on Friday, Aug 23, 2024 by Pulumi

consul.getAclAuthMethod

Explore with Pulumi AI

consul logo
Consul v3.12.1 published on Friday, Aug 23, 2024 by Pulumi

    The consul.AclAuthMethod data source returns the information related to a Consul Auth Method.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as consul from "@pulumi/consul";
    
    const test = consul.getAclAuthMethod({
        name: "minikube",
    });
    export const consulAclAuthMethod = test.then(test => test.config);
    
    import pulumi
    import pulumi_consul as consul
    
    test = consul.get_acl_auth_method(name="minikube")
    pulumi.export("consulAclAuthMethod", test.config)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-consul/sdk/v3/go/consul"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		test, err := consul.LookupAclAuthMethod(ctx, &consul.LookupAclAuthMethodArgs{
    			Name: "minikube",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		ctx.Export("consulAclAuthMethod", test.Config)
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Consul = Pulumi.Consul;
    
    return await Deployment.RunAsync(() => 
    {
        var test = Consul.GetAclAuthMethod.Invoke(new()
        {
            Name = "minikube",
        });
    
        return new Dictionary<string, object?>
        {
            ["consulAclAuthMethod"] = test.Apply(getAclAuthMethodResult => getAclAuthMethodResult.Config),
        };
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.consul.ConsulFunctions;
    import com.pulumi.consul.inputs.GetAclAuthMethodArgs;
    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) {
            final var test = ConsulFunctions.getAclAuthMethod(GetAclAuthMethodArgs.builder()
                .name("minikube")
                .build());
    
            ctx.export("consulAclAuthMethod", test.applyValue(getAclAuthMethodResult -> getAclAuthMethodResult.config()));
        }
    }
    
    variables:
      test:
        fn::invoke:
          Function: consul:getAclAuthMethod
          Arguments:
            name: minikube
    outputs:
      consulAclAuthMethod: ${test.config}
    

    Using getAclAuthMethod

    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 getAclAuthMethod(args: GetAclAuthMethodArgs, opts?: InvokeOptions): Promise<GetAclAuthMethodResult>
    function getAclAuthMethodOutput(args: GetAclAuthMethodOutputArgs, opts?: InvokeOptions): Output<GetAclAuthMethodResult>
    def get_acl_auth_method(name: Optional[str] = None,
                            namespace: Optional[str] = None,
                            partition: Optional[str] = None,
                            opts: Optional[InvokeOptions] = None) -> GetAclAuthMethodResult
    def get_acl_auth_method_output(name: Optional[pulumi.Input[str]] = None,
                            namespace: Optional[pulumi.Input[str]] = None,
                            partition: Optional[pulumi.Input[str]] = None,
                            opts: Optional[InvokeOptions] = None) -> Output[GetAclAuthMethodResult]
    func LookupAclAuthMethod(ctx *Context, args *LookupAclAuthMethodArgs, opts ...InvokeOption) (*LookupAclAuthMethodResult, error)
    func LookupAclAuthMethodOutput(ctx *Context, args *LookupAclAuthMethodOutputArgs, opts ...InvokeOption) LookupAclAuthMethodResultOutput

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

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

    The following arguments are supported:

    Name string
    The name of the ACL Auth Method.
    Namespace string
    The namespace to lookup the auth method.
    Partition string
    The partition to lookup the auth method.
    Name string
    The name of the ACL Auth Method.
    Namespace string
    The namespace to lookup the auth method.
    Partition string
    The partition to lookup the auth method.
    name String
    The name of the ACL Auth Method.
    namespace String
    The namespace to lookup the auth method.
    partition String
    The partition to lookup the auth method.
    name string
    The name of the ACL Auth Method.
    namespace string
    The namespace to lookup the auth method.
    partition string
    The partition to lookup the auth method.
    name str
    The name of the ACL Auth Method.
    namespace str
    The namespace to lookup the auth method.
    partition str
    The partition to lookup the auth method.
    name String
    The name of the ACL Auth Method.
    namespace String
    The namespace to lookup the auth method.
    partition String
    The partition to lookup the auth method.

    getAclAuthMethod Result

    The following output properties are available:

    Config Dictionary<string, string>
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    ConfigJson string
    The configuration options of the ACL Auth Method.
    Description string
    The description of the ACL Auth Method.
    DisplayName string
    An optional name to use instead of the name attribute when displaying information about this auth method.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxTokenTtl string
    The maximum life of any token created by this auth method.
    Name string
    NamespaceRules List<GetAclAuthMethodNamespaceRule>
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    TokenLocality string
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    Type string
    The type of the ACL Auth Method.
    Namespace string
    Partition string
    Config map[string]string
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    ConfigJson string
    The configuration options of the ACL Auth Method.
    Description string
    The description of the ACL Auth Method.
    DisplayName string
    An optional name to use instead of the name attribute when displaying information about this auth method.
    Id string
    The provider-assigned unique ID for this managed resource.
    MaxTokenTtl string
    The maximum life of any token created by this auth method.
    Name string
    NamespaceRules []GetAclAuthMethodNamespaceRule
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    TokenLocality string
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    Type string
    The type of the ACL Auth Method.
    Namespace string
    Partition string
    config Map<String,String>
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    configJson String
    The configuration options of the ACL Auth Method.
    description String
    The description of the ACL Auth Method.
    displayName String
    An optional name to use instead of the name attribute when displaying information about this auth method.
    id String
    The provider-assigned unique ID for this managed resource.
    maxTokenTtl String
    The maximum life of any token created by this auth method.
    name String
    namespaceRules List<GetAclAuthMethodNamespaceRule>
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    tokenLocality String
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    type String
    The type of the ACL Auth Method.
    namespace String
    partition String
    config {[key: string]: string}
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    configJson string
    The configuration options of the ACL Auth Method.
    description string
    The description of the ACL Auth Method.
    displayName string
    An optional name to use instead of the name attribute when displaying information about this auth method.
    id string
    The provider-assigned unique ID for this managed resource.
    maxTokenTtl string
    The maximum life of any token created by this auth method.
    name string
    namespaceRules GetAclAuthMethodNamespaceRule[]
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    tokenLocality string
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    type string
    The type of the ACL Auth Method.
    namespace string
    partition string
    config Mapping[str, str]
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    config_json str
    The configuration options of the ACL Auth Method.
    description str
    The description of the ACL Auth Method.
    display_name str
    An optional name to use instead of the name attribute when displaying information about this auth method.
    id str
    The provider-assigned unique ID for this managed resource.
    max_token_ttl str
    The maximum life of any token created by this auth method.
    name str
    namespace_rules Sequence[GetAclAuthMethodNamespaceRule]
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    token_locality str
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    type str
    The type of the ACL Auth Method.
    namespace str
    partition str
    config Map<String>
    The configuration options of the ACL Auth Method. This attribute is deprecated and will be removed in a future version. If the configuration is too complex to be represented as a map of strings, it will be blank. config_json should be used instead.

    Deprecated: The config attribute is deprecated, please use config_json instead.

    configJson String
    The configuration options of the ACL Auth Method.
    description String
    The description of the ACL Auth Method.
    displayName String
    An optional name to use instead of the name attribute when displaying information about this auth method.
    id String
    The provider-assigned unique ID for this managed resource.
    maxTokenTtl String
    The maximum life of any token created by this auth method.
    name String
    namespaceRules List<Property Map>
    (Enterprise Only) A set of rules that control which namespace tokens created via this auth method will be created within
    tokenLocality String
    The kind of token that this auth method produces. This can be either 'local' or 'global'.
    type String
    The type of the ACL Auth Method.
    namespace String
    partition String

    Supporting Types

    GetAclAuthMethodNamespaceRule

    BindNamespace string
    Selector string
    BindNamespace string
    Selector string
    bindNamespace String
    selector String
    bindNamespace string
    selector string
    bindNamespace String
    selector 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.12.1 published on Friday, Aug 23, 2024 by Pulumi