software.amazon.awscdk.services.appstream

Class CfnDirectoryConfig

java.lang.Object

software.amazon.jsii.JsiiObject

software.constructs.Construct

software.amazon.awscdk.CfnElement

software.amazon.awscdk.CfnRefElement

software.amazon.awscdk.CfnResource

software.amazon.awscdk.services.appstream.CfnDirectoryConfig

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:36.624Z")
 @Stability(value=Stable)
public class CfnDirectoryConfig
extends CfnResource
implements IInspectable

A CloudFormation `AWS::AppStream::DirectoryConfig`.

The AWS::AppStream::DirectoryConfig resource specifies the configuration information required to join Amazon AppStream 2.0 fleets and image builders to Microsoft Active Directory domains.

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.*;
 CfnDirectoryConfig cfnDirectoryConfig = CfnDirectoryConfig.Builder.create(this, "MyCfnDirectoryConfig")
         .directoryName("directoryName")
         .organizationalUnitDistinguishedNames(List.of("organizationalUnitDistinguishedNames"))
         .serviceAccountCredentials(ServiceAccountCredentialsProperty.builder()
                 .accountName("accountName")
                 .accountPassword("accountPassword")
                 .build())
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnDirectoryConfig.Builder A fluent builder for CfnDirectoryConfig.
static interface	CfnDirectoryConfig.ServiceAccountCredentialsProperty The credentials for the service account used by the streaming instance to connect to the directory.

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface software.amazon.awscdk.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDirectoryConfig(software.constructs.Construct scope, String id, CfnDirectoryConfigProps props) Create a new `AWS::AppStream::DirectoryConfig`.
protected	CfnDirectoryConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDirectoryConfig(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected Map<String,Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setDirectoryName(String value) The fully qualified name of the directory (for example, corp.example.com).
void	setOrganizationalUnitDistinguishedNames(List<String> value) The distinguished names of the organizational units for computer accounts.
void	setServiceAccountCredentials(CfnDirectoryConfig.ServiceAccountCredentialsProperty value) The credentials for the service account used by the streaming instance to connect to the directory.
void	setServiceAccountCredentials(IResolvable value) The credentials for the service account used by the streaming instance to connect to the directory.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnDirectoryConfig

protected CfnDirectoryConfig(software.amazon.jsii.JsiiObjectRef objRef)

CfnDirectoryConfig

protected CfnDirectoryConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

CfnDirectoryConfig

@Stability(value=Stable)
public CfnDirectoryConfig(@NotNull
                                                   software.constructs.Construct scope,
                                                   @NotNull
                                                   String id,
                                                   @NotNull
                                                   CfnDirectoryConfigProps props)

Create a new `AWS::AppStream::DirectoryConfig`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

@Stability(value=Stable)
public void inspect(@NotNull
                                             TreeInspector inspector)

Examines the CloudFormation resource and discloses attributes.

Specified by:

inspect in interface IInspectable

Parameters:

inspector - - tree inspector to collect and process attributes. This parameter is required.

renderProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDirectoryName

@Stability(value=Stable)
 @NotNull
public String getDirectoryName()

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

setDirectoryName

@Stability(value=Stable)
public void setDirectoryName(@NotNull
                                                      String value)

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

getOrganizationalUnitDistinguishedNames

@Stability(value=Stable)
 @NotNull
public List<String> getOrganizationalUnitDistinguishedNames()

The distinguished names of the organizational units for computer accounts.

setOrganizationalUnitDistinguishedNames

@Stability(value=Stable)
public void setOrganizationalUnitDistinguishedNames(@NotNull
                                                                             List<String> value)

The distinguished names of the organizational units for computer accounts.

getServiceAccountCredentials

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

setServiceAccountCredentials

@Stability(value=Stable)
public void setServiceAccountCredentials(@NotNull
                                                                  CfnDirectoryConfig.ServiceAccountCredentialsProperty value)

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 .

setServiceAccountCredentials

@Stability(value=Stable)
public void setServiceAccountCredentials(@NotNull
                                                                  IResolvable value)

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 .