Docs Packages
  1. Packages
  2. AWS Native
  3. API Docs
  4. appstream
  5. getDirectoryConfig

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

aws-native.appstream.getDirectoryConfig

Explore with Pulumi AI

aws-native logo

AWS Native is in preview. AWS Classic is fully supported.

AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
pulumi/pulumi-aws-native

    Resource Type definition for AWS::AppStream::DirectoryConfig

    Using getDirectoryConfig

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getDirectoryConfig(args: GetDirectoryConfigArgs, opts?: InvokeOptions): Promise<GetDirectoryConfigResult>
function getDirectoryConfigOutput(args: GetDirectoryConfigOutputArgs, opts?: InvokeOptions): Output<GetDirectoryConfigResult>
    def get_directory_config(directory_name: Optional[str] = None,
                         opts: Optional[InvokeOptions] = None) -> GetDirectoryConfigResult
def get_directory_config_output(directory_name: Optional[pulumi.Input[str]] = None,
                         opts: Optional[InvokeOptions] = None) -> Output[GetDirectoryConfigResult]
    func LookupDirectoryConfig(ctx *Context, args *LookupDirectoryConfigArgs, opts ...InvokeOption) (*LookupDirectoryConfigResult, error)
func LookupDirectoryConfigOutput(ctx *Context, args *LookupDirectoryConfigOutputArgs, opts ...InvokeOption) LookupDirectoryConfigResultOutput

    > Note: This function is named LookupDirectoryConfig in the Go SDK.

    public static class GetDirectoryConfig 
{
    public static Task<GetDirectoryConfigResult> InvokeAsync(GetDirectoryConfigArgs args, InvokeOptions? opts = null)
    public static Output<GetDirectoryConfigResult> Invoke(GetDirectoryConfigInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDirectoryConfigResult> getDirectoryConfig(GetDirectoryConfigArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: aws-native:appstream:getDirectoryConfig
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DirectoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    DirectoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    directoryName String
    The fully qualified name of the directory (for example, corp.example.com).
    directoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    directory_name str
    The fully qualified name of the directory (for example, corp.example.com).
    directoryName String
    The fully qualified name of the directory (for example, corp.example.com).

    getDirectoryConfig Result

    The following output properties are available:

    CertificateBasedAuthProperties Pulumi.AwsNative.AppStream.Outputs.DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    OrganizationalUnitDistinguishedNames List<string>
    The distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials Pulumi.AwsNative.AppStream.Outputs.DirectoryConfigServiceAccountCredentials
    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 .
    CertificateBasedAuthProperties DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    OrganizationalUnitDistinguishedNames []string
    The distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentials
    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 .
    certificateBasedAuthProperties DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    organizationalUnitDistinguishedNames List<String>
    The distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    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 .
    certificateBasedAuthProperties DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    organizationalUnitDistinguishedNames string[]
    The distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    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 .
    certificate_based_auth_properties DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    organizational_unit_distinguished_names Sequence[str]
    The distinguished names of the organizational units for computer accounts.
    service_account_credentials DirectoryConfigServiceAccountCredentials
    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 .
    certificateBasedAuthProperties Property Map
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    organizationalUnitDistinguishedNames List<String>
    The distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials Property Map
    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 .

    Supporting Types

    DirectoryConfigCertificateBasedAuthProperties

    CertificateAuthorityArn string
    The ARN of the AWS Certificate Manager Private CA resource.
    Status string
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
    CertificateAuthorityArn string
    The ARN of the AWS Certificate Manager Private CA resource.
    Status string
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
    certificateAuthorityArn String
    The ARN of the AWS Certificate Manager Private CA resource.
    status String
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
    certificateAuthorityArn string
    The ARN of the AWS Certificate Manager Private CA resource.
    status string
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
    certificate_authority_arn str
    The ARN of the AWS Certificate Manager Private CA resource.
    status str
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.
    certificateAuthorityArn String
    The ARN of the AWS Certificate Manager Private CA resource.
    status String
    The status of the certificate-based authentication properties. Fallback is turned on by default when certificate-based authentication is Enabled . Fallback allows users to log in using their AD domain password if certificate-based authentication is unsuccessful, or to unlock a desktop lock screen. Enabled_no_directory_login_fallback enables certificate-based authentication, but does not allow users to log in using their AD domain password. Users will be disconnected to re-authenticate using certificates.

    DirectoryConfigServiceAccountCredentials

    AccountName string
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    AccountPassword string
    The password for the account.
    AccountName string
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    AccountPassword string
    The password for the account.
    accountName String
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    accountPassword String
    The password for the account.
    accountName string
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    accountPassword string
    The password for the account.
    account_name str
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    account_password str
    The password for the account.
    accountName String
    The user name of the account. This account must have the following privileges: create computer objects, join computers to the domain, and change/reset the password on descendant computer objects for the organizational units specified.
    accountPassword String
    The password for the account.

    Package Details

    Repository
    AWS Native pulumi/pulumi-aws-native
    License
    Apache-2.0
    aws-native logo

    AWS Native is in preview. AWS Classic is fully supported.

    AWS Native v0.109.0 published on Wednesday, Jun 26, 2024 by Pulumi
    pulumi/pulumi-aws-native