software.amazon.awscdk.services.appstream

Interface CfnDirectoryConfigProps

All Known Implementing Classes:

CfnDirectoryConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:35.436Z")
public interface CfnDirectoryConfigProps

Properties for defining a `CfnDirectoryConfig`.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.appstream.*;
 CfnDirectoryConfigProps cfnDirectoryConfigProps = CfnDirectoryConfigProps.builder()
         .directoryName("directoryName")
         .organizationalUnitDistinguishedNames(List.of("organizationalUnitDistinguishedNames"))
         .serviceAccountCredentials(ServiceAccountCredentialsProperty.builder()
                 .accountName("accountName")
                 .accountPassword("accountPassword")
                 .build())
         // the properties below are optional
         .certificateBasedAuthProperties(CertificateBasedAuthPropertiesProperty.builder()
                 .certificateAuthorityArn("certificateAuthorityArn")
                 .status("status")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	CfnDirectoryConfigProps.Builder A builder for CfnDirectoryConfigProps
static class	CfnDirectoryConfigProps.Jsii$Proxy An implementation for CfnDirectoryConfigProps

Method Summary

Modifier and Type	Method and Description
static CfnDirectoryConfigProps.Builder	builder()
default java.lang.Object	getCertificateBasedAuthProperties() The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
java.lang.String	getDirectoryName() The fully qualified name of the directory (for example, corp.example.com).
java.util.List<java.lang.String>	getOrganizationalUnitDistinguishedNames() The distinguished names of the organizational units for computer accounts.
java.lang.Object	getServiceAccountCredentials() The credentials for the service account used by the streaming instance to connect to the directory.

Method Detail

getDirectoryName

java.lang.String getDirectoryName()

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

getOrganizationalUnitDistinguishedNames

java.util.List<java.lang.String> getOrganizationalUnitDistinguishedNames()

The distinguished names of the organizational units for computer accounts.

getServiceAccountCredentials

java.lang.Object getServiceAccountCredentials()

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 .

getCertificateBasedAuthProperties

default java.lang.Object getCertificateBasedAuthProperties()

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

builder

static CfnDirectoryConfigProps.Builder builder()

Returns:

a CfnDirectoryConfigProps.Builder of CfnDirectoryConfigProps