1. Packages
  2. Athenz Provider
  3. API Docs
  4. UserDomain
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

athenz.UserDomain

Explore with Pulumi AI

athenz logo
athenz 1.0.45 published on Tuesday, Apr 15, 2025 by athenz

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as athenz from "@pulumi/athenz";
    
    const athenzUserDomain_test = new athenz.UserDomain("athenzUserDomain-test", {auditRef: "create domain"});
    
    import pulumi
    import pulumi_athenz as athenz
    
    athenz_user_domain_test = athenz.UserDomain("athenzUserDomain-test", audit_ref="create domain")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/athenz/athenz"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := athenz.NewUserDomain(ctx, "athenzUserDomain-test", &athenz.UserDomainArgs{
    			AuditRef: pulumi.String("create domain"),
    		})
    		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 athenzUserDomain_test = new Athenz.UserDomain("athenzUserDomain-test", new()
        {
            AuditRef = "create domain",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.athenz.UserDomain;
    import com.pulumi.athenz.UserDomainArgs;
    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) {
            var athenzUserDomain_test = new UserDomain("athenzUserDomain-test", UserDomainArgs.builder()
                .auditRef("create domain")
                .build());
    
        }
    }
    
    resources:
      athenzUserDomain-test:
        type: athenz:UserDomain
        properties:
          auditRef: create domain
    

    Create UserDomain Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new UserDomain(name: string, args?: UserDomainArgs, opts?: CustomResourceOptions);
    @overload
    def UserDomain(resource_name: str,
                   args: Optional[UserDomainArgs] = None,
                   opts: Optional[ResourceOptions] = None)
    
    @overload
    def UserDomain(resource_name: str,
                   opts: Optional[ResourceOptions] = None,
                   audit_ref: Optional[str] = None,
                   name: Optional[str] = None,
                   user_domain_id: Optional[str] = None)
    func NewUserDomain(ctx *Context, name string, args *UserDomainArgs, opts ...ResourceOption) (*UserDomain, error)
    public UserDomain(string name, UserDomainArgs? args = null, CustomResourceOptions? opts = null)
    public UserDomain(String name, UserDomainArgs args)
    public UserDomain(String name, UserDomainArgs args, CustomResourceOptions options)
    
    type: athenz:UserDomain
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args UserDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args UserDomainArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args UserDomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args UserDomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args UserDomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Constructor example

    The following reference example uses placeholder values for all input properties.

    var userDomainResource = new Athenz.UserDomain("userDomainResource", new()
    {
        AuditRef = "string",
        Name = "string",
        UserDomainId = "string",
    });
    
    example, err := athenz.NewUserDomain(ctx, "userDomainResource", &athenz.UserDomainArgs{
    	AuditRef:     pulumi.String("string"),
    	Name:         pulumi.String("string"),
    	UserDomainId: pulumi.String("string"),
    })
    
    var userDomainResource = new UserDomain("userDomainResource", UserDomainArgs.builder()
        .auditRef("string")
        .name("string")
        .userDomainId("string")
        .build());
    
    user_domain_resource = athenz.UserDomain("userDomainResource",
        audit_ref="string",
        name="string",
        user_domain_id="string")
    
    const userDomainResource = new athenz.UserDomain("userDomainResource", {
        auditRef: "string",
        name: "string",
        userDomainId: "string",
    });
    
    type: athenz:UserDomain
    properties:
        auditRef: string
        name: string
        userDomainId: string
    

    UserDomain Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.

    The UserDomain resource accepts the following input properties:

    AuditRef string
    string containing audit specification or ticket number.
    Name string
    user id which will be the domain name.
    UserDomainId string
    The ID of this resource.
    AuditRef string
    string containing audit specification or ticket number.
    Name string
    user id which will be the domain name.
    UserDomainId string
    The ID of this resource.
    auditRef String
    string containing audit specification or ticket number.
    name String
    user id which will be the domain name.
    userDomainId String
    The ID of this resource.
    auditRef string
    string containing audit specification or ticket number.
    name string
    user id which will be the domain name.
    userDomainId string
    The ID of this resource.
    audit_ref str
    string containing audit specification or ticket number.
    name str
    user id which will be the domain name.
    user_domain_id str
    The ID of this resource.
    auditRef String
    string containing audit specification or ticket number.
    name String
    user id which will be the domain name.
    userDomainId String
    The ID of this resource.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the UserDomain resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing UserDomain Resource

    Get an existing UserDomain resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: UserDomainState, opts?: CustomResourceOptions): UserDomain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            audit_ref: Optional[str] = None,
            name: Optional[str] = None,
            user_domain_id: Optional[str] = None) -> UserDomain
    func GetUserDomain(ctx *Context, name string, id IDInput, state *UserDomainState, opts ...ResourceOption) (*UserDomain, error)
    public static UserDomain Get(string name, Input<string> id, UserDomainState? state, CustomResourceOptions? opts = null)
    public static UserDomain get(String name, Output<String> id, UserDomainState state, CustomResourceOptions options)
    resources:  _:    type: athenz:UserDomain    get:      id: ${id}
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    AuditRef string
    string containing audit specification or ticket number.
    Name string
    user id which will be the domain name.
    UserDomainId string
    The ID of this resource.
    AuditRef string
    string containing audit specification or ticket number.
    Name string
    user id which will be the domain name.
    UserDomainId string
    The ID of this resource.
    auditRef String
    string containing audit specification or ticket number.
    name String
    user id which will be the domain name.
    userDomainId String
    The ID of this resource.
    auditRef string
    string containing audit specification or ticket number.
    name string
    user id which will be the domain name.
    userDomainId string
    The ID of this resource.
    audit_ref str
    string containing audit specification or ticket number.
    name str
    user id which will be the domain name.
    user_domain_id str
    The ID of this resource.
    auditRef String
    string containing audit specification or ticket number.
    name String
    user id which will be the domain name.
    userDomainId String
    The ID of this resource.

    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.45 published on Tuesday, Apr 15, 2025 by athenz