software.amazon.awscdk.services.appstream

Class CfnDirectoryConfig

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.appstream.CfnDirectoryConfig

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-14T16:25:21.040Z")
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())
         // the properties below are optional
         .certificateBasedAuthProperties(CertificateBasedAuthPropertiesProperty.builder()
                 .certificateAuthorityArn("certificateAuthorityArn")
                 .status("status")
                 .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.CertificateBasedAuthPropertiesProperty The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
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 interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnDirectoryConfig(Construct scope, java.lang.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
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.
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
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.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setCertificateBasedAuthProperties(CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty value) The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
void	setCertificateBasedAuthProperties(IResolvable value) The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
void	setDirectoryName(java.lang.String value) The fully qualified name of the directory (for example, corp.example.com).
void	setOrganizationalUnitDistinguishedNames(java.util.List<java.lang.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.core.CfnResource

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

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

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

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.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

public CfnDirectoryConfig(Construct scope,
                          java.lang.String id,
                          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

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getDirectoryName

public java.lang.String getDirectoryName()

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

setDirectoryName

public void setDirectoryName(java.lang.String value)

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

getOrganizationalUnitDistinguishedNames

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

The distinguished names of the organizational units for computer accounts.

setOrganizationalUnitDistinguishedNames

public void setOrganizationalUnitDistinguishedNames(java.util.List<java.lang.String> value)

The distinguished names of the organizational units for computer accounts.

getServiceAccountCredentials

public 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 .

setServiceAccountCredentials

public void setServiceAccountCredentials(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 .

setServiceAccountCredentials

public void setServiceAccountCredentials(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 .

getCertificateBasedAuthProperties

public 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.

setCertificateBasedAuthProperties

public void setCertificateBasedAuthProperties(IResolvable value)

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

setCertificateBasedAuthProperties

public void setCertificateBasedAuthProperties(CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty value)

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