1. Packages
  2. Google Cloud Native
  3. API Docs
  4. managedidentities
  5. managedidentities/v1beta1
  6. Domain

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

google-native.managedidentities/v1beta1.Domain

Explore with Pulumi AI

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi

Creates a Microsoft AD domain. Auto-naming is currently not supported for this resource.

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,
           locations: Optional[Sequence[str]] = None,
           reserved_ip_range: Optional[str] = None,
           admin: Optional[str] = None,
           audit_logs_enabled: Optional[bool] = None,
           authorized_networks: Optional[Sequence[str]] = None,
           labels: Optional[Mapping[str, str]] = None,
           project: 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: google-native:managedidentities/v1beta1:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

Parameters

name This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name This property is required. str
The unique name of the resource.
args This property is required. 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 This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name This property is required. string
The unique name of the resource.
args This property is required. DomainArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name This property is required. String
The unique name of the resource.
args This property is required. 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 exampledomainResourceResourceFromManagedidentitiesv1beta1 = new GoogleNative.Managedidentities.V1Beta1.Domain("exampledomainResourceResourceFromManagedidentitiesv1beta1", new()
{
    DomainName = "string",
    Locations = new[]
    {
        "string",
    },
    ReservedIpRange = "string",
    Admin = "string",
    AuditLogsEnabled = false,
    AuthorizedNetworks = new[]
    {
        "string",
    },
    Labels = 
    {
        { "string", "string" },
    },
    Project = "string",
});
Copy
example, err := managedidentitiesv1beta1.NewDomain(ctx, "exampledomainResourceResourceFromManagedidentitiesv1beta1", &managedidentitiesv1beta1.DomainArgs{
	DomainName: pulumi.String("string"),
	Locations: pulumi.StringArray{
		pulumi.String("string"),
	},
	ReservedIpRange:  pulumi.String("string"),
	Admin:            pulumi.String("string"),
	AuditLogsEnabled: pulumi.Bool(false),
	AuthorizedNetworks: pulumi.StringArray{
		pulumi.String("string"),
	},
	Labels: pulumi.StringMap{
		"string": pulumi.String("string"),
	},
	Project: pulumi.String("string"),
})
Copy
var exampledomainResourceResourceFromManagedidentitiesv1beta1 = new Domain("exampledomainResourceResourceFromManagedidentitiesv1beta1", DomainArgs.builder()
    .domainName("string")
    .locations("string")
    .reservedIpRange("string")
    .admin("string")
    .auditLogsEnabled(false)
    .authorizedNetworks("string")
    .labels(Map.of("string", "string"))
    .project("string")
    .build());
Copy
exampledomain_resource_resource_from_managedidentitiesv1beta1 = google_native.managedidentities.v1beta1.Domain("exampledomainResourceResourceFromManagedidentitiesv1beta1",
    domain_name="string",
    locations=["string"],
    reserved_ip_range="string",
    admin="string",
    audit_logs_enabled=False,
    authorized_networks=["string"],
    labels={
        "string": "string",
    },
    project="string")
Copy
const exampledomainResourceResourceFromManagedidentitiesv1beta1 = new google_native.managedidentities.v1beta1.Domain("exampledomainResourceResourceFromManagedidentitiesv1beta1", {
    domainName: "string",
    locations: ["string"],
    reservedIpRange: "string",
    admin: "string",
    auditLogsEnabled: false,
    authorizedNetworks: ["string"],
    labels: {
        string: "string",
    },
    project: "string",
});
Copy
type: google-native:managedidentities/v1beta1:Domain
properties:
    admin: string
    auditLogsEnabled: false
    authorizedNetworks:
        - string
    domainName: string
    labels:
        string: string
    locations:
        - string
    project: string
    reservedIpRange: string
