Class CfnDirectoryConfig
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.
Implements
Inherited Members
Namespace: Amazon.CDK.AWS.AppStream
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnDirectoryConfig : CfnResource, IInspectable
Syntax (vb)
Public Class CfnDirectoryConfig
Inherits CfnResource
Implements IInspectable
Remarks
CloudformationResource: AWS::AppStream::DirectoryConfig
ExampleMetadata: fixture=_generated
Examples
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.AppStream;
var cfnDirectoryConfig = new CfnDirectoryConfig(this, "MyCfnDirectoryConfig", new CfnDirectoryConfigProps {
DirectoryName = "directoryName",
OrganizationalUnitDistinguishedNames = new [] { "organizationalUnitDistinguishedNames" },
ServiceAccountCredentials = new ServiceAccountCredentialsProperty {
AccountName = "accountName",
AccountPassword = "accountPassword"
},
// the properties below are optional
CertificateBasedAuthProperties = new CertificateBasedAuthPropertiesProperty {
CertificateAuthorityArn = "certificateAuthorityArn",
Status = "status"
}
});
Synopsis
Constructors
CfnDirectoryConfig(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnDirectoryConfig(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnDirectoryConfig(Construct, String, ICfnDirectoryConfigProps) |
Properties
CertificateBasedAuthProperties | The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. |
CFN_RESOURCE_TYPE_NAME | The CloudFormation resource type name for this resource class. |
CfnProperties | |
DirectoryName | The fully qualified name of the directory (for example, corp.example.com). |
OrganizationalUnitDistinguishedNames | The distinguished names of the organizational units for computer accounts. |
ServiceAccountCredentials | The credentials for the service account used by the streaming instance to connect to the directory. |
Methods
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnDirectoryConfig(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnDirectoryConfig(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnDirectoryConfig(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnDirectoryConfig(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnDirectoryConfig(Construct, String, ICfnDirectoryConfigProps)
public CfnDirectoryConfig(Construct scope, string id, ICfnDirectoryConfigProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnDirectoryConfigProps
Resource properties.
Properties
CertificateBasedAuthProperties
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
public virtual object CertificateBasedAuthProperties { get; set; }
Property Value
System.Object
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
DirectoryName
The fully qualified name of the directory (for example, corp.example.com).
public virtual string DirectoryName { get; set; }
Property Value
System.String
OrganizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts.
public virtual string[] OrganizationalUnitDistinguishedNames { get; set; }
Property Value
System.String[]
ServiceAccountCredentials
The credentials for the service account used by the streaming instance to connect to the directory.
public virtual object ServiceAccountCredentials { get; set; }
Property Value
System.Object
Methods
Inspect(TreeInspector)
Examines the CloudFormation resource and discloses attributes.
public virtual void Inspect(TreeInspector inspector)
Parameters
- inspector TreeInspector
tree inspector to collect and process attributes.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>