1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. Domain
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp

googleworkspace.Domain

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp

    Domain resource manages Google Workspace Domains. Domain resides under the https://www.googleapis.com/auth/admin.directory.domain client scope.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as googleworkspace from "@pulumi/googleworkspace";
    
    const example = new googleworkspace.Domain("example", {domainName: "example.com"});
    
    import pulumi
    import pulumi_googleworkspace as googleworkspace
    
    example = googleworkspace.Domain("example", domain_name="example.com")
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-terraform-provider/sdks/go/googleworkspace/googleworkspace"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := googleworkspace.NewDomain(ctx, "example", &googleworkspace.DomainArgs{
    			DomainName: pulumi.String("example.com"),
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Googleworkspace = Pulumi.Googleworkspace;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Googleworkspace.Domain("example", new()
        {
            DomainName = "example.com",
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.googleworkspace.Domain;
    import com.pulumi.googleworkspace.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 example = new Domain("example", DomainArgs.builder()
                .domainName("example.com")
                .build());
    
        }
    }
    
    resources:
      example:
        type: googleworkspace:Domain
        properties:
          domainName: example.com
    

    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: DomainArgs,
               opts: Optional[ResourceOptions] = None)
    
    @overload
    def Domain(resource_name: str,
               opts: Optional[ResourceOptions] = None,
               domain_name: Optional[str] = None)
    func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)
    public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)
    public Domain(String name, DomainArgs args)
    public Domain(String name, DomainArgs args, CustomResourceOptions options)
    
    type: googleworkspace: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.

    Constructor example

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

    var domainResource = new Googleworkspace.Domain("domainResource", new()
    {
        DomainName = "string",
    });
    
    example, err := googleworkspace.NewDomain(ctx, "domainResource", &googleworkspace.DomainArgs{
    DomainName: pulumi.String("string"),
    })
    
    var domainResource = new Domain("domainResource", DomainArgs.builder()
        .domainName("string")
        .build());
    
    domain_resource = googleworkspace.Domain("domainResource", domain_name="string")
    
    const domainResource = new googleworkspace.Domain("domainResource", {domainName: "string"});
    
    type: googleworkspace:Domain
    properties:
        domainName: 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

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

    The Domain resource accepts the following input properties:

    DomainName string
    The domain name of the customer.
    DomainName string
    The domain name of the customer.
    domainName String
    The domain name of the customer.
    domainName string
    The domain name of the customer.
    domain_name str
    The domain name of the customer.
    domainName String
    The domain name of the customer.

    Outputs

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

    CreationTime double
    Creation time of the domain. Expressed in Unix time format.
    DomainAliases List<string>
    asps.list of domain alias objects.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    Indicates if the domain is a primary domain.
    Verified bool
    Indicates the verification state of a domain.
    CreationTime float64
    Creation time of the domain. Expressed in Unix time format.
    DomainAliases []string
    asps.list of domain alias objects.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    IsPrimary bool
    Indicates if the domain is a primary domain.
    Verified bool
    Indicates the verification state of a domain.
    creationTime Double
    Creation time of the domain. Expressed in Unix time format.
    domainAliases List<String>
    asps.list of domain alias objects.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    Indicates if the domain is a primary domain.
    verified Boolean
    Indicates the verification state of a domain.
    creationTime number
    Creation time of the domain. Expressed in Unix time format.
    domainAliases string[]
    asps.list of domain alias objects.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    isPrimary boolean
    Indicates if the domain is a primary domain.
    verified boolean
    Indicates the verification state of a domain.
    creation_time float
    Creation time of the domain. Expressed in Unix time format.
    domain_aliases Sequence[str]
    asps.list of domain alias objects.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    is_primary bool
    Indicates if the domain is a primary domain.
    verified bool
    Indicates the verification state of a domain.
    creationTime Number
    Creation time of the domain. Expressed in Unix time format.
    domainAliases List<String>
    asps.list of domain alias objects.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    isPrimary Boolean
    Indicates if the domain is a primary domain.
    verified Boolean
    Indicates the verification state of a domain.

    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,
            creation_time: Optional[float] = None,
            domain_aliases: Optional[Sequence[str]] = None,
            domain_name: Optional[str] = None,
            etag: Optional[str] = None,
            is_primary: Optional[bool] = None,
            verified: Optional[bool] = 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)
    resources:  _:    type: googleworkspace:Domain    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:
    CreationTime double
    Creation time of the domain. Expressed in Unix time format.
    DomainAliases List<string>
    asps.list of domain alias objects.
    DomainName string
    The domain name of the customer.
    Etag string
    ETag of the resource.
    IsPrimary bool
    Indicates if the domain is a primary domain.
    Verified bool
    Indicates the verification state of a domain.
    CreationTime float64
    Creation time of the domain. Expressed in Unix time format.
    DomainAliases []string
    asps.list of domain alias objects.
    DomainName string
    The domain name of the customer.
    Etag string
    ETag of the resource.
    IsPrimary bool
    Indicates if the domain is a primary domain.
    Verified bool
    Indicates the verification state of a domain.
    creationTime Double
    Creation time of the domain. Expressed in Unix time format.
    domainAliases List<String>
    asps.list of domain alias objects.
    domainName String
    The domain name of the customer.
    etag String
    ETag of the resource.
    isPrimary Boolean
    Indicates if the domain is a primary domain.
    verified Boolean
    Indicates the verification state of a domain.
    creationTime number
    Creation time of the domain. Expressed in Unix time format.
    domainAliases string[]
    asps.list of domain alias objects.
    domainName string
    The domain name of the customer.
    etag string
    ETag of the resource.
    isPrimary boolean
    Indicates if the domain is a primary domain.
    verified boolean
    Indicates the verification state of a domain.
    creation_time float
    Creation time of the domain. Expressed in Unix time format.
    domain_aliases Sequence[str]
    asps.list of domain alias objects.
    domain_name str
    The domain name of the customer.
    etag str
    ETag of the resource.
    is_primary bool
    Indicates if the domain is a primary domain.
    verified bool
    Indicates the verification state of a domain.
    creationTime Number
    Creation time of the domain. Expressed in Unix time format.
    domainAliases List<String>
    asps.list of domain alias objects.
    domainName String
    The domain name of the customer.
    etag String
    ETag of the resource.
    isPrimary Boolean
    Indicates if the domain is a primary domain.
    verified Boolean
    Indicates the verification state of a domain.

    Import

    $ pulumi import googleworkspace:index/domain:Domain example example.com
    

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

    Package Details

    Repository
    googleworkspace hashicorp/terraform-provider-googleworkspace
    License
    Notes
    This Pulumi package is based on the googleworkspace Terraform Provider.
    googleworkspace logo
    googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp