Package software.amazon.awscdk.services.directoryservice

Interface CfnSimpleADProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnSimpleADProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.102.0 (build e354887)",
           date="2024-08-23T05:56:14.767Z")
@Stability(Stable)
public interface CfnSimpleADProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	CfnSimpleADProps.Builder	A builder for CfnSimpleADProps
static final class	CfnSimpleADProps.Jsii$Proxy	An implementation for CfnSimpleADProps

Method Summary

Modifier and Type	Method	Description
static CfnSimpleADProps.Builder	builder()
default Object	getCreateAlias()	If set to true , specifies an alias for a directory and assigns the alias to the directory.
default String	getDescription()	A description for the directory.
default Object	getEnableSso()	Whether to enable single sign-on for a directory.
String	getName()	The fully qualified name for the directory, such as corp.example.com .
default String	getPassword()	The password for the directory administrator.
default String	getShortName()	The NetBIOS name of the directory, such as CORP .
String	getSize()	The size of the directory.
Object	getVpcSettings()	A DirectoryVpcSettings object that contains additional information for the operation.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getName

@Stability(Stable)
@NotNull
String getName()

The fully qualified name for the directory, such as corp.example.com .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-name

getSize

@Stability(Stable)
@NotNull
String getSize()

The size of the directory.

For valid values, see CreateDirectory in the AWS Directory Service API Reference .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-size

getVpcSettings

@Stability(Stable)
@NotNull
Object getVpcSettings()

A DirectoryVpcSettings object that contains additional information for the operation.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-vpcsettings

getCreateAlias

@Stability(Stable)
@Nullable
default Object getCreateAlias()

If set to true , 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 to false .

After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-createalias

getDescription

@Stability(Stable)
@Nullable
default String getDescription()

A description for the directory.

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-description

getEnableSso

@Stability(Stable)
@Nullable
default Object 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-enablesso

getPassword

@Stability(Stable)
@Nullable
default String 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:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-password

getShortName

@Stability(Stable)
@Nullable
default String getShortName()

The NetBIOS name of the directory, such as CORP .

See Also:

• http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-directoryservice-simplead.html#cfn-directoryservice-simplead-shortname

builder

@Stability(Stable)
static CfnSimpleADProps.Builder builder()

Returns:

a CfnSimpleADProps.Builder of CfnSimpleADProps