Class: AWSCDK::DirectoryService::CfnMicrosoftAD

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, Interfaces::AWSDirectoryservice::IMicrosoftADRef
Defined in:
directory_service/cfn_microsoft_ad.rb

Overview

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 Directory Service Admin Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnMicrosoftAD

Create a new AWS::DirectoryService::MicrosoftAD.

Parameters:

  • scope (Constructs::Construct) —

    Scope in which this resource is defined.

  • id (String) —

    Construct identifier for this resource (unique in its scope).

  • props (AWSCDK::DirectoryService::CfnMicrosoftADProps) —

    Resource properties.



19
20
21
22
23
24
25
 
# File 'directory_service/cfn_microsoft_ad.rb', line 19

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnMicrosoftADProps.new(**props.transform_keys(&:to_sym)) : props
  Jsii::Type.check_type(scope, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLkNvbnN0cnVjdCJ9")), "scope")
  Jsii::Type.check_type(id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "id")
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGlyZWN0b3J5c2VydmljZS5DZm5NaWNyb3NvZnRBRFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


180
181
182
 
# File 'directory_service/cfn_microsoft_ad.rb', line 180

def self.CFN_RESOURCE_TYPE_NAME()
  Jsii::Kernel.instance.get_static("aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD", "CFN_RESOURCE_TYPE_NAME")
end

.is_cfn_microsoft_ad(x) ⇒ Boolean

Checks whether the given object is a CfnMicrosoftAD.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


82
83
84
85
 
# File 'directory_service/cfn_microsoft_ad.rb', line 82

def self.is_cfn_microsoft_ad(x)
  Jsii::Type.check_type(x, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "x")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_directoryservice.CfnMicrosoftAD", "isCfnMicrosoftAD", [x])
end

.jsii_overridable_methods ⇒ Object 



27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
 
# File 'directory_service/cfn_microsoft_ad.rb', line 27

def self.jsii_overridable_methods
  {
    :node => { kind: :property, name: "node", is_optional: false },
    :creation_stack => { kind: :property, name: "creationStack", is_optional: false },
    :logical_id => { kind: :property, name: "logicalId", is_optional: false },
    :stack => { kind: :property, name: "stack", is_optional: false },
    :ref => { kind: :property, name: "ref", is_optional: false },
    :cfn_options => { kind: :property, name: "cfnOptions", is_optional: false },
    :cfn_properties => { kind: :property, name: "cfnProperties", is_optional: false },
    :cfn_property_names => { kind: :property, name: "cfnPropertyNames", is_optional: false },
    :cfn_resource_type => { kind: :property, name: "cfnResourceType", is_optional: false },
    :env => { kind: :property, name: "env", is_optional: false },
    :updated_properites => { kind: :property, name: "updatedProperites", is_optional: false },
    :updated_properties => { kind: :property, name: "updatedProperties", is_optional: false },
    :attr_alias => { kind: :property, name: "attrAlias", is_optional: false },
    :attr_dns_ip_addresses => { kind: :property, name: "attrDnsIpAddresses", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :microsoft_ad_ref => { kind: :property, name: "microsoftAdRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :password => { kind: :property, name: "password", is_optional: false },
    :vpc_settings => { kind: :property, name: "vpcSettings", is_optional: false },
    :create_alias => { kind: :property, name: "createAlias", is_optional: true },
    :edition => { kind: :property, name: "edition", is_optional: true },
    :enable_sso => { kind: :property, name: "enableSso", is_optional: true },
    :short_name => { kind: :property, name: "shortName", is_optional: true },
    :to_string => { kind: :method, name: "toString", is_optional: false },
    :with => { kind: :method, name: "with", is_optional: false },
    :override_logical_id => { kind: :method, name: "overrideLogicalId", is_optional: false },
    :add_deletion_override => { kind: :method, name: "addDeletionOverride", is_optional: false },
    :add_dependency => { kind: :method, name: "addDependency", is_optional: false },
    :add_depends_on => { kind: :method, name: "addDependsOn", is_optional: false },
    :add_metadata => { kind: :method, name: "addMetadata", is_optional: false },
    :add_override => { kind: :method, name: "addOverride", is_optional: false },
    :add_property_deletion_override => { kind: :method, name: "addPropertyDeletionOverride", is_optional: false },
    :add_property_override => { kind: :method, name: "addPropertyOverride", is_optional: false },
    :apply_cross_stack_reference_strength => { kind: :method, name: "applyCrossStackReferenceStrength", is_optional: false },
    :apply_removal_policy => { kind: :method, name: "applyRemovalPolicy", is_optional: false },
    :cfn_property_name => { kind: :method, name: "cfnPropertyName", is_optional: false },
    :get_att => { kind: :method, name: "getAtt", is_optional: false },
    :get_metadata => { kind: :method, name: "getMetadata", is_optional: false },
    :obtain_dependencies => { kind: :method, name: "obtainDependencies", is_optional: false },
    :obtain_resource_dependencies => { kind: :method, name: "obtainResourceDependencies", is_optional: false },
    :remove_dependency => { kind: :method, name: "removeDependency", is_optional: false },
    :render_properties => { kind: :method, name: "renderProperties", is_optional: false },
    :replace_dependency => { kind: :method, name: "replaceDependency", is_optional: false },
    :should_synthesize => { kind: :method, name: "shouldSynthesize", is_optional: false },
    :validate_properties => { kind: :method, name: "validateProperties", is_optional: false },
    :inspect => { kind: :method, name: "inspect", is_optional: false },
  }
end

Instance Method Details

#add_deletion_override(path) ⇒ void

This method returns an undefined value.

Syntactic sugar for addOverride(path, undefined).

Parameters:

  • path (String) —

    The path of the value to delete.



337
338
339
340
 
# File 'directory_service/cfn_microsoft_ad.rb', line 337

def add_deletion_override(path)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  jsii_call_method("addDeletionOverride", [path])
end

#add_dependency(target) ⇒ void

This method returns an undefined value.

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:



349
350
351
352
 
# File 'directory_service/cfn_microsoft_ad.rb', line 349

def add_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependency", [target])
end

#add_depends_on(target) ⇒ void

Deprecated.

use addDependency

This method returns an undefined value.

Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned.

Parameters:



359
360
361
362
 
# File 'directory_service/cfn_microsoft_ad.rb', line 359

def add_depends_on(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("addDependsOn", [target])
end

#add_metadata(key, value) ⇒ void

This method returns an undefined value.

Add a value to the CloudFormation Resource Metadata.

Parameters:

  • key (String)
  • value (Object)

See Also:



370
371
372
373
374
 
# File 'directory_service/cfn_microsoft_ad.rb', line 370

def add_metadata(key, value)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addMetadata", [key, value])
end

#add_override(path, value) ⇒ void

This method returns an undefined value.

Adds an override to the synthesized CloudFormation resource.

To add a property override, either use add_property_override 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,

# Example automatically generated from non-compiling source. May contain errors.
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes", ["myattribute"])
cfn_resource.add_override("Properties.GlobalSecondaryIndexes.1.ProjectionType", "INCLUDE")

would add the overrides

"Properties": {
  "GlobalSecondaryIndexes": [
    {
      "Projection": {
        "NonKeyAttributes": [ "myattribute" ]
        ...
      }
      ...
    },
    {
      "ProjectionType": "INCLUDE"
      ...
    },
  ]
  ...
}

The value argument to add_override 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 (String) —
    • The path of the property, you can use dot notation to override values in complex types.
  • value (Object) —
    • The value.


427
428
429
430
431
 
# File 'directory_service/cfn_microsoft_ad.rb', line 427

def add_override(path, value)
  Jsii::Type.check_type(path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "path")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addOverride", [path, value])
end

#add_property_deletion_override(property_path) ⇒ void

This method returns an undefined value.

Adds an override that deletes the value of a property from the resource definition.

Parameters:

  • property_path (String) —

    The path to the property.



437
438
439
440
 
# File 'directory_service/cfn_microsoft_ad.rb', line 437

def add_property_deletion_override(property_path)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  jsii_call_method("addPropertyDeletionOverride", [property_path])
end

#add_property_override(property_path, value) ⇒ void

This method returns an undefined value.

Adds an override to a resource property.

Syntactic sugar for addOverride("Properties.<...>", value).

Parameters:

  • property_path (String) —

    The path of the property.

  • value (Object) —

    The value.



449
450
451
452
453
 
# File 'directory_service/cfn_microsoft_ad.rb', line 449

def add_property_override(property_path, value)
  Jsii::Type.check_type(property_path, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "propertyPath")
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "value")
  jsii_call_method("addPropertyOverride", [property_path, value])
end

#apply_cross_stack_reference_strength(strength) ⇒ void

This method returns an undefined value.

Sets the cross-stack reference strength for this resource.

When set, any cross-stack reference to this resource will use the specified strength instead of the global default from the consuming stack's context.

Parameters:



462
463
464
465
 
# File 'directory_service/cfn_microsoft_ad.rb', line 462

def apply_cross_stack_reference_strength(strength)
  Jsii::Type.check_type(strength, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZWZlcmVuY2VTdHJlbmd0aCJ9")), "strength")
  jsii_call_method("applyCrossStackReferenceStrength", [strength])
end

#apply_removal_policy(policy = nil, options = nil) ⇒ void

This method returns an undefined value.

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:

Parameters:

See Also:



484
485
486
487
488
489
 
# File 'directory_service/cfn_microsoft_ad.rb', line 484

def apply_removal_policy(policy = nil, options = nil)
  Jsii::Type.check_type(policy, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5In0=")), "policy") unless policy.nil?
  options = options.is_a?(Hash) ? ::AWSCDK::RemovalPolicyOptions.new(**options.transform_keys(&:to_sym)) : options
  Jsii::Type.check_type(options, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZW1vdmFsUG9saWN5T3B0aW9ucyJ9")), "options") unless options.nil?
  jsii_call_method("applyRemovalPolicy", [policy, options])
end

#attr_alias ⇒ String

The alias for a directory.

For example: alias4-mydirectory-12345abcgmzsk (if you have the CreateAlias property set to true).

Returns:

  • (String) 


189
190
191
 
# File 'directory_service/cfn_microsoft_ad.rb', line 189

def attr_alias()
  jsii_get_property("attrAlias")
end

#attr_dns_ip_addresses ⇒ Array<String>

The IP addresses of the DNS servers for the directory, such as [ "192.0.2.1", "192.0.2.2" ] .

Returns:

  • (Array<String>) 


196
197
198
 
# File 'directory_service/cfn_microsoft_ad.rb', line 196

def attr_dns_ip_addresses()
  jsii_get_property("attrDnsIpAddresses")
end

#attr_id ⇒ String

The directory ID.

For example: d-12373a053a .

Returns:

  • (String) 


205
206
207
 
# File 'directory_service/cfn_microsoft_ad.rb', line 205

def attr_id()
  jsii_get_property("attrId")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

Options for this resource, such as condition, update policy etc.

Returns:



133
134
135
 
# File 'directory_service/cfn_microsoft_ad.rb', line 133

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


138
139
140
 
# File 'directory_service/cfn_microsoft_ad.rb', line 138

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


493
494
495
496
 
# File 'directory_service/cfn_microsoft_ad.rb', line 493

def cfn_property_name(cdk_property_name)
  Jsii::Type.check_type(cdk_property_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "cdkPropertyName")
  jsii_call_method("cfnPropertyName", [cdk_property_name])
end

#cfn_property_names ⇒ Hash{String => String}

Returns:

  • (Hash{String => String}) 


143
144
145
 
# File 'directory_service/cfn_microsoft_ad.rb', line 143

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


150
151
152
 
# File 'directory_service/cfn_microsoft_ad.rb', line 150

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#create_alias ⇒ Boolean, ...

Specifies an alias for a directory and assigns the alias to the directory.

Returns:



256
257
258
 
# File 'directory_service/cfn_microsoft_ad.rb', line 256

def create_alias()
  jsii_get_property("createAlias")
end

#create_alias=(value) ⇒ Object 



260
261
262
263
 
# File 'directory_service/cfn_microsoft_ad.rb', line 260

def create_alias=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "createAlias") unless value.nil?
  jsii_set_property("createAlias", value)
end

#creation_stack ⇒ Array<String>

Returns:

  • (Array<String>) 


95
96
97
 
# File 'directory_service/cfn_microsoft_ad.rb', line 95

def creation_stack()
  jsii_get_property("creationStack")
end

#edition ⇒ String?

AWS Managed Microsoft AD is available in two editions: Standard and Enterprise .

Returns:

  • (String, nil) 


268
269
270
 
# File 'directory_service/cfn_microsoft_ad.rb', line 268

def edition()
  jsii_get_property("edition")
end

#edition=(value) ⇒ Object 



272
273
274
275
 
# File 'directory_service/cfn_microsoft_ad.rb', line 272

def edition=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "edition") unless value.nil?
  jsii_set_property("edition", value)
end

#enable_sso ⇒ Boolean, ...

Whether to enable single sign-on for a Microsoft Active Directory in AWS .

Returns:



280
281
282
 
# File 'directory_service/cfn_microsoft_ad.rb', line 280

def enable_sso()
  jsii_get_property("enableSso")
end

#enable_sso=(value) ⇒ Object 



284
285
286
287
 
# File 'directory_service/cfn_microsoft_ad.rb', line 284

def enable_sso=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableSso") unless value.nil?
  jsii_set_property("enableSso", value)
end

#env ⇒ AWSCDK::Interfaces::ResourceEnvironment

Returns:



155
156
157
 
# File 'directory_service/cfn_microsoft_ad.rb', line 155

def env()
  jsii_get_property("env")
end

#get_att(attribute_name, type_hint = nil) ⇒ AWSCDK::Reference

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:

Returns:



506
507
508
509
510
 
# File 'directory_service/cfn_microsoft_ad.rb', line 506

def get_att(attribute_name, type_hint = nil)
  Jsii::Type.check_type(attribute_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "attributeName")
  Jsii::Type.check_type(type_hint, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5SZXNvbHV0aW9uVHlwZUhpbnQifQ==")), "typeHint") unless type_hint.nil?
  jsii_call_method("getAtt", [attribute_name, type_hint])
end

#get_metadata(key) ⇒ Object

Retrieve a value value from the CloudFormation Resource Metadata.

Parameters:

  • key (String)

Returns:

  • (Object)

See Also:



517
518
519
520
 
# File 'directory_service/cfn_microsoft_ad.rb', line 517

def get_metadata(key)
  Jsii::Type.check_type(key, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "key")
  jsii_call_method("getMetadata", [key])
end

#inspect(inspector) ⇒ void

This method returns an undefined value.

Examines the CloudFormation resource and discloses attributes.

Parameters:



587
588
589
590
 
# File 'directory_service/cfn_microsoft_ad.rb', line 587

def inspect(inspector)
  Jsii::Type.check_type(inspector, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5UcmVlSW5zcGVjdG9yIn0=")), "inspector")
  jsii_call_method("inspect", [inspector])
end

#logical_id ⇒ 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 override_logical_id(new_logical_id).

Returns:

  • (String) 


107
108
109
 
# File 'directory_service/cfn_microsoft_ad.rb', line 107

def logical_id()
  jsii_get_property("logicalId")
end

#microsoft_ad_ref ⇒ AWSCDK::Interfaces::AWSDirectoryservice::MicrosoftADReference

A reference to a MicrosoftAD resource.

Returns:



212
213
214
 
# File 'directory_service/cfn_microsoft_ad.rb', line 212

def microsoft_ad_ref()
  jsii_get_property("microsoftAdRef")
end

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

Returns:

  • (String) 


219
220
221
 
# File 'directory_service/cfn_microsoft_ad.rb', line 219

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



223
224
225
226
 
# File 'directory_service/cfn_microsoft_ad.rb', line 223

def name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  jsii_set_property("name", value)
end

#node ⇒ Constructs::Node

The tree node.

Returns:

  • (Constructs::Node) 


90
91
92
 
# File 'directory_service/cfn_microsoft_ad.rb', line 90

def node()
  jsii_get_property("node")
end

#obtain_dependencies ⇒ Array<AWSCDK::CfnResource, AWSCDK::Stack>

Retrieves an array of resources this resource depends on.

This assembles dependencies on resources across stacks (including nested stacks) automatically.

Returns:



528
529
530
 
# File 'directory_service/cfn_microsoft_ad.rb', line 528

def obtain_dependencies()
  jsii_call_method("obtainDependencies", [])
end

#obtain_resource_dependencies ⇒ Array<AWSCDK::CfnResource>

Get a shallow copy of dependencies between this resource and other resources in the same stack.

Returns:



535
536
537
 
# File 'directory_service/cfn_microsoft_ad.rb', line 535

def obtain_resource_dependencies()
  jsii_call_method("obtainResourceDependencies", [])
end

#override_logical_id(new_logical_id) ⇒ void

This method returns an undefined value.

Overrides the auto-generated logical ID with a specific ID.

Parameters:

  • new_logical_id (String) —

    The new logical ID to use for this stack element.



328
329
330
331
 
# File 'directory_service/cfn_microsoft_ad.rb', line 328

def override_logical_id(new_logical_id)
  Jsii::Type.check_type(new_logical_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "newLogicalId")
  jsii_call_method("overrideLogicalId", [new_logical_id])
end

#password ⇒ String

The password for the default administrative user named Admin .

Returns:

  • (String) 


231
232
233
 
# File 'directory_service/cfn_microsoft_ad.rb', line 231

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



235
236
237
238
 
# File 'directory_service/cfn_microsoft_ad.rb', line 235

def password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password")
  jsii_set_property("password", value)
end

#ref ⇒ 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 }).

Returns:

  • (String) 


126
127
128
 
# File 'directory_service/cfn_microsoft_ad.rb', line 126

def ref()
  jsii_get_property("ref")
end

#remove_dependency(target) ⇒ void

This method returns an undefined value.

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.

Parameters:



546
547
548
549
 
# File 'directory_service/cfn_microsoft_ad.rb', line 546

def remove_dependency(target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  jsii_call_method("removeDependency", [target])
end

#render_properties(props) ⇒ Hash{String => Object}

Parameters:

  • props (Hash{String => Object})

Returns:

  • (Hash{String => Object}) 


553
554
555
556
 
# File 'directory_service/cfn_microsoft_ad.rb', line 553

def render_properties(props)
  Jsii::Type.check_type(props, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6ImFueSJ9LCJraW5kIjoibWFwIn19")), "props")
  jsii_call_method("renderProperties", [props])
end

#replace_dependency(target, new_target) ⇒ void

This method returns an undefined value.

Replaces one dependency with another.

Parameters:



563
564
565
566
567
 
# File 'directory_service/cfn_microsoft_ad.rb', line 563

def replace_dependency(target, new_target)
  Jsii::Type.check_type(target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "target")
  Jsii::Type.check_type(new_target, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5DZm5SZXNvdXJjZSJ9")), "newTarget")
  jsii_call_method("replaceDependency", [target, new_target])
end

#short_name ⇒ String?

The NetBIOS name for your domain, such as CORP .

Returns:

  • (String, nil) 


292
293
294
 
# File 'directory_service/cfn_microsoft_ad.rb', line 292

def short_name()
  jsii_get_property("shortName")
end

#short_name=(value) ⇒ Object 



296
297
298
299
 
# File 'directory_service/cfn_microsoft_ad.rb', line 296

def short_name=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shortName") unless value.nil?
  jsii_set_property("shortName", value)
end

#should_synthesize ⇒ Boolean

Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template.

Returns:

  • (Boolean) —

    true if the resource should be included or false is the resource should be omitted.



572
573
574
 
# File 'directory_service/cfn_microsoft_ad.rb', line 572

def should_synthesize()
  jsii_call_method("shouldSynthesize", [])
end

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

CfnElements must be defined within a stack scope (directly or indirectly).

Returns:



116
117
118
 
# File 'directory_service/cfn_microsoft_ad.rb', line 116

def stack()
  jsii_get_property("stack")
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



304
305
306
 
# File 'directory_service/cfn_microsoft_ad.rb', line 304

def to_string()
  jsii_call_method("toString", [])
end

#updated_properites ⇒ Hash{String => Object}

Deprecated.

use updatedProperties Return properties modified after initiation Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Deprecated.

Returns:

  • (Hash{String => Object}) 


163
164
165
 
# File 'directory_service/cfn_microsoft_ad.rb', line 163

def updated_properites()
  jsii_get_property("updatedProperites")
end

#updated_properties ⇒ Hash{String => Object}

Return properties modified after initiation.

Resources that expose mutable properties should override this function to collect and return the properties object for this resource.

Returns:

  • (Hash{String => Object}) 


173
174
175
 
# File 'directory_service/cfn_microsoft_ad.rb', line 173

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


578
579
580
581
 
# File 'directory_service/cfn_microsoft_ad.rb', line 578

def validate_properties(_properties)
  Jsii::Type.check_type(_properties, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJhbnkifQ==")), "_properties")
  jsii_call_method("validateProperties", [_properties])
end

#vpc_settings ⇒ AWSCDK::IResolvable, AWSCDK::DirectoryService::CfnMicrosoftAD::VPCSettingsProperty

Specifies the VPC settings of the Microsoft AD directory server in AWS .

Returns:



243
244
245
 
# File 'directory_service/cfn_microsoft_ad.rb', line 243

def vpc_settings()
  jsii_get_property("vpcSettings")
end

#vpc_settings=(value) ⇒ Object 



247
248
249
250
251
 
# File 'directory_service/cfn_microsoft_ad.rb', line 247

def vpc_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnMicrosoftAD::VPCSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kaXJlY3RvcnlzZXJ2aWNlLkNmbk1pY3Jvc29mdEFELlZwY1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "vpcSettings")
  jsii_set_property("vpcSettings", value)
end

#with(*mixins) ⇒ Constructs::IConstruct

Applies one or more mixins to this construct.

Mixins are applied in order. The list of constructs is captured at the start of the call, so constructs added by a mixin will not be visited. Use multiple with() calls if subsequent mixins should apply to added constructs.

Parameters:

  • mixins (Array<Constructs::IMixin>)

Returns:

  • (Constructs::IConstruct) 


317
318
319
320
321
322
 
# File 'directory_service/cfn_microsoft_ad.rb', line 317

def with(*mixins)
  mixins.each_with_index do |item, index|
    Jsii::Type.check_type(item, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJjb25zdHJ1Y3RzLklNaXhpbiJ9")), "mixins[#{index}]")
  end
  jsii_call_method("with", [*mixins])
end