@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-14T16:25:21.040Z") public class CfnDirectoryConfig extends CfnResource implements IInspectable
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();
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.
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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.
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnDirectoryConfig(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnDirectoryConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnDirectoryConfig(Construct scope, java.lang.String id, CfnDirectoryConfigProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getDirectoryName()
public void setDirectoryName(java.lang.String value)
public java.util.List<java.lang.String> getOrganizationalUnitDistinguishedNames()
public void setOrganizationalUnitDistinguishedNames(java.util.List<java.lang.String> value)
public java.lang.Object getServiceAccountCredentials()
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 .
public void setServiceAccountCredentials(IResolvable value)
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 .
public void setServiceAccountCredentials(CfnDirectoryConfig.ServiceAccountCredentialsProperty value)
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 .
public java.lang.Object getCertificateBasedAuthProperties()
public void setCertificateBasedAuthProperties(IResolvable value)
public void setCertificateBasedAuthProperties(CfnDirectoryConfig.CertificateBasedAuthPropertiesProperty value)