Copy

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
This property is required.
Changes to this property will trigger replacement.
string
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
Locations This property is required. List<string>
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
ReservedIpRange This property is required. 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 [Domain].[authorized_networks].
Admin string
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
AuditLogsEnabled bool
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
AuthorizedNetworks List<string>
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
Labels Dictionary<string, string>
Optional. Resource labels that can contain user-provided metadata.
Project Changes to this property will trigger replacement. string
DomainName
This property is required.
Changes to this property will trigger replacement.
string
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
Locations This property is required. []string
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
ReservedIpRange This property is required. 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 [Domain].[authorized_networks].
Admin string
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
AuditLogsEnabled bool
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
AuthorizedNetworks []string
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
Labels map[string]string
Optional. Resource labels that can contain user-provided metadata.
Project Changes to this property will trigger replacement. string
domainName
This property is required.
Changes to this property will trigger replacement.
String
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
locations This property is required. List<String>
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
reservedIpRange This property is required. 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 [Domain].[authorized_networks].
admin String
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
auditLogsEnabled Boolean
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
authorizedNetworks List<String>
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
labels Map<String,String>
Optional. Resource labels that can contain user-provided metadata.
project Changes to this property will trigger replacement. String
domainName
This property is required.
Changes to this property will trigger replacement.
string
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
locations This property is required. string[]
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
reservedIpRange This property is required. 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 [Domain].[authorized_networks].
admin string
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
auditLogsEnabled boolean
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
authorizedNetworks string[]
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
labels {[key: string]: string}
Optional. Resource labels that can contain user-provided metadata.
project Changes to this property will trigger replacement. string
domain_name
This property is required.
Changes to this property will trigger replacement.
str
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
locations This property is required. Sequence[str]
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
reserved_ip_range This property is required. str
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 [Domain].[authorized_networks].
admin str
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
audit_logs_enabled bool
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
authorized_networks Sequence[str]
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
labels Mapping[str, str]
Optional. Resource labels that can contain user-provided metadata.
project Changes to this property will trigger replacement. str
domainName
This property is required.
Changes to this property will trigger replacement.
String
Required. A domain name, e.g. mydomain.myorg.com, with the following restrictions: * Must contain only lowercase letters, numbers, periods and hyphens. * Must start with a letter. * Must contain between 2-64 characters. * Must end with a number or a letter. * Must not start with period. * First segment length (mydomain form example above) shouldn't exceed 15 chars. * The last segment cannot be fully numeric. * Must be unique within the customer project.
locations This property is required. List<String>
Locations where domain needs to be provisioned. regions e.g. us-west1 or us-east4 Service supports up to 4 locations at once. Each location will use a /26 block.
reservedIpRange This property is required. 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 [Domain].[authorized_networks].
admin String
Optional. The name of delegated administrator account used to perform Active Directory operations. If not specified, setupadmin will be used.
auditLogsEnabled Boolean
Optional. Configuration for audit logs. True if audit logs are enabled, else false. Default is audit logs disabled.
authorizedNetworks List<String>
Optional. The full names of the Google Compute Engine networks the domain instance is connected to. Networks can be added using UpdateDomain. The domain is only available on networks listed in authorized_networks. If CIDR subnets overlap between networks, domain creation will fail.
labels Map<String>
Optional. Resource labels that can contain user-provided metadata.
project Changes to this property will trigger replacement. String

Outputs

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

CreateTime string
The time the instance was created.
Fqdn 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.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
State string
The current state of this domain.
StatusMessage string
Additional information about the current status of this domain, if available.
Trusts List<Pulumi.GoogleNative.Managedidentities.V1Beta1.Outputs.TrustResponse>
The current trusts associated with the domain.
UpdateTime string
The last update time.
CreateTime string
The time the instance was created.
Fqdn 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.
Id string
The provider-assigned unique ID for this managed resource.
Name string
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
State string
The current state of this domain.
StatusMessage string
Additional information about the current status of this domain, if available.
Trusts []TrustResponse
The current trusts associated with the domain.
UpdateTime string
The last update time.
createTime String
The time the instance was created.
fqdn 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.
id String
The provider-assigned unique ID for this managed resource.
name String
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
state String
The current state of this domain.
statusMessage String
Additional information about the current status of this domain, if available.
trusts List<TrustResponse>
The current trusts associated with the domain.
updateTime String
The last update time.
createTime string
The time the instance was created.
fqdn 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.
id string
The provider-assigned unique ID for this managed resource.
name string
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
state string
The current state of this domain.
statusMessage string
Additional information about the current status of this domain, if available.
trusts TrustResponse[]
The current trusts associated with the domain.
updateTime string
The last update time.
create_time str
The time the instance was created.
fqdn str
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.
id str
The provider-assigned unique ID for this managed resource.
name str
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
state str
The current state of this domain.
status_message str
Additional information about the current status of this domain, if available.
trusts Sequence[TrustResponse]
The current trusts associated with the domain.
update_time str
The last update time.
createTime String
The time the instance was created.
fqdn 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.
id String
The provider-assigned unique ID for this managed resource.
name String
The unique name of the domain using the form: projects/{project_id}/locations/global/domains/{domain_name}.
state String
The current state of this domain.
statusMessage String
Additional information about the current status of this domain, if available.
trusts List<Property Map>
The current trusts associated with the domain.
updateTime String
The last update time.

Supporting Types

TrustResponse
, TrustResponseArgs

