class CfnMicrosoftAD (construct)
Language | Type name |
---|---|
![]() | Amazon.CDK.AWS.DirectoryService.CfnMicrosoftAD |
![]() | github.com/aws/aws-cdk-go/awscdk/v2/awsdirectoryservice#CfnMicrosoftAD |
![]() | software.amazon.awscdk.services.directoryservice.CfnMicrosoftAD |
![]() | aws_cdk.aws_directoryservice.CfnMicrosoftAD |
![]() | aws-cdk-lib » aws_directoryservice » CfnMicrosoftAD |
Implements
IConstruct
, IDependable
, IInspectable
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 { aws_directoryservice as directoryservice } from 'aws-cdk-lib';
const cfnMicrosoftAD = new directoryservice.CfnMicrosoftAD(this, 'MyCfnMicrosoftAD', {
name: 'name',
password: 'password',
vpcSettings: {
subnetIds: ['subnetIds'],
vpcId: 'vpcId',
},
// the properties below are optional
createAlias: false,
edition: 'edition',
enableSso: false,
shortName: 'shortName',
});
Initializer
new CfnMicrosoftAD(scope: Construct, id: string, props: CfnMicrosoftADProps)
Parameters
- scope
Construct
— Scope in which this resource is defined. - id
string
— Construct identifier for this resource (unique in its scope). - props
Cfn
— Resource properties.Microsoft ADProps
Construct Props
Name | Type | Description |
---|---|---|
name | string | 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. |
password | string | The password for the default administrative user named Admin . |
vpc | IResolvable | Vpc | Specifies the VPC settings of the Microsoft AD directory server in AWS . |
create | boolean | IResolvable | Specifies an alias for a directory and assigns the alias to the directory. |
edition? | string | AWS Managed Microsoft AD is available in two editions: Standard and Enterprise . |
enable | boolean | IResolvable | Whether to enable single sign-on for a Microsoft Active Directory in AWS . |
short | string | The NetBIOS name for your domain, such as CORP . |
name
Type:
string
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.
password
Type:
string
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 .
vpcSettings
Type:
IResolvable
|
Vpc
Specifies the VPC settings of the Microsoft AD directory server in AWS .
createAlias?
Type:
boolean |
IResolvable
(optional)
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.
edition?
Type:
string
(optional)
AWS Managed Microsoft AD is available in two editions: Standard
and Enterprise
.
Enterprise
is the default.
enableSso?
Type:
boolean |
IResolvable
(optional)
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.
shortName?
Type:
string
(optional)
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
.
Properties
Name | Type | Description |
---|---|---|
attr | string | The alias for a directory. |
attr | string[] | The IP addresses of the DNS servers for the directory, such as [ "192.0.2.1", "192.0.2.2" ] . |
attr | string | |
cfn | ICfn | Options for this resource, such as condition, update policy etc. |
cfn | { [string]: any } | |
cfn | string | AWS resource type. |
creation | string[] | |
logical | string | The logical ID for this CloudFormation stack element. |
name | string | 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. |
node | Node | The tree node. |
password | string | The password for the default administrative user named Admin . |
ref | string | Return a string that will be resolved to a CloudFormation { Ref } for this element. |
stack | Stack | The stack in which this element is defined. |
vpc | IResolvable | Vpc | Specifies the VPC settings of the Microsoft AD directory server in AWS . |
create | boolean | IResolvable | Specifies an alias for a directory and assigns the alias to the directory. |
edition? | string | AWS Managed Microsoft AD is available in two editions: Standard and Enterprise . |
enable | boolean | IResolvable | Whether to enable single sign-on for a Microsoft Active Directory in AWS . |
short | string | The NetBIOS name for your domain, such as CORP . |
static CFN_RESOURCE_TYPE_NAME | string | The CloudFormation resource type name for this resource class. |
attrAlias
Type:
string
The alias for a directory.
For example: d-12373a053a
or alias4-mydirectory-12345abcgmzsk
(if you have the CreateAlias
property set to true).
attrDnsIpAddresses
Type:
string[]
The IP addresses of the DNS servers for the directory, such as [ "192.0.2.1", "192.0.2.2" ]
.
attrId
Type:
string
cfnOptions
Type:
ICfn
Options for this resource, such as condition, update policy etc.
cfnProperties
Type:
{ [string]: any }
cfnResourceType
Type:
string
AWS resource type.
creationStack
Type:
string[]
logicalId
Type:
string
The logical ID for this CloudFormation stack element.
The logical ID of the element is calculated from the path of the resource node in the construct tree.
To override this value, use overrideLogicalId(newLogicalId)
.
name
Type:
string
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.
node
Type:
Node
The tree node.
password
Type:
string
The password for the default administrative user named Admin
.
ref
Type:
string
Return a string that will be resolved to a CloudFormation { Ref }
for this element.
If, by any chance, the intrinsic reference of a resource is not a string, you could
coerce it to an IResolvable through Lazy.any({ produce: resource.ref })
.
stack
Type:
Stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
vpcSettings
Type:
IResolvable
|
Vpc
Specifies the VPC settings of the Microsoft AD directory server in AWS .
createAlias?
Type:
boolean |
IResolvable
(optional)
Specifies an alias for a directory and assigns the alias to the directory.
edition?
Type:
string
(optional)
AWS Managed Microsoft AD is available in two editions: Standard
and Enterprise
.
enableSso?
Type:
boolean |
IResolvable
(optional)
Whether to enable single sign-on for a Microsoft Active Directory in AWS .
shortName?
Type:
string
(optional)
The NetBIOS name for your domain, such as CORP
.
static CFN_RESOURCE_TYPE_NAME
Type:
string
The CloudFormation resource type name for this resource class.
Methods
Name | Description |
---|---|
add | Syntactic sugar for addOverride(path, undefined) . |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. |
add | Add a value to the CloudFormation Resource Metadata. |
add | Adds an override to the synthesized CloudFormation resource. |
add | Adds an override that deletes the value of a property from the resource definition. |
add | Adds an override to a resource property. |
apply | Sets the deletion policy of the resource based on the removal policy specified. |
get | Returns a token for an runtime attribute of this resource. |
get | Retrieve a value value from the CloudFormation Resource Metadata. |
inspect(inspector) | Examines the CloudFormation resource and discloses attributes. |
obtain | Retrieves an array of resources this resource depends on. |
obtain | Get a shallow copy of dependencies between this resource and other resources in the same stack. |
override | Overrides the auto-generated logical ID with a specific ID. |
remove | Indicates that this resource no longer depends on another resource. |
replace | Replaces one dependency with another. |
to | Returns a string representation of this construct. |
protected render |
addDeletionOverride(path)
public addDeletionOverride(path: string): void
Parameters
- path
string
— The path of the value to delete.
Syntactic sugar for addOverride(path, undefined)
.
addDependency(target)
public addDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
This can be used for resources across stacks (or nested stack) boundaries and the dependency will automatically be transferred to the relevant scope.
addDependsOn(target)
public addDependsOn(target: CfnResource): void
⚠️ Deprecated: use addDependency
Parameters
- target
Cfn
Resource
Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.
addMetadata(key, value)
public addMetadata(key: string, value: any): void
Parameters
- key
string
- value
any
Add a value to the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
addOverride(path, value)
public addOverride(path: string, value: any): void
Parameters
- path
string
— - The path of the property, you can use dot notation to override values in complex types. - value
any
— - The value.
Adds an override to the synthesized CloudFormation resource.
To add a
property override, either use addPropertyOverride
or prefix path
with
"Properties." (i.e. Properties.TopicName
).
If the override is nested, separate each nested level using a dot (.) in the path parameter. If there is an array as part of the nesting, specify the index in the path.
To include a literal .
in the property name, prefix with a \
. In most
programming languages you will need to write this as "\\."
because the
\
itself will need to be escaped.
For example,
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']);
cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE');
would add the overrides
"Properties": {
"GlobalSecondaryIndexes": [
{
"Projection": {
"NonKeyAttributes": [ "myattribute" ]
...
}
...
},
{
"ProjectionType": "INCLUDE"
...
},
]
...
}
The value
argument to addOverride
will not be processed or translated
in any way. Pass raw JSON values in here with the correct capitalization
for CloudFormation. If you pass CDK classes or structs, they will be
rendered with lowercased key names, and CloudFormation will reject the
template.
addPropertyDeletionOverride(propertyPath)
public addPropertyDeletionOverride(propertyPath: string): void
Parameters
- propertyPath
string
— The path to the property.
Adds an override that deletes the value of a property from the resource definition.
addPropertyOverride(propertyPath, value)
public addPropertyOverride(propertyPath: string, value: any): void
Parameters
- propertyPath
string
— The path of the property. - value
any
— The value.
Adds an override to a resource property.
Syntactic sugar for addOverride("Properties.<...>", value)
.
applyRemovalPolicy(policy?, options?)
public applyRemovalPolicy(policy?: RemovalPolicy, options?: RemovalPolicyOptions): void
Parameters
- policy
Removal
Policy - options
Removal
Policy Options
Sets the deletion policy of the resource based on the removal policy specified.
The Removal Policy controls what happens to this resource when it stops being managed by CloudFormation, either because you've removed it from the CDK application or because you've made a change that requires the resource to be replaced.
The resource can be deleted (RemovalPolicy.DESTROY
), or left in your AWS
account for data recovery and cleanup later (RemovalPolicy.RETAIN
). In some
cases, a snapshot can be taken of the resource prior to deletion
(RemovalPolicy.SNAPSHOT
). A list of resources that support this policy
can be found in the following link:
getAtt(attributeName, typeHint?)
public getAtt(attributeName: string, typeHint?: ResolutionTypeHint): Reference
Parameters
- attributeName
string
— The name of the attribute. - typeHint
Resolution
Type Hint
Returns
Returns a token for an runtime attribute of this resource.
Ideally, use generated attribute accessors (e.g. resource.arn
), but this can be used for future compatibility
in case there is no generated attribute.
getMetadata(key)
public getMetadata(key: string): any
Parameters
- key
string
Returns
any
Retrieve a value value from the CloudFormation Resource Metadata.
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html
Note that this is a different set of metadata from CDK node metadata; this metadata ends up in the stack template under the resource, whereas CDK node metadata ends up in the Cloud Assembly.)
inspect(inspector)
public inspect(inspector: TreeInspector): void
Parameters
- inspector
Tree
— tree inspector to collect and process attributes.Inspector
Examines the CloudFormation resource and discloses attributes.
obtainDependencies()
public obtainDependencies(): Stack | CfnResource[]
Returns
Stack
|
Cfn
Resource []
Retrieves an array of resources this resource depends on.
This assembles dependencies on resources across stacks (including nested stacks) automatically.
obtainResourceDependencies()
public obtainResourceDependencies(): CfnResource[]
Returns
Get a shallow copy of dependencies between this resource and other resources in the same stack.
overrideLogicalId(newLogicalId)
public overrideLogicalId(newLogicalId: string): void
Parameters
- newLogicalId
string
— The new logical ID to use for this stack element.
Overrides the auto-generated logical ID with a specific ID.
removeDependency(target)
public removeDependency(target: CfnResource): void
Parameters
- target
Cfn
Resource
Indicates that this resource no longer depends on another resource.
This can be used for resources across stacks (including nested stacks) and the dependency will automatically be removed from the relevant scope.
replaceDependency(target, newTarget)
public replaceDependency(target: CfnResource, newTarget: CfnResource): void
Parameters
- target
Cfn
— The dependency to replace.Resource - newTarget
Cfn
— The new dependency to add.Resource
Replaces one dependency with another.
toString()
public toString(): string
Returns
string
Returns a string representation of this construct.
protected renderProperties(props)
protected renderProperties(props: { [string]: any }): { [string]: any }
Parameters
- props
{ [string]: any }
Returns
{ [string]: any }