Class: AWSCDK::DirectoryService::CfnSimpleAD

Inherits:
CfnResource
  • Object
show all
Includes:
IInspectable, ITaggableV2, Interfaces::AWSDirectoryservice::ISimpleADRef
Defined in:
directory_service/cfn_simple_ad.rb

Overview

The AWS::DirectoryService::SimpleAD resource specifies an 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 Directory Service Admin Guide .

See Also:

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(scope, id, props) ⇒ CfnSimpleAD

Create a new AWS::DirectoryService::SimpleAD.

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::CfnSimpleADProps) —

    Resource properties.



20
21
22
23
24
25
26
 
# File 'directory_service/cfn_simple_ad.rb', line 20

def initialize(scope, id, props)
  props = props.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnSimpleADProps.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("eyJmcW4iOiJhd3MtY2RrLWxpYi5hd3NfZGlyZWN0b3J5c2VydmljZS5DZm5TaW1wbGVBRFByb3BzIn0=")), "props")
  Jsii::Object.instance_method(:initialize).bind(self).call(scope, id, props)
end

Class Method Details

.arn_for_simple_ad(resource) ⇒ String

Parameters:

Returns:

  • (String) 


85
86
87
88
 
# File 'directory_service/cfn_simple_ad.rb', line 85

def self.arn_for_simple_ad(resource)
  Jsii::Type.check_type(resource, JSON.parse(Base64.strict_decode64("eyJmcW4iOiJhd3MtY2RrLWxpYi5pbnRlcmZhY2VzLmF3c19kaXJlY3RvcnlzZXJ2aWNlLklTaW1wbGVBRFJlZiJ9")), "resource")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_directoryservice.CfnSimpleAD", "arnForSimpleAD", [resource])
end

.CFN_RESOURCE_TYPE_NAME ⇒ String

The CloudFormation resource type name for this resource class.

Returns:

  • (String) 


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

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

.from_directory_id(scope, id, directory_id) ⇒ AWSCDK::Interfaces::AWSDirectoryservice::ISimpleADRef

Creates a new ISimpleADRef from a directoryId.

Parameters:

  • scope (Constructs::Construct)
  • id (String)
  • directory_id (String)

Returns:



96
97
98
99
100
101
 
# File 'directory_service/cfn_simple_ad.rb', line 96

