Package software.amazon.awscdk.services.appstream

Interface CfnDirectoryConfigProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnDirectoryConfigProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.98.0 (build 00b106d)",
           date="2024-05-08T21:35:02.799Z")
@Stability(Stable)
public interface CfnDirectoryConfigProps
extends software.amazon.jsii.JsiiSerializable

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();
 

See Also:

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

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static CfnDirectoryConfigProps.Builder	builder()
default 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.
String	getDirectoryName()	The fully qualified name of the directory (for example, corp.example.com).
List<String>	getOrganizationalUnitDistinguishedNames()	The distinguished names of the organizational units for computer accounts.
Object	getServiceAccountCredentials()	The credentials for the service account used by the streaming instance to connect to the directory.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getDirectoryName

@Stability(Stable)
@NotNull
String getDirectoryName()

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

See Also:

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

getOrganizationalUnitDistinguishedNames

@Stability(Stable)
@NotNull
List<String> getOrganizationalUnitDistinguishedNames()

The distinguished names of the organizational units for computer accounts.

See Also:

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

getServiceAccountCredentials

@Stability(Stable)
@NotNull
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 .

See Also:

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

getCertificateBasedAuthProperties

@Stability(Stable)
@Nullable
default 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.

See Also:

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

builder

@Stability(Stable)
static CfnDirectoryConfigProps.Builder builder()

Returns:

a CfnDirectoryConfigProps.Builder of CfnDirectoryConfigProps