Class CfnDirectoryConfig
- All Implemented Interfaces:
IConstruct
,IDependable
,IInspectable
,software.amazon.jsii.JsiiSerializable
,software.constructs.IConstruct
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 ClassesModifier and TypeClassDescriptionstatic final class
A fluent builder forCfnDirectoryConfig
.static interface
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
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.core.IConstruct
IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.constructs.IConstruct
software.constructs.IConstruct.Jsii$Default
Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final String
The CloudFormation resource type name for this resource class. -
Constructor Summary
ConstructorsModifierConstructorDescriptionCfnDirectoryConfig
(Construct scope, String id, CfnDirectoryConfigProps props) Create a newAWS::AppStream::DirectoryConfig
.protected
CfnDirectoryConfig
(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) protected
CfnDirectoryConfig
(software.amazon.jsii.JsiiObjectRef objRef) -
Method Summary
Modifier and TypeMethodDescriptionThe certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.The fully qualified name of the directory (for example, corp.example.com).The distinguished names of the organizational units for computer accounts.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.renderProperties
(Map<String, Object> props) void
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.void
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
(String value) The fully qualified name of the directory (for example, corp.example.com).void
The distinguished names of the organizational units for computer accounts.void
The credentials for the service account used by the streaming instance to connect to the directory.void
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 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 Details
-
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
-
-
Constructor Details
-
CfnDirectoryConfig
protected CfnDirectoryConfig(software.amazon.jsii.JsiiObjectRef objRef) -
CfnDirectoryConfig
protected CfnDirectoryConfig(software.amazon.jsii.JsiiObject.InitializationMode initializationMode) -
CfnDirectoryConfig
@Stability(Stable) public CfnDirectoryConfig(@NotNull Construct scope, @NotNull String id, @NotNull CfnDirectoryConfigProps props) Create a newAWS::AppStream::DirectoryConfig
.- Parameters:
scope
-- scope in which this resource is defined.
id
-- scoped id of the resource.
props
-- resource properties.
-
-
Method Details
-
inspect
Examines the CloudFormation resource and discloses attributes.- Specified by:
inspect
in interfaceIInspectable
- Parameters:
inspector
-- tree inspector to collect and process attributes.
-
renderProperties
@Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String, Object> props) - Overrides:
renderProperties
in classCfnResource
- Parameters:
props
- This parameter is required.
-
getCfnProperties
- Overrides:
getCfnProperties
in classCfnResource
-
getDirectoryName
The fully qualified name of the directory (for example, corp.example.com). -
setDirectoryName
The fully qualified name of the directory (for example, corp.example.com). -
getOrganizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts. -
setOrganizationalUnitDistinguishedNames
The distinguished names of the organizational units for computer accounts. -
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 withnoEcho
as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates . -
setServiceAccountCredentials
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 withnoEcho
as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates . -
setServiceAccountCredentials
@Stability(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 withnoEcho
as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates . -
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
The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. -
setCertificateBasedAuthProperties
@Stability(Stable) public void setCertificateBasedAuthProperties(@Nullable 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.
-