Package software.amazon.awscdk.services.directoryservice

Class CfnMicrosoftAD

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.CfnMicrosoftAD
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.255Z") @Stability(Stable) public class CfnMicrosoftAD extends CfnResource implements IInspectable
A CloudFormation AWS::DirectoryService::MicrosoftAD.

The AWS::DirectoryService::MicrosoftAD resource specifies a Microsoft Active Directory in AWS so that your directory users and groups can access the AWS Management Console and AWS applications using their existing credentials. For more information, see AWS Managed Microsoft AD 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.*;
 CfnMicrosoftAD cfnMicrosoftAD = CfnMicrosoftAD.Builder.create(this, "MyCfnMicrosoftAD")
         .name("name")
         .password("password")
         .vpcSettings(VpcSettingsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 .vpcId("vpcId")
                 .build())
         // the properties below are optional
         .createAlias(false)
         .edition("edition")
         .enableSso(false)
         .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

    • CfnMicrosoftAD

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

    • CfnMicrosoftAD

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

    • CfnMicrosoftAD

      @Stability(Stable) public CfnMicrosoftAD(@NotNull Construct scope, @NotNull String id, @NotNull CfnMicrosoftADProps props)
      Create a new AWS::DirectoryService::MicrosoftAD.

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

    • getAttrDnsIpAddresses

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

    • getCfnProperties

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

    • getName

      @Stability(Stable) @NotNull public String getName()
      The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      The fully qualified domain name for the AWS Managed Microsoft AD directory, such as corp.example.com . This name will resolve inside your VPC only. It does not need to be publicly resolvable.

    • getPassword

      @Stability(Stable) @NotNull public String getPassword()
      The password for the default administrative user named Admin .

      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(@NotNull String value)
      The password for the default administrative user named Admin .

      If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .

    • getVpcSettings

      @Stability(Stable) @NotNull public Object getVpcSettings()
      Specifies the VPC settings of the Microsoft AD directory server in AWS .

    • setVpcSettings

      @Stability(Stable) public void setVpcSettings(@NotNull CfnMicrosoftAD.VpcSettingsProperty value)
      Specifies the VPC settings of the Microsoft AD directory server in AWS .

    • setVpcSettings

      @Stability(Stable) public void setVpcSettings(@NotNull IResolvable value)
      Specifies the VPC settings of the Microsoft AD directory server in AWS .

    • getCreateAlias

      @Stability(Stable) @Nullable public Object getCreateAlias()
      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, AWS CloudFormation does not create an alias.

      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)
      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, AWS CloudFormation does not create an alias.

      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)
      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, AWS CloudFormation does not create an alias.

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

    • getEdition

      @Stability(Stable) @Nullable public String getEdition()
      AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .

      Enterprise is the default.

    • setEdition

      @Stability(Stable) public void setEdition(@Nullable String value)
      AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .

      Enterprise is the default.

    • getEnableSso

      @Stability(Stable) @Nullable public Object getEnableSso()
      Whether to enable single sign-on for a Microsoft Active Directory in AWS .

      Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. 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 Microsoft Active Directory in AWS .

      Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. 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 Microsoft Active Directory in AWS .

      Single sign-on allows users in your directory to access certain AWS services from a computer joined to the directory without having to enter their credentials separately. If you don't specify a value, AWS CloudFormation disables single sign-on by default.

    • getShortName

      @Stability(Stable) @Nullable public String getShortName()
      The NetBIOS name for your domain, such as CORP .

      If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com .

    • setShortName

      @Stability(Stable) public void setShortName(@Nullable String value)
      The NetBIOS name for your domain, such as CORP .

      If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com .