DirectoryState class

Input properties used for looking up and filtering Directory resources.

Constructors

DirectoryState({Input<String?>? accessUrl, Input<String?>? alias, Input<DirectoryConnectSettings?>? connectSettings, Input<String?>? description, Input<int?>? desiredNumberOfDomainControllers, Input<List<String>?>? dnsIpAddresses, Input<String?>? edition, Input<bool?>? enableDirectoryDataAccess, Input<bool?>? enableSso, Input<String?>? name, Input<String?>? password, Input<String?>? region, Input<String?>? securityGroupId, Input<String?>? shortName, Input<String?>? size, Input<Map<String, String>?>? tags, Input<Map<String, String>?>? tagsAll, Input<String?>? type, Input<DirectoryVpcSettings?>? vpcSettings})
Creates a new DirectoryState. accessUrl The access URL for the directory, such as http://alias.awsapps.com. alias The alias for the directory (must be unique amongst all aliases in AWS). Required for enableSso. connectSettings Connector related information about the directory. Fields documented below. description A textual description for the directory. desiredNumberOfDomainControllers The number of domain controllers desired in the directory. Minimum value of 2. Scaling of domain controllers is only supported for MicrosoftAD directories. dnsIpAddresses A list of IP addresses of the DNS servers for the directory or connector. edition The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise. enableDirectoryDataAccess Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference. enableSso Whether to enable single-sign on for the directory. Requires alias. Defaults to false. name The fully qualified name for the directory, such as corp.example.com password The password for the directory administrator or connector user. region Region where this resource will be managed. Defaults to the Region set in the provider configuration. securityGroupId The ID of the security group created by the directory. shortName The short name of the directory, such as CORP. size (For SimpleAD and ADConnector types) The size of the directory (Small or Large are accepted values). Large by default. tags A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level. tagsAll A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block. type The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD. vpcSettings VPC related information about the directory. Fields documented below.
const
DirectoryState.fromMap(Map<String, dynamic> map)
factory

Properties

accessUrl → Input<String?>?
The access URL for the directory, such as http://alias.awsapps.com.
final
alias → Input<String?>?
The alias for the directory (must be unique amongst all aliases in AWS). Required for enableSso.
final
connectSettings → Input<DirectoryConnectSettings?>?
Connector related information about the directory. Fields documented below.
final
description → Input<String?>?
A textual description for the directory.
final
desiredNumberOfDomainControllers → Input<int?>?
The number of domain controllers desired in the directory. Minimum value of 2. Scaling of domain controllers is only supported for MicrosoftAD directories.
final
dnsIpAddresses → Input<List<String>?>?
A list of IP addresses of the DNS servers for the directory or connector.
final
edition → Input<String?>?
The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise.
final
enableDirectoryDataAccess → Input<bool?>?
Enables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.
final
enableSso → Input<bool?>?
Whether to enable single-sign on for the directory. Requires alias. Defaults to false.
final
hashCode → int
The hash code for this object.
no setterinherited
name → Input<String?>?
The fully qualified name for the directory, such as corp.example.com
final
password → Input<String?>?
The password for the directory administrator or connector user.
final
region → Input<String?>?
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
final
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
securityGroupId → Input<String?>?
The ID of the security group created by the directory.
final
shortName → Input<String?>?
The short name of the directory, such as CORP.
final
size → Input<String?>?
(For SimpleAD and ADConnector types) The size of the directory (Small or Large are accepted values). Large by default.
final
tags → Input<Map<String, String>?>?
A map of tags to assign to the resource. If configured with a provider defaultTags configuration block present, tags with matching keys will overwrite those defined at the provider-level.
final
tagsAll → Input<Map<String, String>?>?
A map of tags assigned to the resource, including those inherited from the provider defaultTags configuration block.
final
type → Input<String?>?
The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.
final
vpcSettings → Input<DirectoryVpcSettings?>?
VPC related information about the directory. Fields documented below.
final

Methods

noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
toMap() → Map<String, dynamic>
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited