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

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

aws-native.appstream.DirectoryConfig

Explore with Pulumi AI

aws-native logo

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

AWS Native v0.108.4 published on Tuesday, Jun 18, 2024 by Pulumi

    Resource Type definition for AWS::AppStream::DirectoryConfig

    Create DirectoryConfig Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new DirectoryConfig(name: string, args: DirectoryConfigArgs, opts?: CustomResourceOptions);
    @overload
    def DirectoryConfig(resource_name: str,
                        args: DirectoryConfigArgs,
                        opts: Optional[ResourceOptions] = None)
    
    @overload
    def DirectoryConfig(resource_name: str,
                        opts: Optional[ResourceOptions] = None,
                        directory_name: Optional[str] = None,
                        organizational_unit_distinguished_names: Optional[Sequence[str]] = None,
                        service_account_credentials: Optional[DirectoryConfigServiceAccountCredentialsArgs] = None,
                        certificate_based_auth_properties: Optional[DirectoryConfigCertificateBasedAuthPropertiesArgs] = None)
    func NewDirectoryConfig(ctx *Context, name string, args DirectoryConfigArgs, opts ...ResourceOption) (*DirectoryConfig, error)
    public DirectoryConfig(string name, DirectoryConfigArgs args, CustomResourceOptions? opts = null)
    public DirectoryConfig(String name, DirectoryConfigArgs args)
    public DirectoryConfig(String name, DirectoryConfigArgs args, CustomResourceOptions options)
    
    type: aws-native:appstream:DirectoryConfig
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args DirectoryConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args DirectoryConfigArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args DirectoryConfigArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args DirectoryConfigArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args DirectoryConfigArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    Coming soon!
    
    const directoryConfigResource = new aws_native.appstream.DirectoryConfig("directoryConfigResource", {
        directoryName: "string",
        organizationalUnitDistinguishedNames: ["string"],
        serviceAccountCredentials: {
            accountName: "string",
            accountPassword: "string",
        },
        certificateBasedAuthProperties: {
            certificateAuthorityArn: "string",
            status: "string",
        },
    });
    
    Coming soon!
    

    DirectoryConfig Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The DirectoryConfig resource accepts the following input properties:

    DirectoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    OrganizationalUnitDistinguishedNames List<string>
    The distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials Pulumi.AwsNative.AppStream.Inputs.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 Pulumi.AwsNative.AppStream.Inputs.DirectoryConfigCertificateBasedAuthProperties
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    DirectoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    OrganizationalUnitDistinguishedNames []string
    The distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentialsArgs
    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 DirectoryConfigCertificateBasedAuthPropertiesArgs
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    directoryName String
    The fully qualified name of the directory (for example, corp.example.com).
    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.
    directoryName string
    The fully qualified name of the directory (for example, corp.example.com).
    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.
    directory_name str
    The fully qualified name of the directory (for example, corp.example.com).
    organizational_unit_distinguished_names Sequence[str]
    The distinguished names of the organizational units for computer accounts.
    service_account_credentials DirectoryConfigServiceAccountCredentialsArgs
    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 DirectoryConfigCertificateBasedAuthPropertiesArgs
    The certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances.
    directoryName String
    The fully qualified name of the directory (for example, corp.example.com).
    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 .
    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.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the DirectoryConfig resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Supporting Types

    DirectoryConfigCertificateBasedAuthProperties, DirectoryConfigCertificateBasedAuthPropertiesArgs

    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, DirectoryConfigServiceAccountCredentialsArgs

    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.108.4 published on Tuesday, Jun 18, 2024 by Pulumi