Package software.amazon.awscdk.services.directoryservice

Class CfnSimpleAD

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.directoryservice.CfnSimpleAD
All Implemented Interfaces:
IInspectable, ISimpleADRef, IEnvironmentAware, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.121.0 (build d7af9b9)", date="2025-12-18T18:20:08.253Z") @Stability(Stable) public class CfnSimpleAD extends CfnResource implements IInspectable, ISimpleADRef
The AWS::DirectoryService::SimpleAD resource specifies an Directory Service Simple Active Directory ( Simple AD ) in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials.

Simple AD is a Microsoft Active Directory–compatible directory. For more information, see Simple Active Directory in the Directory Service Admin Guide .

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.*;
 CfnSimpleAD cfnSimpleAD = CfnSimpleAD.Builder.create(this, "MyCfnSimpleAD")
         .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:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnSimpleAD

      protected CfnSimpleAD(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnSimpleAD

      protected CfnSimpleAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnSimpleAD

      @Stability(Stable) public CfnSimpleAD(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnSimpleADProps props)
      Create a new AWS::DirectoryService::SimpleAD.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForSimpleAD

      @Stability(Stable) @NotNull public static String arnForSimpleAD(@NotNull ISimpleADRef resource)
      Parameters:
      resource - This parameter is required.

    • fromDirectoryId

      @Stability(Stable) @NotNull public static ISimpleADRef fromDirectoryId(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull String directoryId)
      Creates a new ISimpleADRef from a directoryId.

      Parameters:
      scope - This parameter is required.
      id - This parameter is required.
      directoryId - This parameter is required.

    • isCfnSimpleAD

      @Stability(Stable) @NotNull public static Boolean isCfnSimpleAD(@NotNull Object x)
      Checks whether the given object is a CfnSimpleAD.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrAlias

      @Stability(Stable) @NotNull public String getAttrAlias()
      The alias for a directory.

      For example: alias4-mydirectory-12345abcgmzsk (if you have the CreateAlias property set to true).

    • getAttrDirectoryId

      @Stability(Stable) @NotNull public String getAttrDirectoryId()
      The directory ID.

      For example: d-12373a053a .

    • getAttrDnsIpAddresses

      @Stability(Stable) @NotNull public List<String> getAttrDnsIpAddresses()
      The IP addresses of the DNS servers for the directory, such as [ "172.31.3.154", "172.31.63.203" ] .

    • getAttrId

      @Stability(Stable) @NotNull public String getAttrId()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getSimpleAdRef

      @Stability(Stable) @NotNull public SimpleADReference getSimpleAdRef()
      A reference to a SimpleAD resource.
      Specified by:
      getSimpleAdRef in interface ISimpleADRef

    • getName

      @Stability(Stable) @NotNull public String getName()
      The fully qualified name for the directory, such as corp.example.com .

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The fully qualified name for the directory, such as corp.example.com .

    • getSize

      @Stability(Stable) @NotNull public String getSize()
      The size of the directory.

    • setSize

      @Stability(Stable) public void setSize(@NotNull String value)
      The size of the directory.

    • getVpcSettings

      @Stability(Stable) @NotNull public Object getVpcSettings()
      A DirectoryVpcSettings object that contains additional information for the operation.

      Returns union: either IResolvable or CfnSimpleAD.VpcSettingsProperty

    • setVpcSettings

      @Stability(Stable) public void setVpcSettings(@NotNull IResolvable value)
      A DirectoryVpcSettings object that contains additional information for the operation.

    • setVpcSettings

      @Stability(Stable) public void setVpcSettings(@NotNull CfnSimpleAD.VpcSettingsProperty value)
      A DirectoryVpcSettings object that contains additional information for the operation.

    • getCreateAlias

      @Stability(Stable) @Nullable public Object getCreateAlias()
      If set to true , specifies an alias for a directory and assigns the alias to the directory.

      Returns union: either Boolean or IResolvable

    • setCreateAlias

      @Stability(Stable) public void setCreateAlias(@Nullable Boolean value)
      If set to true , specifies an alias for a directory and assigns the alias to the directory.

    • setCreateAlias

      @Stability(Stable) public void setCreateAlias(@Nullable IResolvable value)
      If set to true , specifies an alias for a directory and assigns the alias to the directory.

    • getDescription

      @Stability(Stable) @Nullable public String getDescription()
      A description for the directory.

    • setDescription

      @Stability(Stable) public void setDescription(@Nullable String value)
      A description for the directory.

    • getEnableSso

      @Stability(Stable) @Nullable public Object getEnableSso()
      Whether to enable single sign-on for a directory.

      Returns union: either Boolean or IResolvable

    • setEnableSso

      @Stability(Stable) public void setEnableSso(@Nullable Boolean value)
      Whether to enable single sign-on for a directory.

    • setEnableSso

      @Stability(Stable) public void setEnableSso(@Nullable IResolvable value)
      Whether to enable single sign-on for a directory.

    • getPassword

      @Stability(Stable) @Nullable public String getPassword()
      The password for the directory administrator.

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      The password for the directory administrator.

    • getShortName

      @Stability(Stable) @Nullable public String getShortName()
      The NetBIOS name of the directory, such as CORP .

    • setShortName

      @Stability(Stable) public void setShortName(@Nullable String value)
      The NetBIOS name of the directory, such as CORP .