Class CfnDirectoryConfig

java.lang.Object
software.amazon.jsii.JsiiObject
All Implemented Interfaces:
IConstruct, IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.84.0 (build 5404dcf)", date="2023-06-19T16:29:55.694Z") @Stability(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())
         // the properties below are optional
         .certificateBasedAuthProperties(CertificateBasedAuthPropertiesProperty.builder()
                 .certificateAuthorityArn("certificateAuthorityArn")
                 .status("status")
                 .build())
         .build();
 
  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String 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 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 Details

    • inspect

      @Stability(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(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(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource
    • getDirectoryName

      @Stability(Stable) @NotNull public String getDirectoryName()
      The fully qualified name of the directory (for example, corp.example.com).
    • setDirectoryName

      @Stability(Stable) public void setDirectoryName(@NotNull String value)
      The fully qualified name of the directory (for example, corp.example.com).
    • getOrganizationalUnitDistinguishedNames

      @Stability(Stable) @NotNull public List<String> getOrganizationalUnitDistinguishedNames()
      The distinguished names of the organizational units for computer accounts.
    • setOrganizationalUnitDistinguishedNames

      @Stability(Stable) public void setOrganizationalUnitDistinguishedNames(@NotNull List<String> value)
      The distinguished names of the organizational units for computer accounts.
    • getServiceAccountCredentials

      @Stability(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(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 .

    • 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 with noEcho as shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .

    • getCertificateBasedAuthProperties

      @Stability(Stable) @Nullable public 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

      @Stability(Stable) public void setCertificateBasedAuthProperties(@Nullable 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

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