Class: AWSCDK::AppStream::CfnDirectoryConfigProps

Inherits:
Jsii::Struct
  • Object
show all
Defined in:
app_stream/cfn_directory_config_props.rb

Overview

Properties for defining a CfnDirectoryConfig.

See Also:

Instance Attribute Summary collapse

Class Method Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(directory_name:, organizational_unit_distinguished_names:, service_account_credentials:, certificate_based_auth_properties: nil) ⇒ CfnDirectoryConfigProps

Returns a new instance of CfnDirectoryConfigProps.

Parameters:



13
14
15
16
17
18
19
20
21
22
 
# File 'app_stream/cfn_directory_config_props.rb', line 13

def initialize(directory_name:, organizational_unit_distinguished_names:, service_account_credentials:, certificate_based_auth_properties: nil)
  @directory_name = directory_name
  Jsii::Type.check_type(@directory_name, JSON.parse(Base64.strict_decode64("eyJwcmltaXRpdmUiOiJzdHJpbmcifQ==")), "directoryName")
  @organizational_unit_distinguished_names = organizational_unit_distinguished_names
  Jsii::Type.check_type(@organizational_unit_distinguished_names, JSON.parse(Base64.strict_decode64("eyJjb2xsZWN0aW9uIjp7ImVsZW1lbnR0eXBlIjp7InByaW1pdGl2ZSI6InN0cmluZyJ9LCJraW5kIjoiYXJyYXkifX0=")), "organizationalUnitDistinguishedNames")
  @service_account_credentials = .is_a?(Hash) ? ::AWSCDK::AppStream::CfnDirectoryConfig::ServiceAccountCredentialsProperty.new(**.transform_keys(&:to_sym)) : 
  Jsii::Type.check_type(@service_account_credentials, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRGlyZWN0b3J5Q29uZmlnLlNlcnZpY2VBY2NvdW50Q3JlZGVudGlhbHNQcm9wZXJ0eSJ9XX19")), "serviceAccountCredentials")
  @certificate_based_auth_properties = certificate_based_auth_properties.is_a?(Hash) ? ::AWSCDK::AppStream::CfnDirectoryConfig::CertificateBasedAuthPropertiesProperty.new(**certificate_based_auth_properties.transform_keys(&:to_sym)) : certificate_based_auth_properties
  Jsii::Type.check_type(@certificate_based_auth_properties, JSON.parse(Base64.strict_decode64("eyJ1bmlvbiI6eyJ0eXBlcyI6W3siZnFuIjoiYXdzLWNkay1saWIuSVJlc29sdmFibGUifSx7ImZxbiI6ImF3cy1jZGstbGliLmF3c19hcHBzdHJlYW0uQ2ZuRGlyZWN0b3J5Q29uZmlnLkNlcnRpZmljYXRlQmFzZWRBdXRoUHJvcGVydGllc1Byb3BlcnR5In1dfX0=")), "certificateBasedAuthProperties") unless @certificate_based_auth_properties.nil?
end

Instance Attribute Details

#certificate_based_auth_properties ⇒ AWSCDK::IResolvable, ... (readonly)

The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.

Returns:

See Also:



45
46
47
 
# File 'app_stream/cfn_directory_config_props.rb', line 45

def certificate_based_auth_properties
  @certificate_based_auth_properties
end

#directory_name ⇒ String (readonly)

The fully qualified name of the directory (for example, corp.example.com).

Returns:

  • (String)

See Also:



28
29
30
 
# File 'app_stream/cfn_directory_config_props.rb', line 28

def directory_name
  @directory_name
end

#organizational_unit_distinguished_names ⇒ Array<String> (readonly)

The distinguished names of the organizational units for computer accounts.

Returns:

  • (Array<String>)

See Also:



33
34
35
 
# File 'app_stream/cfn_directory_config_props.rb', line 33

def organizational_unit_distinguished_names
  @organizational_unit_distinguished_names
end

#service_account_credentials ⇒ AWSCDK::IResolvable, AWSCDK::AppStream::CfnDirectoryConfig::ServiceAccountCredentialsProperty (readonly)

The credentials for the service account used by the streaming instance to connect to the directory.

Do not use this parameter directly. Use ServiceAccountCredentials as an input parameter with no_echo as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .

Returns:

See Also:



40
41
42
 
# File 'app_stream/cfn_directory_config_props.rb', line 40

def 
  @service_account_credentials
end

Class Method Details

.jsii_properties ⇒ Object 



47
48
49
50
51
52
53
54
 
# File 'app_stream/cfn_directory_config_props.rb', line 47

def self.jsii_properties
  {
    :directory_name => "directoryName",
    :organizational_unit_distinguished_names => "organizationalUnitDistinguishedNames",
    :service_account_credentials => "serviceAccountCredentials",
    :certificate_based_auth_properties => "certificateBasedAuthProperties",
  }
end

Instance Method Details

#to_jsii ⇒ Object 



56
57
58
59
60
61
62
63
64
65
 
# File 'app_stream/cfn_directory_config_props.rb', line 56

def to_jsii
  result = {}
  result.merge!({
    "directoryName" => @directory_name,
    "organizationalUnitDistinguishedNames" => @organizational_unit_distinguished_names,
    "serviceAccountCredentials" => @service_account_credentials,
    "certificateBasedAuthProperties" => @certificate_based_auth_properties,
  })
  result.compact
end