CreateTime This property is required. string
The time the instance was created.
LastTrustHeartbeatTime This property is required. string
The last heartbeat time when the trust was known to be connected.
SelectiveAuthentication This property is required. bool
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
State This property is required. string
The current state of the trust.
StateDescription This property is required. string
Additional information about the current state of the trust, if available.
TargetDnsIpAddresses This property is required. List<string>
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
TargetDomainName This property is required. string
The fully qualified target domain name which will be in trust with the current domain.
TrustDirection This property is required. string
The trust direction, which decides if the current domain is trusted, trusting, or both.
TrustHandshakeSecret This property is required. string
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
TrustType This property is required. string
The type of trust represented by the trust resource.
UpdateTime This property is required. string
The last update time.
CreateTime This property is required. string
The time the instance was created.
LastTrustHeartbeatTime This property is required. string
The last heartbeat time when the trust was known to be connected.
SelectiveAuthentication This property is required. bool
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
State This property is required. string
The current state of the trust.
StateDescription This property is required. string
Additional information about the current state of the trust, if available.
TargetDnsIpAddresses This property is required. []string
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
TargetDomainName This property is required. string
The fully qualified target domain name which will be in trust with the current domain.
TrustDirection This property is required. string
The trust direction, which decides if the current domain is trusted, trusting, or both.
TrustHandshakeSecret This property is required. string
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
TrustType This property is required. string
The type of trust represented by the trust resource.
UpdateTime This property is required. string
The last update time.
createTime This property is required. String
The time the instance was created.
lastTrustHeartbeatTime This property is required. String
The last heartbeat time when the trust was known to be connected.
selectiveAuthentication This property is required. Boolean
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
state This property is required. String
The current state of the trust.
stateDescription This property is required. String
Additional information about the current state of the trust, if available.
targetDnsIpAddresses This property is required. List<String>
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
targetDomainName This property is required. String
The fully qualified target domain name which will be in trust with the current domain.
trustDirection This property is required. String
The trust direction, which decides if the current domain is trusted, trusting, or both.
trustHandshakeSecret This property is required. String
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
trustType This property is required. String
The type of trust represented by the trust resource.
updateTime This property is required. String
The last update time.
createTime This property is required. string
The time the instance was created.
lastTrustHeartbeatTime This property is required. string
The last heartbeat time when the trust was known to be connected.
selectiveAuthentication This property is required. boolean
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
state This property is required. string
The current state of the trust.
stateDescription This property is required. string
Additional information about the current state of the trust, if available.
targetDnsIpAddresses This property is required. string[]
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
targetDomainName This property is required. string
The fully qualified target domain name which will be in trust with the current domain.
trustDirection This property is required. string
The trust direction, which decides if the current domain is trusted, trusting, or both.
trustHandshakeSecret This property is required. string
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
trustType This property is required. string
The type of trust represented by the trust resource.
updateTime This property is required. string
The last update time.
create_time This property is required. str
The time the instance was created.
last_trust_heartbeat_time This property is required. str
The last heartbeat time when the trust was known to be connected.
selective_authentication This property is required. bool
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
state This property is required. str
The current state of the trust.
state_description This property is required. str
Additional information about the current state of the trust, if available.
target_dns_ip_addresses This property is required. Sequence[str]
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
target_domain_name This property is required. str
The fully qualified target domain name which will be in trust with the current domain.
trust_direction This property is required. str
The trust direction, which decides if the current domain is trusted, trusting, or both.
trust_handshake_secret This property is required. str
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
trust_type This property is required. str
The type of trust represented by the trust resource.
update_time This property is required. str
The last update time.
createTime This property is required. String
The time the instance was created.
lastTrustHeartbeatTime This property is required. String
The last heartbeat time when the trust was known to be connected.
selectiveAuthentication This property is required. Boolean
The trust authentication type, which decides whether the trusted side has forest/domain wide access or selective access to an approved set of resources.
state This property is required. String
The current state of the trust.
stateDescription This property is required. String
Additional information about the current state of the trust, if available.
targetDnsIpAddresses This property is required. List<String>
The target DNS server IP addresses which can resolve the remote domain involved in the trust.
targetDomainName This property is required. String
The fully qualified target domain name which will be in trust with the current domain.
trustDirection This property is required. String
The trust direction, which decides if the current domain is trusted, trusting, or both.
trustHandshakeSecret This property is required. String
Input only. The trust secret used for the handshake with the target domain. It will not be stored.
trustType This property is required. String
The type of trust represented by the trust resource.
updateTime This property is required. String
The last update time.

Package Details

Repository
Google Cloud Native pulumi/pulumi-google-native
License
Apache-2.0

Google Cloud Native is in preview. Google Cloud Classic is fully supported.

Google Cloud Native v0.32.0 published on Wednesday, Nov 29, 2023 by Pulumi