Interface CfnSimpleADProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnSimpleADProps.Jsii$Proxy
CfnSimpleAD
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.directoryservice.*; CfnSimpleADProps cfnSimpleADProps = CfnSimpleADProps.builder() .name("name") .size("size") .vpcSettings(VpcSettingsProperty.builder() .subnetIds(List.of("subnetIds")) .vpcId("vpcId") .build()) // the properties below are optional .createAlias(false) .description("description") .enableSso(false) .password("password") .shortName("shortName") .build();
- See Also:
-
Nested Class Summary
Nested ClassesModifier and TypeInterfaceDescriptionstatic final class
A builder forCfnSimpleADProps
static final class
An implementation forCfnSimpleADProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnSimpleADProps.Builder
builder()
default Object
If set totrue
, specifies an alias for a directory and assigns the alias to the directory.default String
A description for the directory.default Object
Whether to enable single sign-on for a directory.getName()
The fully qualified name for the directory, such ascorp.example.com
.default String
The password for the directory administrator.default String
The NetBIOS name of the directory, such asCORP
.getSize()
The size of the directory.A DirectoryVpcSettings object that contains additional information for the operation.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getName
The fully qualified name for the directory, such ascorp.example.com
.- See Also:
-
getSize
The size of the directory.For valid values, see CreateDirectory in the AWS Directory Service API Reference .
- See Also:
-
getVpcSettings
A DirectoryVpcSettings object that contains additional information for the operation.- See Also:
-
getCreateAlias
If set totrue
, specifies an alias for a directory and assigns the alias to the directory.The alias is used to construct the access URL for the directory, such as
http://<alias>.awsapps.com
. By default, this property is set tofalse
.After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- See Also:
-
getDescription
A description for the directory.- See Also:
-
getEnableSso
Whether to enable single sign-on for a directory.If you don't specify a value, AWS CloudFormation disables single sign-on by default.
- See Also:
-
getPassword
The password for the directory administrator.The directory creation process creates a directory administrator account with the user name
Administrator
and this password.If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .
- See Also:
-
getShortName
The NetBIOS name of the directory, such asCORP
.- See Also:
-
builder
- Returns:
- a
CfnSimpleADProps.Builder
ofCfnSimpleADProps
-