@pulumi/gcp
Version:
A Pulumi package for creating and managing Google Cloud Platform resources.
247 lines (246 loc) • 10.5 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
/**
* Creates a Microsoft AD domain
*
* To get more information about Domain, see:
*
* * [API documentation](https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains)
* * How-to Guides
* * [Managed Microsoft Active Directory Quickstart](https://cloud.google.com/managed-microsoft-ad/docs/quickstarts)
*
* ## Example Usage
*
* ### Active Directory Domain Basic
*
* ```typescript
* import * as pulumi from "@pulumi/pulumi";
* import * as gcp from "@pulumi/gcp";
*
* const ad_domain = new gcp.activedirectory.Domain("ad-domain", {
* domainName: "tfgen.org.com",
* locations: ["us-central1"],
* reservedIpRange: "192.168.255.0/24",
* deletionProtection: false,
* });
* ```
*
* ## Import
*
* Domain can be imported using any of these accepted formats:
*
* * `{{project}}/{{name}}`
*
* * `{{project}} {{name}}`
*
* * `{{name}}`
*
* When using the `pulumi import` command, Domain can be imported using one of the formats above. For example:
*
* ```sh
* $ pulumi import gcp:activedirectory/domain:Domain default {{project}}/{{name}}
* ```
*
* ```sh
* $ pulumi import gcp:activedirectory/domain:Domain default "{{project}} {{name}}"
* ```
*
* ```sh
* $ pulumi import gcp:activedirectory/domain:Domain default {{name}}
* ```
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param state Any extra arguments used during the lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DomainState, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
/**
* The name of delegated administrator account used to perform Active Directory operations.
* If not specified, setupadmin will be used.
*/
readonly admin: pulumi.Output<string | undefined>;
/**
* The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.
* If CIDR subnets overlap between networks, domain creation will fail.
*/
readonly authorizedNetworks: pulumi.Output<string[] | undefined>;
readonly deletionProtection: pulumi.Output<boolean | undefined>;
/**
* The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions
* of https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.
*/
readonly domainName: pulumi.Output<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
readonly effectiveLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The fully-qualified domain name of the exposed domain used by clients to connect to the service.
* Similar to what would be chosen for an Active Directory set up on an internal network.
*/
readonly fqdn: pulumi.Output<string>;
/**
* Resource labels that can contain user-provided metadata
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
readonly labels: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/]
* e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
*/
readonly locations: pulumi.Output<string[]>;
/**
* The unique name of the domain using the format: `projects/{project}/locations/global/domains/{domainName}`.
*/
readonly name: pulumi.Output<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
readonly project: pulumi.Output<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
readonly pulumiLabels: pulumi.Output<{
[key: string]: string;
}>;
/**
* The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger.
* Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks
*/
readonly reservedIpRange: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* Input properties used for looking up and filtering Domain resources.
*/
export interface DomainState {
/**
* The name of delegated administrator account used to perform Active Directory operations.
* If not specified, setupadmin will be used.
*/
admin?: pulumi.Input<string>;
/**
* The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.
* If CIDR subnets overlap between networks, domain creation will fail.
*/
authorizedNetworks?: pulumi.Input<pulumi.Input<string>[]>;
deletionProtection?: pulumi.Input<boolean>;
/**
* The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions
* of https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.
*/
domainName?: pulumi.Input<string>;
/**
* All of labels (key/value pairs) present on the resource in GCP, including the labels configured through Pulumi, other clients and services.
*/
effectiveLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The fully-qualified domain name of the exposed domain used by clients to connect to the service.
* Similar to what would be chosen for an Active Directory set up on an internal network.
*/
fqdn?: pulumi.Input<string>;
/**
* Resource labels that can contain user-provided metadata
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/]
* e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
*/
locations?: pulumi.Input<pulumi.Input<string>[]>;
/**
* The unique name of the domain using the format: `projects/{project}/locations/global/domains/{domainName}`.
*/
name?: pulumi.Input<string>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The combination of labels configured directly on the resource
* and default labels configured on the provider.
*/
pulumiLabels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger.
* Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks
*/
reservedIpRange?: pulumi.Input<string>;
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
/**
* The name of delegated administrator account used to perform Active Directory operations.
* If not specified, setupadmin will be used.
*/
admin?: pulumi.Input<string>;
/**
* The full names of the Google Compute Engine networks the domain instance is connected to. The domain is only available on networks listed in authorizedNetworks.
* If CIDR subnets overlap between networks, domain creation will fail.
*/
authorizedNetworks?: pulumi.Input<pulumi.Input<string>[]>;
deletionProtection?: pulumi.Input<boolean>;
/**
* The fully qualified domain name. e.g. mydomain.myorganization.com, with the restrictions
* of https://cloud.google.com/managed-microsoft-ad/reference/rest/v1/projects.locations.global.domains.
*/
domainName: pulumi.Input<string>;
/**
* Resource labels that can contain user-provided metadata
* **Note**: This field is non-authoritative, and will only manage the labels present in your configuration.
* Please refer to the field `effectiveLabels` for all of the labels present on the resource.
*/
labels?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Locations where domain needs to be provisioned. [regions][compute/docs/regions-zones/]
* e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
*/
locations: pulumi.Input<pulumi.Input<string>[]>;
/**
* The ID of the project in which the resource belongs.
* If it is not provided, the provider project is used.
*/
project?: pulumi.Input<string>;
/**
* The CIDR range of internal addresses that are reserved for this domain. Reserved networks must be /24 or larger.
* Ranges must be unique and non-overlapping with existing subnets in authorizedNetworks
*/
reservedIpRange: pulumi.Input<string>;
}