Package software.amazon.awscdk.services.directoryservice

Class CfnSimpleAD

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.core.Construct
software.amazon.awscdk.core.CfnElement
software.amazon.awscdk.core.CfnRefElement
software.amazon.awscdk.core.CfnResource
software.amazon.awscdk.services.directoryservice.CfnSimpleAD
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct
@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:56.260Z") @Stability(Stable) public class CfnSimpleAD extends CfnResource implements IInspectable
A CloudFormation AWS::DirectoryService::SimpleAD.

The AWS::DirectoryService::SimpleAD resource specifies an AWS 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 AWS 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();

  • 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 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 -
      • scoped id of the resource.
      This parameter is required.
      props -
      • resource properties.
      This parameter is required.

  • Method Details

    • 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: d-12373a053a or alias4-mydirectory-12345abcgmzsk (if you have the CreateAlias property set to true).

    • getAttrDirectoryId

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

    • 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" ] .

    • getCfnProperties

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

    • 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.

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

    • setSize

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

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

    • getVpcSettings

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

    • 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.

      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.

    • 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.

      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.

    • 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.

      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.

    • 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.

      If you don't specify a value, AWS CloudFormation disables single sign-on by default.

    • setEnableSso

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

      If you don't specify a value, AWS CloudFormation disables single sign-on by default.

    • setEnableSso

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

      If you don't specify a value, AWS CloudFormation disables single sign-on by default.

    • getPassword

      @Stability(Stable) @Nullable public 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 .

    • setPassword

      @Stability(Stable) public void setPassword(@Nullable String value)
      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 .

    • 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 .