Class: AWSCDK::DirectoryService::CfnMicrosoftADProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
directory_service/cfn_microsoft_ad_props.rb

Overview

Properties for defining a CfnMicrosoftAD.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, password:, vpc_settings:, create_alias: nil, edition: nil, enable_sso: nil, short_name: nil) ⇒ CfnMicrosoftADProps

Returns a new instance of CfnMicrosoftADProps.

Parameters:

  • 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_settings (AWSCDK::IResolvable, AWSCDK::DirectoryService::CfnMicrosoftAD::VPCSettingsProperty) —

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

  • create_alias (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • edition (String, nil) (defaults to: nil) —

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

  • enable_sso (Boolean, AWSCDK::IResolvable, nil) (defaults to: nil) —

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

  • short_name (String, nil) (defaults to: nil) —

    The NetBIOS name for your domain, such as CORP .



16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 16

def initialize(name:, password:, vpc_settings:, create_alias: nil, edition: nil, enable_sso: nil, short_name: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password")
  @vpc_settings = vpc_settings.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnMicrosoftAD::VPCSettingsProperty.new(**vpc_settings.transform_keys(&:to_sym)) : vpc_settings
  Jsii::Type.check_type(@vpc_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kaXJlY3RvcnlzZXJ2aWNlLkNmbk1pY3Jvc29mdEFELlZwY1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "vpcSettings")
  @create_alias = create_alias
  Jsii::Type.check_type(@create_alias, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "createAlias") unless @create_alias.nil?
  @edition = edition
  Jsii::Type.check_type(@edition, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "edition") unless @edition.nil?
  @enable_sso = enable_sso
  Jsii::Type.check_type(@enable_sso, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableSso") unless @enable_sso.nil?
  @short_name = short_name
  Jsii::Type.check_type(@short_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shortName") unless @short_name.nil?
end

Instance Attribute Details

#create_alias ⇒ Boolean, ... (readonly)

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

Returns:

See Also:



58
59
60
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 58

def create_alias
  @create_alias
end

#edition ⇒ String? (readonly)

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

Enterprise is the default.

Returns:

  • (String, nil)

See Also:



65
66
67
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 65

def edition
  @edition
end

#enable_sso ⇒ Boolean, ... (readonly)

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, CloudFormation disables single sign-on by default.

Returns:

See Also:



72
73
74
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 72

def enable_sso
  @enable_sso
end

#name ⇒ String (readonly)

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)

See Also:



37
38
39
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 37

def name
  @name
end

#password ⇒ String (readonly)

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 Directory Service API Reference .

Returns:

  • (String)

See Also:



44
45
46
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 44

def password
  @password
end

#short_name ⇒ String? (readonly)

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 .

Returns:

  • (String, nil)

See Also:



79
80
81
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 79

def short_name
  @short_name
end

#vpc_settings ⇒ AWSCDK::IResolvable, AWSCDK::DirectoryService::CfnMicrosoftAD::VPCSettingsProperty (readonly)

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

Returns:

See Also:



49
50
51
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 49

def vpc_settings
  @vpc_settings
end

Class Method Details

.jsii_properties ⇒ Object 



81
82
83
84
85
86
87
88
89
90
91
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 81

def self.jsii_properties
  {
    :name => "name",
    :password => "password",
    :vpc_settings => "vpcSettings",
    :create_alias => "createAlias",
    :edition => "edition",
    :enable_sso => "enableSso",
    :short_name => "shortName",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



93
94
95
96
97
98
99
100
101
102
103
104
105
 
# File 'directory_service/cfn_microsoft_ad_props.rb', line 93

def to_jsii
  result = {}
  result.merge!({
    "name" => @name,
    "password" => @password,
    "vpcSettings" => @vpc_settings,
    "createAlias" => @create_alias,
    "edition" => @edition,
    "enableSso" => @enable_sso,
    "shortName" => @short_name,
  })
  result.compact
end