Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Googleworkspace Provider
  3. API Docs
  4. DomainAlias
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

googleworkspace.DomainAlias

Explore with Pulumi AI

googleworkspace logo
googleworkspace 0.7.0 published on Wednesday, Jan 15, 2025 by hashicorp
hashicorp/terraform-provider-googleworkspace

    Domain Alias resource manages Google Workspace Domain Aliases. Domain Alias 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.DomainAlias("example", {
    domainAliasName: "alias-example.com",
    parentDomainName: "example.com",
});

    import pulumi
import pulumi_googleworkspace as googleworkspace

example = googleworkspace.DomainAlias("example",
    domain_alias_name="alias-example.com",
    parent_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.NewDomainAlias(ctx, "example", &googleworkspace.DomainAliasArgs{
			DomainAliasName:  pulumi.String("alias-example.com"),
			ParentDomainName: 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.DomainAlias("example", new()
    {
        DomainAliasName = "alias-example.com",
        ParentDomainName = "example.com",
    });

});

    package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.googleworkspace.DomainAlias;
import com.pulumi.googleworkspace.DomainAliasArgs;
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 DomainAlias("example", DomainAliasArgs.builder()
            .domainAliasName("alias-example.com")
            .parentDomainName("example.com")
            .build());

    }
}

    resources:
  example:
    type: googleworkspace:DomainAlias
    properties:
      domainAliasName: alias-example.com
      parentDomainName: example.com

    Create DomainAlias Resource

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

    Constructor syntax

    new DomainAlias(name: string, args: DomainAliasArgs, opts?: CustomResourceOptions);
    @overload
def DomainAlias(resource_name: str,
                args: DomainAliasArgs,
                opts: Optional[ResourceOptions] = None)

@overload
def DomainAlias(resource_name: str,
                opts: Optional[ResourceOptions] = None,
                domain_alias_name: Optional[str] = None,
                parent_domain_name: Optional[str] = None)
    func NewDomainAlias(ctx *Context, name string, args DomainAliasArgs, opts ...ResourceOption) (*DomainAlias, error)
    public DomainAlias(string name, DomainAliasArgs args, CustomResourceOptions? opts = null)
    public DomainAlias(String name, DomainAliasArgs args)
public DomainAlias(String name, DomainAliasArgs args, CustomResourceOptions options)

    type: googleworkspace:DomainAlias
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 DomainAliasArgs
    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 DomainAliasArgs
    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 DomainAliasArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DomainAliasArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DomainAliasArgs
    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 domainAliasResource = new Googleworkspace.DomainAlias("domainAliasResource", new()
{
    DomainAliasName = "string",
    ParentDomainName = "string",
});

    example, err := googleworkspace.NewDomainAlias(ctx, "domainAliasResource", &googleworkspace.DomainAliasArgs{
DomainAliasName: pulumi.String("string"),
ParentDomainName: pulumi.String("string"),
})

    var domainAliasResource = new DomainAlias("domainAliasResource", DomainAliasArgs.builder()
    .domainAliasName("string")
    .parentDomainName("string")
    .build());

    domain_alias_resource = googleworkspace.DomainAlias("domainAliasResource",
    domain_alias_name="string",
    parent_domain_name="string")

    const domainAliasResource = new googleworkspace.DomainAlias("domainAliasResource", {
    domainAliasName: "string",
    parentDomainName: "string",
});

    type: googleworkspace:DomainAlias
properties:
    domainAliasName: string
    parentDomainName: string

    DomainAlias 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 DomainAlias resource accepts the following input properties:

    DomainAliasName string
    The domain alias name.
    ParentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    DomainAliasName string
    The domain alias name.
    ParentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    domainAliasName String
    The domain alias name.
    parentDomainName String
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    domainAliasName string
    The domain alias name.
    parentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    domain_alias_name str
    The domain alias name.
    parent_domain_name str
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    domainAliasName String
    The domain alias name.
    parentDomainName String
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.

    Outputs

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

    CreationTime double
    Creation time of the domain alias.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Verified bool
    Indicates the verification state of a domain alias.
    CreationTime float64
    Creation time of the domain alias.
    Etag string
    ETag of the resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    Verified bool
    Indicates the verification state of a domain alias.
    creationTime Double
    Creation time of the domain alias.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    verified Boolean
    Indicates the verification state of a domain alias.
    creationTime number
    Creation time of the domain alias.
    etag string
    ETag of the resource.
    id string
    The provider-assigned unique ID for this managed resource.
    verified boolean
    Indicates the verification state of a domain alias.
    creation_time float
    Creation time of the domain alias.
    etag str
    ETag of the resource.
    id str
    The provider-assigned unique ID for this managed resource.
    verified bool
    Indicates the verification state of a domain alias.
    creationTime Number
    Creation time of the domain alias.
    etag String
    ETag of the resource.
    id String
    The provider-assigned unique ID for this managed resource.
    verified Boolean
    Indicates the verification state of a domain alias.

    Look up Existing DomainAlias Resource

    Get an existing DomainAlias 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?: DomainAliasState, opts?: CustomResourceOptions): DomainAlias
    @staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        creation_time: Optional[float] = None,
        domain_alias_name: Optional[str] = None,
        etag: Optional[str] = None,
        parent_domain_name: Optional[str] = None,
        verified: Optional[bool] = None) -> DomainAlias
    func GetDomainAlias(ctx *Context, name string, id IDInput, state *DomainAliasState, opts ...ResourceOption) (*DomainAlias, error)
    public static DomainAlias Get(string name, Input<string> id, DomainAliasState? state, CustomResourceOptions? opts = null)
    public static DomainAlias get(String name, Output<String> id, DomainAliasState state, CustomResourceOptions options)
    resources:  _:    type: googleworkspace:DomainAlias    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 alias.
    DomainAliasName string
    The domain alias name.
    Etag string
    ETag of the resource.
    ParentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    Verified bool
    Indicates the verification state of a domain alias.
    CreationTime float64
    Creation time of the domain alias.
    DomainAliasName string
    The domain alias name.
    Etag string
    ETag of the resource.
    ParentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    Verified bool
    Indicates the verification state of a domain alias.
    creationTime Double
    Creation time of the domain alias.
    domainAliasName String
    The domain alias name.
    etag String
    ETag of the resource.
    parentDomainName String
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    verified Boolean
    Indicates the verification state of a domain alias.
    creationTime number
    Creation time of the domain alias.
    domainAliasName string
    The domain alias name.
    etag string
    ETag of the resource.
    parentDomainName string
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    verified boolean
    Indicates the verification state of a domain alias.
    creation_time float
    Creation time of the domain alias.
    domain_alias_name str
    The domain alias name.
    etag str
    ETag of the resource.
    parent_domain_name str
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    verified bool
    Indicates the verification state of a domain alias.
    creationTime Number
    Creation time of the domain alias.
    domainAliasName String
    The domain alias name.
    etag String
    ETag of the resource.
    parentDomainName String
    The parent domain name that the domain alias is associated with. This can either be a primary or secondary domain name within a customer.
    verified Boolean
    Indicates the verification state of a domain alias.

    Import

    $ pulumi import googleworkspace:index/domainAlias:DomainAlias example alias-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
    hashicorp/terraform-provider-googleworkspace