CfnMicrosoftAD
- class aws_cdk.aws_directoryservice.CfnMicrosoftAD(scope, id, *, name, password, vpc_settings, create_alias=None, edition=None, enable_sso=None, short_name=None)
Bases:
CfnResource
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 .- CloudformationResource:
AWS::DirectoryService::MicrosoftAD
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_directoryservice as directoryservice cfn_microsoft_aD = directoryservice.CfnMicrosoftAD(self, "MyCfnMicrosoftAD", name="name", password="password", vpc_settings=directoryservice.CfnMicrosoftAD.VpcSettingsProperty( subnet_ids=["subnetIds"], vpc_id="vpcId" ), # the properties below are optional create_alias=False, edition="edition", enable_sso=False, short_name="shortName" )
Create a new
AWS::DirectoryService::MicrosoftAD
.- Parameters:
scope (
Construct
) –scope in which this resource is defined.
id (
str
) –scoped id of the resource.
name (
str
) – The fully qualified domain name for the AWS Managed Microsoft AD directory, such ascorp.example.com
. This name will resolve inside your VPC only. It does not need to be publicly resolvable.password (
str
) – The password for the default administrative user namedAdmin
. If you need to change the password for the administrator account, see the ResetUserPassword API call in the AWS Directory Service API Reference .vpc_settings (
Union
[VpcSettingsProperty
,Dict
[str
,Any
],IResolvable
]) – Specifies the VPC settings of the Microsoft AD directory server in AWS .create_alias (
Union
[bool
,IResolvable
,None
]) – 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 ashttp://<alias>.awsapps.com
. By default, AWS CloudFormation does not create an alias. .. epigraph:: After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.edition (
Optional
[str
]) – AWS Managed Microsoft AD is available in two editions:Standard
andEnterprise
.Enterprise
is the default.enable_sso (
Union
[bool
,IResolvable
,None
]) – 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.short_name (
Optional
[str
]) – The NetBIOS name for your domain, such asCORP
. 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 DNScorp.example.com
.
Methods
- add_deletion_override(path)
Syntactic sugar for
addOverride(path, undefined)
.- Parameters:
path (
str
) – The path of the value to delete.- Return type:
None
- add_depends_on(target)
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.
- Parameters:
target (
CfnResource
) –- Return type:
None
- add_metadata(key, value)
Add a value to the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –value (
Any
) –
- See:
- Return type:
None
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.
- add_override(path, value)
Adds an override to the synthesized CloudFormation resource.
To add a property override, either use
addPropertyOverride
or prefixpath
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:
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"]) cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")
would add the overrides Example:
"Properties": { "GlobalSecondaryIndexes": [ { "Projection": { "NonKeyAttributes": [ "myattribute" ] ... } ... }, { "ProjectionType": "INCLUDE" ... }, ] ... }
The
value
argument toaddOverride
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.- Parameters:
path (
str
) –The path of the property, you can use dot notation to override values in complex types. Any intermdediate keys will be created as needed.
value (
Any
) –The value. Could be primitive or complex.
- Return type:
None
- add_property_deletion_override(property_path)
Adds an override that deletes the value of a property from the resource definition.
- Parameters:
property_path (
str
) – The path to the property.- Return type:
None
- add_property_override(property_path, value)
Adds an override to a resource property.
Syntactic sugar for
addOverride("Properties.<...>", value)
.- Parameters:
property_path (
str
) – The path of the property.value (
Any
) – The value.
- Return type:
None
- apply_removal_policy(policy=None, *, apply_to_update_replace_policy=None, default=None)
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
).- Parameters:
policy (
Optional
[RemovalPolicy
]) –apply_to_update_replace_policy (
Optional
[bool
]) – Apply the same deletion policy to the resource’s “UpdateReplacePolicy”. Default: truedefault (
Optional
[RemovalPolicy
]) – The default policy to apply in case the removal policy is not defined. Default: - Default value is resource specific. To determine the default value for a resoure, please consult that specific resource’s documentation.
- Return type:
None
- get_att(attribute_name)
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.- Parameters:
attribute_name (
str
) – The name of the attribute.- Return type:
- get_metadata(key)
Retrieve a value value from the CloudFormation Resource Metadata.
- Parameters:
key (
str
) –- See:
- Return type:
Any
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)
Examines the CloudFormation resource and discloses attributes.
- Parameters:
inspector (
TreeInspector
) –tree inspector to collect and process attributes.
- Return type:
None
- override_logical_id(new_logical_id)
Overrides the auto-generated logical ID with a specific ID.
- Parameters:
new_logical_id (
str
) – The new logical ID to use for this stack element.- Return type:
None
- to_string()
Returns a string representation of this construct.
- Return type:
str
- Returns:
a string representation of this resource
Attributes
- CFN_RESOURCE_TYPE_NAME = 'AWS::DirectoryService::MicrosoftAD'
- attr_alias
The alias for a directory.
For example:
d-12373a053a
oralias4-mydirectory-12345abcgmzsk
(if you have theCreateAlias
property set to true).- CloudformationAttribute:
Alias
- attr_dns_ip_addresses
The IP addresses of the DNS servers for the directory, such as
[ "192.0.2.1", "192.0.2.2" ]
.- CloudformationAttribute:
DnsIpAddresses
- cfn_options
Options for this resource, such as condition, update policy etc.
- cfn_resource_type
AWS resource type.
- create_alias
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. .. epigraph:After an alias has been created, it cannot be deleted or reused, so this operation should only be used when absolutely necessary.
- creation_stack
return:
the stack trace of the point where this Resource was created from, sourced from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most node +internal+ entries filtered.
- edition
Standard
andEnterprise
.Enterprise
is the default.- Link:
- Type:
AWS Managed Microsoft AD is available in two editions
- enable_sso
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.
- logical_id
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)
.- Returns:
the logical ID as a stringified token. This value will only get resolved during synthesis.
- name
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
The construct tree node associated with this construct.
- password
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 .
- ref
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 })
.
- short_name
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 DNScorp.example.com
.
- stack
The stack in which this element is defined.
CfnElements must be defined within a stack scope (directly or indirectly).
- vpc_settings
Specifies the VPC settings of the Microsoft AD directory server in AWS .
Static Methods
- classmethod is_cfn_element(x)
Returns
true
if a construct is a stack element (i.e. part of the synthesized cloudformation template).Uses duck-typing instead of
instanceof
to allow stack elements from different versions of this library to be included in the same stack.- Parameters:
x (
Any
) –- Return type:
bool
- Returns:
The construct as a stack element or undefined if it is not a stack element.
- classmethod is_cfn_resource(construct)
Check whether the given construct is a CfnResource.
- Parameters:
construct (
IConstruct
) –- Return type:
bool
- classmethod is_construct(x)
Return whether the given object is a Construct.
- Parameters:
x (
Any
) –- Return type:
bool
VpcSettingsProperty
- class CfnMicrosoftAD.VpcSettingsProperty(*, subnet_ids, vpc_id)
Bases:
object
Contains VPC information for the CreateDirectory or CreateMicrosoftAD operation.
- Parameters:
subnet_ids (
Sequence
[str
]) – The identifiers of the subnets for the directory servers. The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.vpc_id (
str
) – The identifier of the VPC in which to create the directory.
- Link:
- ExampleMetadata:
fixture=_generated
Example:
# The code below shows an example of how to instantiate this type. # The values are placeholders you should change. import aws_cdk.aws_directoryservice as directoryservice vpc_settings_property = directoryservice.CfnMicrosoftAD.VpcSettingsProperty( subnet_ids=["subnetIds"], vpc_id="vpcId" )
Attributes
- subnet_ids
The identifiers of the subnets for the directory servers.
The two subnets must be in different Availability Zones. AWS Directory Service specifies a directory server and a DNS server in each of these subnets.
- vpc_id
The identifier of the VPC in which to create the directory.