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

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

aws.appstream.DirectoryConfig

Explore with Pulumi AI

aws logo

Try AWS Native preview for resources not in the classic version.

AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi

    Provides an AppStream Directory Config.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as aws from "@pulumi/aws";
    
    const example = new aws.appstream.DirectoryConfig("example", {
        directoryName: "NAME OF DIRECTORY",
        organizationalUnitDistinguishedNames: ["DISTINGUISHED NAME"],
        serviceAccountCredentials: {
            accountName: "NAME OF ACCOUNT",
            accountPassword: "PASSWORD OF ACCOUNT",
        },
    });
    
    import pulumi
    import pulumi_aws as aws
    
    example = aws.appstream.DirectoryConfig("example",
        directory_name="NAME OF DIRECTORY",
        organizational_unit_distinguished_names=["DISTINGUISHED NAME"],
        service_account_credentials=aws.appstream.DirectoryConfigServiceAccountCredentialsArgs(
            account_name="NAME OF ACCOUNT",
            account_password="PASSWORD OF ACCOUNT",
        ))
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-aws/sdk/v6/go/aws/appstream"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		_, err := appstream.NewDirectoryConfig(ctx, "example", &appstream.DirectoryConfigArgs{
    			DirectoryName: pulumi.String("NAME OF DIRECTORY"),
    			OrganizationalUnitDistinguishedNames: pulumi.StringArray{
    				pulumi.String("DISTINGUISHED NAME"),
    			},
    			ServiceAccountCredentials: &appstream.DirectoryConfigServiceAccountCredentialsArgs{
    				AccountName:     pulumi.String("NAME OF ACCOUNT"),
    				AccountPassword: pulumi.String("PASSWORD OF ACCOUNT"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Aws = Pulumi.Aws;
    
    return await Deployment.RunAsync(() => 
    {
        var example = new Aws.AppStream.DirectoryConfig("example", new()
        {
            DirectoryName = "NAME OF DIRECTORY",
            OrganizationalUnitDistinguishedNames = new[]
            {
                "DISTINGUISHED NAME",
            },
            ServiceAccountCredentials = new Aws.AppStream.Inputs.DirectoryConfigServiceAccountCredentialsArgs
            {
                AccountName = "NAME OF ACCOUNT",
                AccountPassword = "PASSWORD OF ACCOUNT",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.aws.appstream.DirectoryConfig;
    import com.pulumi.aws.appstream.DirectoryConfigArgs;
    import com.pulumi.aws.appstream.inputs.DirectoryConfigServiceAccountCredentialsArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            var example = new DirectoryConfig("example", DirectoryConfigArgs.builder()
                .directoryName("NAME OF DIRECTORY")
                .organizationalUnitDistinguishedNames("DISTINGUISHED NAME")
                .serviceAccountCredentials(DirectoryConfigServiceAccountCredentialsArgs.builder()
                    .accountName("NAME OF ACCOUNT")
                    .accountPassword("PASSWORD OF ACCOUNT")
                    .build())
                .build());
    
        }
    }
    
    resources:
      example:
        type: aws:appstream:DirectoryConfig
        properties:
          directoryName: NAME OF DIRECTORY
          organizationalUnitDistinguishedNames:
            - DISTINGUISHED NAME
          serviceAccountCredentials:
            accountName: NAME OF ACCOUNT
            accountPassword: PASSWORD OF ACCOUNT
    

    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)
    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: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.

    var directoryConfigResource = new Aws.AppStream.DirectoryConfig("directoryConfigResource", new()
    {
        DirectoryName = "string",
        OrganizationalUnitDistinguishedNames = new[]
        {
            "string",
        },
        ServiceAccountCredentials = new Aws.AppStream.Inputs.DirectoryConfigServiceAccountCredentialsArgs
        {
            AccountName = "string",
            AccountPassword = "string",
        },
    });
    
    example, err := appstream.NewDirectoryConfig(ctx, "directoryConfigResource", &appstream.DirectoryConfigArgs{
    	DirectoryName: pulumi.String("string"),
    	OrganizationalUnitDistinguishedNames: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ServiceAccountCredentials: &appstream.DirectoryConfigServiceAccountCredentialsArgs{
    		AccountName:     pulumi.String("string"),
    		AccountPassword: pulumi.String("string"),
    	},
    })
    
    var directoryConfigResource = new DirectoryConfig("directoryConfigResource", DirectoryConfigArgs.builder()
        .directoryName("string")
        .organizationalUnitDistinguishedNames("string")
        .serviceAccountCredentials(DirectoryConfigServiceAccountCredentialsArgs.builder()
            .accountName("string")
            .accountPassword("string")
            .build())
        .build());
    
    directory_config_resource = aws.appstream.DirectoryConfig("directoryConfigResource",
        directory_name="string",
        organizational_unit_distinguished_names=["string"],
        service_account_credentials=aws.appstream.DirectoryConfigServiceAccountCredentialsArgs(
            account_name="string",
            account_password="string",
        ))
    
    const directoryConfigResource = new aws.appstream.DirectoryConfig("directoryConfigResource", {
        directoryName: "string",
        organizationalUnitDistinguishedNames: ["string"],
        serviceAccountCredentials: {
            accountName: "string",
            accountPassword: "string",
        },
    });
    
    type: aws:appstream:DirectoryConfig
    properties:
        directoryName: string
        organizationalUnitDistinguishedNames:
            - string
        serviceAccountCredentials:
            accountName: string
            accountPassword: string
    

    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
    Fully qualified name of the directory.
    OrganizationalUnitDistinguishedNames List<string>
    Distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    DirectoryName string
    Fully qualified name of the directory.
    OrganizationalUnitDistinguishedNames []string
    Distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentialsArgs
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    directoryName String
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames List<String>
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    directoryName string
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames string[]
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    directory_name str
    Fully qualified name of the directory.
    organizational_unit_distinguished_names Sequence[str]
    Distinguished names of the organizational units for computer accounts.
    service_account_credentials DirectoryConfigServiceAccountCredentialsArgs
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    directoryName String
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames List<String>
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials Property Map
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.

    Outputs

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

    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    Id string
    The provider-assigned unique ID for this managed resource.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    id String
    The provider-assigned unique ID for this managed resource.
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    id string
    The provider-assigned unique ID for this managed resource.
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    id str
    The provider-assigned unique ID for this managed resource.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing DirectoryConfig Resource

    Get an existing DirectoryConfig resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: DirectoryConfigState, opts?: CustomResourceOptions): DirectoryConfig
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            created_time: Optional[str] = None,
            directory_name: Optional[str] = None,
            organizational_unit_distinguished_names: Optional[Sequence[str]] = None,
            service_account_credentials: Optional[DirectoryConfigServiceAccountCredentialsArgs] = None) -> DirectoryConfig
    func GetDirectoryConfig(ctx *Context, name string, id IDInput, state *DirectoryConfigState, opts ...ResourceOption) (*DirectoryConfig, error)
    public static DirectoryConfig Get(string name, Input<string> id, DirectoryConfigState? state, CustomResourceOptions? opts = null)
    public static DirectoryConfig get(String name, Output<String> id, DirectoryConfigState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    DirectoryName string
    Fully qualified name of the directory.
    OrganizationalUnitDistinguishedNames List<string>
    Distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    CreatedTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    DirectoryName string
    Fully qualified name of the directory.
    OrganizationalUnitDistinguishedNames []string
    Distinguished names of the organizational units for computer accounts.
    ServiceAccountCredentials DirectoryConfigServiceAccountCredentialsArgs
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    directoryName String
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames List<String>
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    createdTime string
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    directoryName string
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames string[]
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials DirectoryConfigServiceAccountCredentials
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    created_time str
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    directory_name str
    Fully qualified name of the directory.
    organizational_unit_distinguished_names Sequence[str]
    Distinguished names of the organizational units for computer accounts.
    service_account_credentials DirectoryConfigServiceAccountCredentialsArgs
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.
    createdTime String
    Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
    directoryName String
    Fully qualified name of the directory.
    organizationalUnitDistinguishedNames List<String>
    Distinguished names of the organizational units for computer accounts.
    serviceAccountCredentials Property Map
    Configuration block for the name of the directory and organizational unit (OU) to use to join the directory config to a Microsoft Active Directory domain. See service_account_credentials below.

    Supporting Types

    DirectoryConfigServiceAccountCredentials, DirectoryConfigServiceAccountCredentialsArgs

    AccountName string
    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
    Password for the account.
    AccountName string
    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
    Password for the account.
    accountName String
    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
    Password for the account.
    accountName string
    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
    Password for the account.
    account_name str
    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
    Password for the account.
    accountName String
    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
    Password for the account.

    Import

    Using pulumi import, import aws_appstream_directory_config using the id. For example:

    $ pulumi import aws:appstream/directoryConfig:DirectoryConfig example directoryNameExample
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    AWS Classic pulumi/pulumi-aws
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the aws Terraform Provider.
    aws logo

    Try AWS Native preview for resources not in the classic version.

    AWS Classic v6.40.0 published on Wednesday, Jun 12, 2024 by Pulumi