CfnDirectoryConfigProps

class aws_cdk.aws_appstream.CfnDirectoryConfigProps(*, directory_name, organizational_unit_distinguished_names, service_account_credentials, certificate_based_auth_properties=None)

Bases: object

Properties for defining a CfnDirectoryConfig.

Parameters:

• directory_name (str) – The fully qualified name of the directory (for example, corp.example.com).

• organizational_unit_distinguished_names (Sequence[str]) – The distinguished names of the organizational units for computer accounts.

• service_account_credentials (Union[IResolvable, ServiceAccountCredentialsProperty, Dict[str, Any]]) – 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 noEcho as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .

• certificate_based_auth_properties (Union[IResolvable, CertificateBasedAuthPropertiesProperty, Dict[str, Any], None]) – The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html

ExampleMetadata:

fixture=_generated

Example:

# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
import aws_cdk.aws_appstream as appstream

cfn_directory_config_props = appstream.CfnDirectoryConfigProps(
    directory_name="directoryName",
    organizational_unit_distinguished_names=["organizationalUnitDistinguishedNames"],
    service_account_credentials=appstream.CfnDirectoryConfig.ServiceAccountCredentialsProperty(
        account_name="accountName",
        account_password="accountPassword"
    ),

    # the properties below are optional
    certificate_based_auth_properties=appstream.CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty(
        certificate_authority_arn="certificateAuthorityArn",
        status="status"
    )
)

Attributes

certificate_based_auth_properties

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-certificatebasedauthproperties

directory_name

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

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-directoryname

organizational_unit_distinguished_names

The distinguished names of the organizational units for computer accounts.

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-organizationalunitdistinguishednames

service_account_credentials

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 noEcho as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .

Link:

http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-appstream-directoryconfig.html#cfn-appstream-directoryconfig-serviceaccountcredentials