def self.from_directory_id(scope, id, directory_id)
  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(directory_id, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryId")
  Jsii::Kernel.instance.call_static("aws-cdk-lib.aws_directoryservice.CfnSimpleAD", "fromDirectoryId", [scope, id, directory_id])
end

.is_cfn_simple_ad(x) ⇒ Boolean

Checks whether the given object is a CfnSimpleAD.

Parameters:

  • x (Object)

Returns:

  • (Boolean) 


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

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

.jsii_overridable_methods ⇒ Object 



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
77
78
79
80
81
 
# File 'directory_service/cfn_simple_ad.rb', line 28

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_directory_id => { kind: :property, name: "attrDirectoryId", is_optional: false },
    :attr_dns_ip_addresses => { kind: :property, name: "attrDnsIpAddresses", is_optional: false },
    :attr_id => { kind: :property, name: "attrId", is_optional: false },
    :cdk_tag_manager => { kind: :property, name: "cdkTagManager", is_optional: false },
    :simple_ad_ref => { kind: :property, name: "simpleAdRef", is_optional: false },
    :name => { kind: :property, name: "name", is_optional: false },
    :size => { kind: :property, name: "size", is_optional: false },
    :vpc_settings => { kind: :property, name: "vpcSettings", is_optional: false },
    :create_alias => { kind: :property, name: "createAlias", is_optional: true },
    :description => { kind: :property, name: "description", is_optional: true },
    :enable_sso => { kind: :property, name: "enableSso", is_optional: true },
    :password => { kind: :property, name: "password", is_optional: true },
    :short_name => { kind: :property, name: "shortName", is_optional: true },
    :tags => { kind: :property, name: "tags", 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.



397
398
399
400
 
# File 'directory_service/cfn_simple_ad.rb', line 397

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:



409
410
411
412
 
# File 'directory_service/cfn_simple_ad.rb', line 409

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:



419
420
421
422
 
# File 'directory_service/cfn_simple_ad.rb', line 419

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:



430
431
432
433
434
 
# File 'directory_service/cfn_simple_ad.rb', line 430

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.


487
488
489
490
491
 
# File 'directory_service/cfn_simple_ad.rb', line 487

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.



497
498
499
500
 
# File 'directory_service/cfn_simple_ad.rb', line 497

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.



509
510
511
512
513
 
# File 'directory_service/cfn_simple_ad.rb', line 509

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:



522
523
524
525
 
# File 'directory_service/cfn_simple_ad.rb', line 522

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:



544
545
546
547
548
549
 
# File 'directory_service/cfn_simple_ad.rb', line 544

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) 


214
215
216
 
# File 'directory_service/cfn_simple_ad.rb', line 214

def attr_alias()
  jsii_get_property("attrAlias")
end

#attr_directory_id ⇒ String

The directory ID.

For example: d-12373a053a .

Returns:

  • (String) 


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

def attr_directory_id()
  jsii_get_property("attrDirectoryId")
end

#attr_dns_ip_addresses ⇒ Array<String>

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

Returns:

  • (Array<String>) 


230
231
232
 
# File 'directory_service/cfn_simple_ad.rb', line 230

def attr_dns_ip_addresses()
  jsii_get_property("attrDnsIpAddresses")
end

#attr_id ⇒ String

Returns:

  • (String) 


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

def attr_id()
  jsii_get_property("attrId")
end

#cdk_tag_manager ⇒ AWSCDK::TagManager

Tag Manager which manages the tags for this resource.

Returns:



242
243
244
 
# File 'directory_service/cfn_simple_ad.rb', line 242

def cdk_tag_manager()
  jsii_get_property("cdkTagManager")
end

#cfn_options ⇒ AWSCDK::ICfnResourceOptions

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

Returns:



158
159
160
 
# File 'directory_service/cfn_simple_ad.rb', line 158

def cfn_options()
  jsii_get_property("cfnOptions")
end

#cfn_properties ⇒ Hash{String => Object}

Returns:

  • (Hash{String => Object}) 


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

def cfn_properties()
  jsii_get_property("cfnProperties")
end

#cfn_property_name(cdk_property_name) ⇒ String?

Parameters:

  • cdk_property_name (String)

Returns:

  • (String, nil) 


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

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


168
169
170
 
# File 'directory_service/cfn_simple_ad.rb', line 168

def cfn_property_names()
  jsii_get_property("cfnPropertyNames")
end

#cfn_resource_type ⇒ String

AWS resource type.

Returns:

  • (String) 


175
176
177
 
# File 'directory_service/cfn_simple_ad.rb', line 175

def cfn_resource_type()
  jsii_get_property("cfnResourceType")
end

#create_alias ⇒ Boolean, ...

If set to true , specifies an alias for a directory and assigns the alias to the directory.

Returns:



293
294
295
 
# File 'directory_service/cfn_simple_ad.rb', line 293

def create_alias()
  jsii_get_property("createAlias")
end

#create_alias=(value) ⇒ Object 



297
298
299
300
 
# File 'directory_service/cfn_simple_ad.rb', line 297

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


120
121
122
 
# File 'directory_service/cfn_simple_ad.rb', line 120

def creation_stack()
  jsii_get_property("creationStack")
end

#description ⇒ String?

A description for the directory.

Returns:

  • (String, nil) 


305
306
307
 
# File 'directory_service/cfn_simple_ad.rb', line 305

def description()
  jsii_get_property("description")
end

#description=(value) ⇒ Object 



309
310
311
312
 
# File 'directory_service/cfn_simple_ad.rb', line 309

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

#enable_sso ⇒ Boolean, ...

Whether to enable single sign-on for a directory.

Returns:



317
318
319
 
# File 'directory_service/cfn_simple_ad.rb', line 317

def enable_sso()
  jsii_get_property("enableSso")
end

#enable_sso=(value) ⇒ Object 



321
322
323
324
 
# File 'directory_service/cfn_simple_ad.rb', line 321

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:



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

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:



566
567
568
569
570
 
# File 'directory_service/cfn_simple_ad.rb', line 566

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:



577
578
579
580
 
# File 'directory_service/cfn_simple_ad.rb', line 577

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:



647
648
649
650
 
# File 'directory_service/cfn_simple_ad.rb', line 647

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) 


132
133
134
 
