1. Packages
  2. Athenz Provider
  3. API Docs
  4. getDomain
athenz 1.0.49 published on Monday, Oct 6, 2025 by athenz

athenz.getDomain

Start a Neo task
Explain and create an athenz.getDomain resource
athenz logo
athenz 1.0.49 published on Monday, Oct 6, 2025 by athenz

    athenz.getDomain provides details about a specific Athenz domain (top-level domain/ sub domain/ personal domain)

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as athenz from "@pulumi/athenz";
    
    const config = new pulumi.Config();
    const domainName = config.require("domainName");
    const domain_test = athenz.getDomain({
        name: domainName,
    });
    
    import pulumi
    import pulumi_athenz as athenz
    
    config = pulumi.Config()
    domain_name = config.require("domainName")
    domain_test = athenz.get_domain(name=domain_name)
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/athenz/athenz"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi/config"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		cfg := config.New(ctx, "")
    		domainName := cfg.Require("domainName")
    		_, err := athenz.GetDomain(ctx, &athenz.GetDomainArgs{
    			Name: domainName,
    		}, nil)
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Athenz = Pulumi.Athenz;
    
    return await Deployment.RunAsync(() => 
    {
        var config = new Config();
        var domainName = config.Require("domainName");
        var domain_test = Athenz.GetDomain.Invoke(new()
        {
            Name = domainName,
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.athenz.AthenzFunctions;
    import com.pulumi.athenz.inputs.GetDomainArgs;
    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 config = ctx.config();
            final var domainName = config.get("domainName");
            final var domain-test = AthenzFunctions.getDomain(GetDomainArgs.builder()
                .name(domainName)
                .build());
    
        }
    }
    
    configuration:
      domainName:
        type: string
    variables:
      domain-test:
        fn::invoke:
          function: athenz:getDomain
          arguments:
            name: ${domainName}
    

    Using getDomain

    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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
    function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
    def get_domain(id: Optional[str] = None,
                   name: Optional[str] = None,
                   opts: Optional[InvokeOptions] = None) -> GetDomainResult
    def get_domain_output(id: Optional[pulumi.Input[str]] = None,
                   name: Optional[pulumi.Input[str]] = None,
                   opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
    func GetDomain(ctx *Context, args *GetDomainArgs, opts ...InvokeOption) (*GetDomainResult, error)
    func GetDomainOutput(ctx *Context, args *GetDomainOutputArgs, opts ...InvokeOption) GetDomainResultOutput

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

    public static class GetDomain 
    {
        public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    public static Output<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
    
    fn::invoke:
      function: athenz:index/getDomain:getDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    Name string
    • The name of the specific Athenz domain. must be fully qualified name.
    Id string
    The ID of this resource.
    Name string
    • The name of the specific Athenz domain. must be fully qualified name.
    Id string
    The ID of this resource.
    name String
    • The name of the specific Athenz domain. must be fully qualified name.
    id String
    The ID of this resource.
    name string
    • The name of the specific Athenz domain. must be fully qualified name.
    id string
    The ID of this resource.
    name str
    • The name of the specific Athenz domain. must be fully qualified name.
    id str
    The ID of this resource.
    name String
    • The name of the specific Athenz domain. must be fully qualified name.
    id String
    The ID of this resource.

    getDomain Result

    The following output properties are available:

    Id string
    The ID of this resource.
    Name string
    • The name of the specific Athenz domain. must be fully qualified name.
    Id string
    The ID of this resource.
    Name string
    • The name of the specific Athenz domain. must be fully qualified name.
    id String
    The ID of this resource.
    name String
    • The name of the specific Athenz domain. must be fully qualified name.
    id string
    The ID of this resource.
    name string
    • The name of the specific Athenz domain. must be fully qualified name.
    id str
    The ID of this resource.
    name str
    • The name of the specific Athenz domain. must be fully qualified name.
    id String
    The ID of this resource.
    name String
    • The name of the specific Athenz domain. must be fully qualified name.

    Package Details

    Repository
    athenz athenz/terraform-provider-athenz
    License
    Notes
    This Pulumi package is based on the athenz Terraform Provider.
    athenz logo
    athenz 1.0.49 published on Monday, Oct 6, 2025 by athenz
      Meet Neo: Your AI Platform Teammate