We recommend new projects start with resources from the AWS provider.
aws-native.appstream.DirectoryConfig
Explore with Pulumi AI
We recommend new projects start with resources from the AWS provider.
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.
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The DirectoryConfig resource accepts the following input properties:
- DirectoryName string
- The fully qualified name of the directory (for example, corp.example.com).
- OrganizationalUnit List<string>Distinguished Names 
- The distinguished names of the organizational units for computer accounts.
- ServiceAccount Pulumi.Credentials Aws Native. App Stream. Inputs. Directory Config Service Account Credentials 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- CertificateBased Pulumi.Auth Properties Aws Native. App Stream. Inputs. Directory Config Certificate Based Auth Properties 
- 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).
- OrganizationalUnit []stringDistinguished Names 
- The distinguished names of the organizational units for computer accounts.
- ServiceAccount DirectoryCredentials Config Service Account Credentials Args 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- CertificateBased DirectoryAuth Properties Config Certificate Based Auth Properties Args 
- 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).
- organizationalUnit List<String>Distinguished Names 
- The distinguished names of the organizational units for computer accounts.
- serviceAccount DirectoryCredentials Config Service Account Credentials 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- certificateBased DirectoryAuth Properties Config Certificate Based Auth Properties 
- 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).
- organizationalUnit string[]Distinguished Names 
- The distinguished names of the organizational units for computer accounts.
- serviceAccount DirectoryCredentials Config Service Account Credentials 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- certificateBased DirectoryAuth Properties Config Certificate Based Auth Properties 
- 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_ Sequence[str]distinguished_ names 
- The distinguished names of the organizational units for computer accounts.
- service_account_ Directorycredentials Config Service Account Credentials Args 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- certificate_based_ Directoryauth_ properties Config Certificate Based Auth Properties Args 
- 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).
- organizationalUnit List<String>Distinguished Names 
- The distinguished names of the organizational units for computer accounts.
- serviceAccount Property MapCredentials 
- The credentials for the service account used by the streaming instance to connect to the directory. Do not use this parameter directly. Use ServiceAccountCredentialsas an input parameter withnoEchoas shown in the Parameters . For best practices information, see Do Not Embed Credentials in Your Templates .
- certificateBased Property MapAuth Properties 
- 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            
- 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.
- 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.
- 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.
- 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.
- 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.
- 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
We recommend new projects start with resources from the AWS provider.