CfnSimpleAD (software.amazon.awscdk:aws-cdk-lib 2.42.1 API)

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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:37.927Z")
 @Stability(value=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")
         .password("password")
         .size("size")
         .vpcSettings(VpcSettingsProperty.builder()
                 .subnetIds(List.of("subnetIds"))
                 .vpcId("vpcId")
                 .build())
         // the properties below are optional
         .createAlias(false)
         .description("description")
         .enableSso(false)
         .shortName("shortName")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static class`	`CfnSimpleAD.Builder` A fluent builder for `CfnSimpleAD`.
`static interface`	`CfnSimpleAD.VpcSettingsProperty` Contains VPC information for the [CreateDirectory](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateDirectory.html) or [CreateMicrosoftAD](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_CreateMicrosoftAD.html) operation.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnSimpleAD(software.constructs.Construct scope, String id, CfnSimpleADProps props)` Create a new `AWS::DirectoryService::SimpleAD`.
`protected`	`CfnSimpleAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnSimpleAD(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`getAttrAlias()` The alias for a directory.
`List<String>`	`getAttrDnsIpAddresses()` The IP addresses of the DNS servers for the directory, such as `[ "172.31.3.154", "172.31.63.203" ]` .
`protected Map<String,Object>`	`getCfnProperties()`
`Object`	`getCreateAlias()` If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
`String`	`getDescription()` A description for the directory.
`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` .
`String`	`getPassword()` The password for the directory administrator.
`String`	`getShortName()` The NetBIOS name of the directory, such as `CORP` .
`String`	`getSize()` The size of the directory.
`Object`	`getVpcSettings()` A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected Map<String,Object>`	`renderProperties(Map<String,Object> props)`
`void`	`setCreateAlias(Boolean value)` If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
`void`	`setCreateAlias(IResolvable value)` If set to `true` , specifies an alias for a directory and assigns the alias to the directory.
`void`	`setDescription(String value)` A description for the directory.
`void`	`setEnableSso(Boolean value)` Whether to enable single sign-on for a directory.
`void`	`setEnableSso(IResolvable value)` Whether to enable single sign-on for a directory.
`void`	`setName(String value)` The fully qualified name for the directory, such as `corp.example.com` .
`void`	`setPassword(String value)` The password for the directory administrator.
`void`	`setShortName(String value)` The NetBIOS name of the directory, such as `CORP` .
`void`	`setSize(String value)` The size of the directory.
`void`	`setVpcSettings(CfnSimpleAD.VpcSettingsProperty value)` A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
`void`	`setVpcSettings(IResolvable value)` A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.

Methods inherited from class software.amazon.awscdk.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct
getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnSimpleAD
```
protected CfnSimpleAD(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnSimpleAD
```
protected CfnSimpleAD(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnSimpleAD
```
@Stability(value=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 - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
@Stability(value=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(value=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(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getName
```
@Stability(value=Stable)
 @NotNull
public String getName()
```
    The fully qualified name for the directory, such as `corp.example.com` .
  - setName
```
@Stability(value=Stable)
public void setName(@NotNull
                                             String value)
```
    The fully qualified name for the directory, such as `corp.example.com` .
  - getPassword
```
@Stability(value=Stable)
 @NotNull
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(value=Stable)
public void setPassword(@NotNull
                                                 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 .
  - getSize
```
@Stability(value=Stable)
 @NotNull
public String getSize()
```
    The size of the directory.
    For valid values, see CreateDirectory in the AWS Directory Service API Reference .
  - setSize
```
@Stability(value=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(value=Stable)
 @NotNull
public Object getVpcSettings()
```
    A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
  - setVpcSettings
```
@Stability(value=Stable)
public void setVpcSettings(@NotNull
                                                    CfnSimpleAD.VpcSettingsProperty value)
```
    A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
  - setVpcSettings
```
@Stability(value=Stable)
public void setVpcSettings(@NotNull
                                                    IResolvable value)
```
    A [DirectoryVpcSettings](https://docs.aws.amazon.com/directoryservice/latest/devguide/API_DirectoryVpcSettings.html) object that contains additional information for the operation.
  - getCreateAlias
```
@Stability(value=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(value=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(value=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(value=Stable)
 @Nullable
public String getDescription()
```
    A description for the directory.
  - setDescription
```
@Stability(value=Stable)
public void setDescription(@Nullable
                                                    String value)
```
    A description for the directory.
  - getEnableSso
```
@Stability(value=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(value=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(value=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.
  - getShortName
```
@Stability(value=Stable)
 @Nullable
public String getShortName()
```
    The NetBIOS name of the directory, such as `CORP` .
  - setShortName
```
@Stability(value=Stable)
public void setShortName(@Nullable
                                                  String value)
```
    The NetBIOS name of the directory, such as `CORP` .

Class CfnSimpleAD

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

Nested classes/interfaces inherited from interface software.constructs.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.CfnResource

Methods inherited from class software.amazon.awscdk.CfnRefElement

Methods inherited from class software.amazon.awscdk.CfnElement

Methods inherited from class software.constructs.Construct

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.jsii.JsiiSerializable

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnSimpleAD

CfnSimpleAD

CfnSimpleAD

Method Detail

inspect

renderProperties

getAttrAlias

getAttrDnsIpAddresses

getCfnProperties

getName

setName

getPassword

setPassword

getSize

setSize

getVpcSettings

setVpcSettings

setVpcSettings

getCreateAlias

setCreateAlias

setCreateAlias

getDescription

setDescription

getEnableSso

setEnableSso

setEnableSso

getShortName

setShortName