Class: AWSCDK::DirectoryService::CfnSimpleADProps

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

Overview

Properties for defining a CfnSimpleAD.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name:, size:, vpc_settings:, create_alias: nil, description: nil, enable_sso: nil, password: nil, short_name: nil, tags: nil) ⇒ CfnSimpleADProps

Returns a new instance of CfnSimpleADProps.

Parameters:

  • name (String) —

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

  • size (String) —

    The size of the directory.

  • vpc_settings (AWSCDK::IResolvable, AWSCDK::DirectoryService::CfnSimpleAD::VPCSettingsProperty) —

    A DirectoryVpcSettings object that contains additional information for the operation.

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

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

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

    A description for the directory.

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

    Whether to enable single sign-on for a directory.

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

    The password for the directory administrator.

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

    The NetBIOS name of the directory, such as CORP .

  • tags (Array<AWSCDK::CfnTag>, nil) (defaults to: nil) 


18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
 
# File 'directory_service/cfn_simple_ad_props.rb', line 18

def initialize(name:, size:, vpc_settings:, create_alias: nil, description: nil, enable_sso: nil, password: nil, short_name: nil, tags: nil)
  @name = name
  Jsii::Type.check_type(@name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "name")
  @size = size
  Jsii::Type.check_type(@size, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "size")
  @vpc_settings = vpc_settings.is_a?(Hash) ? ::AWSCDK::DirectoryService::CfnSimpleAD::VPCSettingsProperty.new(**vpc_settings.transform_keys(&:to_sym)) : vpc_settings
  Jsii::Type.check_type(@vpc_settings, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19kaXJlY3RvcnlzZXJ2aWNlLkNmblNpbXBsZUFELlZwY1NldHRpbmdzUHJvcGVydHkifV19fQ==")), "vpcSettings")
  @create_alias = create_alias
  Jsii::Type.check_type(@create_alias, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "createAlias") unless @create_alias.nil?
  @description = description
  Jsii::Type.check_type(@description, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "description") unless @description.nil?
  @enable_sso = enable_sso
  Jsii::Type.check_type(@enable_sso, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3sicHJpbWl0aXZlIjoiYm9vbGVhbiJ9LHsiZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifV19fQ==")), "enableSso") unless @enable_sso.nil?
  @password = password
  Jsii::Type.check_type(@password, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "password") unless @password.nil?
  @short_name = short_name
  Jsii::Type.check_type(@short_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "shortName") unless @short_name.nil?
  @tags = tags.is_a?(Array) ? tags.map { |jsii_v0| jsii_v0.is_a?(Hash) ? ::AWSCDK::CfnTag.new(**jsii_v0.transform_keys(&:to_sym)) : jsii_v0 } : tags
  Jsii::Type.check_type(@tags, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7ImZxbiI6ImF3cy1jZGstbGliLkNmblRhZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "tags") unless @tags.nil?
end

Instance Attribute Details

#create_alias ⇒ Boolean, ... (readonly)

If set to true , 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, this property is set to false .

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:



64
65
66
 
# File 'directory_service/cfn_simple_ad_props.rb', line 64

def create_alias
  @create_alias
end

#description ⇒ String? (readonly)

A description for the directory.

Returns:

  • (String, nil)

See Also:



69
70
71
 
# File 'directory_service/cfn_simple_ad_props.rb', line 69

def description
  @description
end

#enable_sso ⇒ Boolean, ... (readonly)

Whether to enable single sign-on for a directory.

If you don't specify a value, CloudFormation disables single sign-on by default.

Returns:

See Also:



76
77
78
 
# File 'directory_service/cfn_simple_ad_props.rb', line 76

def enable_sso
  @enable_sso
end

#name ⇒ String (readonly)

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

Returns:

  • (String)

See Also:



43
44
45
 
# File 'directory_service/cfn_simple_ad_props.rb', line 43

def name
  @name
end

#password ⇒ String? (readonly)

The password for the directory administrator.

The directory creation process creates a directory administrator account with the user name Administrator and this password.

If you need to change the password for the administrator account, see the ResetUserPassword API call in the Directory Service API Reference .

Returns:

  • (String, nil)

See Also:



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

def password
  @password
end

#short_name ⇒ String? (readonly)

The NetBIOS name of the directory, such as CORP .

Returns:

  • (String, nil)

See Also:



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

def short_name
  @short_name
end

#size ⇒ String (readonly)

The size of the directory.

For valid values, see CreateDirectory in the Directory Service API Reference .

Returns:

  • (String)

See Also:



50
51
52
 
# File 'directory_service/cfn_simple_ad_props.rb', line 50

def size
  @size
end

#tags ⇒ Array<AWSCDK::CfnTag>? (readonly)

Returns:

See Also:



93
94
95
 
# File 'directory_service/cfn_simple_ad_props.rb', line 93

def tags
  @tags
end

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

A DirectoryVpcSettings object that contains additional information for the operation.

Returns:

See Also:



55
56
57
 
# File 'directory_service/cfn_simple_ad_props.rb', line 55

def vpc_settings
  @vpc_settings
end

Class Method Details

.jsii_properties ⇒ Object 



95
96
97
98
99
100
101
102
103
104
105
106
107
 
# File 'directory_service/cfn_simple_ad_props.rb', line 95

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

Instance Method Details

#to_jsii ⇒ Object 



109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
 
# File 'directory_service/cfn_simple_ad_props.rb', line 109

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