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< ? dnsIpAddresses, Input<String> ?>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< ? tags, Input<String, String> ?>Map< ? tagsAll, Input<String, String> ?>String?> ? type, Input<DirectoryVpcSettings?> ? vpcSettings}) -
Creates a new DirectoryState.
accessUrlThe access URL for the directory, such ashttp://alias.awsapps.com.aliasThe alias for the directory (must be unique amongst all aliases in AWS). Required forenableSso.connectSettingsConnector related information about the directory. Fields documented below.descriptionA textual description for the directory.desiredNumberOfDomainControllersThe number of domain controllers desired in the directory. Minimum value of2. Scaling of domain controllers is only supported forMicrosoftADdirectories.dnsIpAddressesA list of IP addresses of the DNS servers for the directory or connector.editionThe MicrosoftAD edition (StandardorEnterprise). Defaults toEnterprise.enableDirectoryDataAccessEnables access to directory data via the Directory Service Data API for the specified directory. For more information, see Directory Service Data API Reference.enableSsoWhether to enable single-sign on for the directory. Requiresalias. Defaults tofalse.nameThe fully qualified name for the directory, such ascorp.example.compasswordThe password for the directory administrator or connector user.regionRegion where this resource will be managed. Defaults to the Region set in the provider configuration.securityGroupIdThe ID of the security group created by the directory.shortNameThe short name of the directory, such asCORP.size(ForSimpleADandADConnectortypes) The size of the directory (SmallorLargeare accepted values).Largeby default.tagsA map of tags to assign to the resource. If configured with a providerdefaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.tagsAllA map of tags assigned to the resource, including those inherited from the providerdefaultTagsconfiguration block.typeThe directory type (SimpleAD,ADConnectororMicrosoftADare accepted values). Defaults toSimpleAD.vpcSettingsVPC 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 forMicrosoftADdirectories.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 (
StandardorEnterprise). Defaults toEnterprise.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 tofalse.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.comfinal -
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
SimpleADandADConnectortypes) The size of the directory (SmallorLargeare accepted values).Largeby default.final -
A map of tags to assign to the resource. If configured with a provider
defaultTagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level.final -
A map of tags assigned to the resource, including those inherited from the provider
defaultTagsconfiguration block.final -
type
→ Input<
String?> ? -
The directory type (
SimpleAD,ADConnectororMicrosoftADare accepted values). Defaults toSimpleAD.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