# File 'directory_service/cfn_simple_ad.rb', line 132

def logical_id()
  jsii_get_property("logicalId")
end

#name ⇒ String

The fully qualified name for the directory, such as corp.example.com .

Returns:

  • (String) 


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

def name()
  jsii_get_property("name")
end

#name=(value) ⇒ Object 



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

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) 


115
116
117
 
# File 'directory_service/cfn_simple_ad.rb', line 115

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:



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

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:



595
596
597
 
# File 'directory_service/cfn_simple_ad.rb', line 595

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.



388
389
390
391
 
# File 'directory_service/cfn_simple_ad.rb', line 388

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 directory administrator.

Returns:

  • (String, nil) 


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

def password()
  jsii_get_property("password")
end

#password=(value) ⇒ Object 



333
334
335
336
 
# File 'directory_service/cfn_simple_ad.rb', line 333

def password=(value)
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless value.nil?
  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) 


151
152
153
 
# File 'directory_service/cfn_simple_ad.rb', line 151

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:



606
607
608
609
 
# File 'directory_service/cfn_simple_ad.rb', line 606

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


613
614
615
616
 
# File 'directory_service/cfn_simple_ad.rb', line 613

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:



623
624
625
626
627
 
# File 'directory_service/cfn_simple_ad.rb', line 623

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 of the directory, such as CORP .

Returns:

  • (String, nil) 


341
342
343
 
# File 'directory_service/cfn_simple_ad.rb', line 341

def short_name()
  jsii_get_property("shortName")
end

#short_name=(value) ⇒ Object 



345
346
347
348
 
# File 'directory_service/cfn_simple_ad.rb', line 345

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.



632
633
634
 
# File 'directory_service/cfn_simple_ad.rb', line 632

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

#simple_ad_ref ⇒ AWSCDK::Interfaces::AWSDirectoryservice::SimpleADReference

A reference to a SimpleAD resource.

Returns:



249
250
251
 
# File 'directory_service/cfn_simple_ad.rb', line 249

def simple_ad_ref()
  jsii_get_property("simpleAdRef")
end

#size ⇒ String

The size of the directory.

Returns:

  • (String) 


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

def size()
  jsii_get_property("size")
end

#size=(value) ⇒ Object 



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

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

#stack ⇒ AWSCDK::Stack

The stack in which this element is defined.

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

Returns:



141
142
143
 
# File 'directory_service/cfn_simple_ad.rb', line 141

def stack()
  jsii_get_property("stack")
end

#tags ⇒ Array<AWSCDK::CfnTag>?

Returns:



351
352
353
 
# File 'directory_service/cfn_simple_ad.rb', line 351

def tags()
  jsii_get_property("tags")
end

#tags=(value) ⇒ Object 



355
356
357
358
359
 
# File 'directory_service/cfn_simple_ad.rb', line 355

def tags=(value)
  value = value.is_a?(Array) ? value.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless value.nil?
  jsii_set_property("tags", value)
end

#to_string ⇒ String

Returns a string representation of this construct.

Returns:

  • (String) —

    a string representation of this resource



364
365
366
 
# File 'directory_service/cfn_simple_ad.rb', line 364

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


188
189
190
 
# File 'directory_service/cfn_simple_ad.rb', line 188

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


198
199
200
 
# File 'directory_service/cfn_simple_ad.rb', line 198

def updated_properties()
  jsii_get_property("updatedProperties")
end

#validate_properties(_properties) ⇒ void

This method returns an undefined value.

Parameters:

  • _properties (Object) 


638
639
640
641
 
# File 'directory_service/cfn_simple_ad.rb', line 638

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::CfnSimpleAD::VPCSettingsProperty

A DirectoryVpcSettings object that contains additional information for the operation.

Returns:



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

def vpc_settings()
  jsii_get_property("vpcSettings")
end

#vpc_settings=(value) ⇒ Object 



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

def vpc_settings=(value)
  value = value.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnSimpleAD::VPCSettingsProperty.new(**value.transform_keys(&:to_sym)) : value
  Jsii::Type.check_type(value, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kaXJlY3RvcnlzZXJ2aWNlLkNmblNpbXBsZUFELlZwY1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "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) 


377
378
379
380
381
382
 
# File 'directory_service/cfn_simple_ad.rb', line 377

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