1. Packages
  2. Zitadel
  3. API Docs
  4. Domain
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

zitadel.Domain

Explore with Pulumi AI

zitadel logo
zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse

    Resource representing a domain of the organization.

    Example Usage

    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Zitadel = Pulumiverse.Zitadel;
    
    return await Deployment.RunAsync(() => 
    {
        var @default = new Zitadel.Domain("default", new()
        {
            OrgId = data.Zitadel_org.Default.Id,
            IsPrimary = false,
        });
    
    });
    
    package main
    
    import (
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    	"github.com/pulumiverse/pulumi-zitadel/sdk/go/zitadel"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := zitadel.NewDomain(ctx, "default", &zitadel.DomainArgs{
    			OrgId:     pulumi.Any(data.Zitadel_org.Default.Id),
    			IsPrimary: pulumi.Bool(false),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.zitadel.Domain;
    import com.pulumi.zitadel.DomainArgs;
    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 default_ = new Domain("default", DomainArgs.builder()        
                .orgId(data.zitadel_org().default().id())
                .isPrimary(false)
                .build());
    
        }
    }
    
    import pulumi
    import pulumiverse_zitadel as zitadel
    
    default = zitadel.Domain("default",
        org_id=data["zitadel_org"]["default"]["id"],
        is_primary=False)
    
    import * as pulumi from "@pulumi/pulumi";
    import * as zitadel from "@pulumiverse/zitadel";
    
    const _default = new zitadel.Domain("default", {
        orgId: data.zitadel_org["default"].id,
        isPrimary: false,
    });
    
    resources:
      default:
        type: zitadel:Domain
        properties:
          orgId: ${data.zitadel_org.default.id}
          isPrimary: false
    

    Create Domain Resource

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

    Constructor syntax

    new Domain(name: string, args?: DomainArgs, opts?: CustomResourceOptions);
    @overload
    def Domain(resource_name: str,
               args: Optional[DomainArgs] = None,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               is_primary: Optional[bool] = None,
               name: Optional[str] = None,
               org_id: Optional[str] = None)
    func NewDomain(ctx *Context, name string, args *DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs? args = null, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
    public Domain(String name, DomainArgs args, CustomResourceOptions options)
    
    type: zitadel:Domain
    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 DomainArgs
    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 DomainArgs
    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 DomainArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

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

    var domainResource = new Zitadel.Domain("domainResource", new()
    {
        IsPrimary = false,
        Name = "string",
        OrgId = "string",
    });
    
    example, err := zitadel.NewDomain(ctx, "domainResource", &zitadel.DomainArgs{
    	IsPrimary: pulumi.Bool(false),
    	Name:      pulumi.String("string"),
    	OrgId:     pulumi.String("string"),
    })
    
    var domainResource = new Domain("domainResource", DomainArgs.builder()        
        .isPrimary(false)
        .name("string")
        .orgId("string")
        .build());
    
    domain_resource = zitadel.Domain("domainResource",
        is_primary=False,
        name="string",
        org_id="string")
    
    const domainResource = new zitadel.Domain("domainResource", {
        isPrimary: false,
        name: "string",
        orgId: "string",
    });
    
    type: zitadel:Domain
    properties:
        isPrimary: false
        name: string
        orgId: string
    

    Domain Resource Properties

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

    Inputs

    The Domain resource accepts the following input properties:

    IsPrimary bool
    Is domain primary
    Name string
    Name of the domain
    OrgId string
    ID of the organization
    IsPrimary bool
    Is domain primary
    Name string
    Name of the domain
    OrgId string
    ID of the organization
    isPrimary Boolean
    Is domain primary
    name String
    Name of the domain
    orgId String
    ID of the organization
    isPrimary boolean
    Is domain primary
    name string
    Name of the domain
    orgId string
    ID of the organization
    is_primary bool
    Is domain primary
    name str
    Name of the domain
    org_id str
    ID of the organization
    isPrimary Boolean
    Is domain primary
    name String
    Name of the domain
    orgId String
    ID of the organization

    Outputs

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

    Id string
    The provider-assigned unique ID for this managed resource.
    IsVerified bool
    Is domain verified
    ValidationType int
    Validation type
    Id string
    The provider-assigned unique ID for this managed resource.
    IsVerified bool
    Is domain verified
    ValidationType int
    Validation type
    id String
    The provider-assigned unique ID for this managed resource.
    isVerified Boolean
    Is domain verified
    validationType Integer
    Validation type
    id string
    The provider-assigned unique ID for this managed resource.
    isVerified boolean
    Is domain verified
    validationType number
    Validation type
    id str
    The provider-assigned unique ID for this managed resource.
    is_verified bool
    Is domain verified
    validation_type int
    Validation type
    id String
    The provider-assigned unique ID for this managed resource.
    isVerified Boolean
    Is domain verified
    validationType Number
    Validation type

    Look up Existing Domain Resource

    Get an existing Domain 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?: DomainState, opts?: CustomResourceOptions): Domain
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            is_primary: Optional[bool] = None,
            is_verified: Optional[bool] = None,
            name: Optional[str] = None,
            org_id: Optional[str] = None,
            validation_type: Optional[int] = None) -> Domain
    func GetDomain(ctx *Context, name string, id IDInput, state *DomainState, opts ...ResourceOption) (*Domain, error)
    public static Domain Get(string name, Input<string> id, DomainState? state, CustomResourceOptions? opts = null)
    public static Domain get(String name, Output<String> id, DomainState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    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:
    IsPrimary bool
    Is domain primary
    IsVerified bool
    Is domain verified
    Name string
    Name of the domain
    OrgId string
    ID of the organization
    ValidationType int
    Validation type
    IsPrimary bool
    Is domain primary
    IsVerified bool
    Is domain verified
    Name string
    Name of the domain
    OrgId string
    ID of the organization
    ValidationType int
    Validation type
    isPrimary Boolean
    Is domain primary
    isVerified Boolean
    Is domain verified
    name String
    Name of the domain
    orgId String
    ID of the organization
    validationType Integer
    Validation type
    isPrimary boolean
    Is domain primary
    isVerified boolean
    Is domain verified
    name string
    Name of the domain
    orgId string
    ID of the organization
    validationType number
    Validation type
    is_primary bool
    Is domain primary
    is_verified bool
    Is domain verified
    name str
    Name of the domain
    org_id str
    ID of the organization
    validation_type int
    Validation type
    isPrimary Boolean
    Is domain primary
    isVerified Boolean
    Is domain verified
    name String
    Name of the domain
    orgId String
    ID of the organization
    validationType Number
    Validation type

    Import

    terraform The resource can be imported using the ID format name[:org_id], e.g.

     $ pulumi import zitadel:index/domain:Domain imported 'example.com:123456789012345678'
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    zitadel pulumiverse/pulumi-zitadel
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the zitadel Terraform Provider.
    zitadel logo
    zitadel v0.1.7 published on Tuesday, Mar 26, 2024 by pulumiverse