DirectoryConfig class

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", {
    serviceAccountCredentials: {
        accountName: "NAME OF ACCOUNT",
        accountPassword: "PASSWORD OF ACCOUNT",
    },
    certificateBasedAuthProperties: {
        certificateAuthorityArn: "ARN OF CERTIFICATE AUTHORITY",
        status: "STATUS OF CERTIFICATE BASED AUTHENTICATION",
    },
    directoryName: "NAME OF DIRECTORY",
    organizationalUnitDistinguishedNames: ["DISTINGUISHED NAME"],
});
import pulumi
import pulumi_aws as aws

example = aws.appstream.DirectoryConfig("example",
    service_account_credentials={
        "account_name": "NAME OF ACCOUNT",
        "account_password": "PASSWORD OF ACCOUNT",
    },
    certificate_based_auth_properties={
        "certificate_authority_arn": "ARN OF CERTIFICATE AUTHORITY",
        "status": "STATUS OF CERTIFICATE BASED AUTHENTICATION",
    },
    directory_name="NAME OF DIRECTORY",
    organizational_unit_distinguished_names=["DISTINGUISHED NAME"])
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()
    {
        ServiceAccountCredentials = new Aws.AppStream.Inputs.DirectoryConfigServiceAccountCredentialsArgs
        {
            AccountName = "NAME OF ACCOUNT",
            AccountPassword = "PASSWORD OF ACCOUNT",
        },
        CertificateBasedAuthProperties = new Aws.AppStream.Inputs.DirectoryConfigCertificateBasedAuthPropertiesArgs
        {
            CertificateAuthorityArn = "ARN OF CERTIFICATE AUTHORITY",
            Status = "STATUS OF CERTIFICATE BASED AUTHENTICATION",
        },
        DirectoryName = "NAME OF DIRECTORY",
        OrganizationalUnitDistinguishedNames = new[]
        {
            "DISTINGUISHED NAME",
        },
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/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{
			ServiceAccountCredentials: &appstream.DirectoryConfigServiceAccountCredentialsArgs{
				AccountName:     pulumi.String("NAME OF ACCOUNT"),
				AccountPassword: pulumi.String("PASSWORD OF ACCOUNT"),
			},
			CertificateBasedAuthProperties: &appstream.DirectoryConfigCertificateBasedAuthPropertiesArgs{
				CertificateAuthorityArn: pulumi.String("ARN OF CERTIFICATE AUTHORITY"),
				Status:                  pulumi.String("STATUS OF CERTIFICATE BASED AUTHENTICATION"),
			},
			DirectoryName: pulumi.String("NAME OF DIRECTORY"),
			OrganizationalUnitDistinguishedNames: pulumi.StringArray{
				pulumi.String("DISTINGUISHED NAME"),
			},
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_appstream_directoryconfig" "example" {
  service_account_credentials = {
    account_name     = "NAME OF ACCOUNT"
    account_password = "PASSWORD OF ACCOUNT"
  }
  certificate_based_auth_properties = {
    certificate_authority_arn = "ARN OF CERTIFICATE AUTHORITY"
    status                    = "STATUS OF CERTIFICATE BASED AUTHENTICATION"
  }
  directory_name                          = "NAME OF DIRECTORY"
  organizational_unit_distinguished_names = ["DISTINGUISHED NAME"]
}
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 com.pulumi.aws.appstream.inputs.DirectoryConfigCertificateBasedAuthPropertiesArgs;
import java.util.ArrayList;
import java.util.Arrays;
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()
            .serviceAccountCredentials(DirectoryConfigServiceAccountCredentialsArgs.builder()
                .accountName("NAME OF ACCOUNT")
                .accountPassword("PASSWORD OF ACCOUNT")
                .build())
            .certificateBasedAuthProperties(DirectoryConfigCertificateBasedAuthPropertiesArgs.builder()
                .certificateAuthorityArn("ARN OF CERTIFICATE AUTHORITY")
                .status("STATUS OF CERTIFICATE BASED AUTHENTICATION")
                .build())
            .directoryName("NAME OF DIRECTORY")
            .organizationalUnitDistinguishedNames("DISTINGUISHED NAME")
            .build());

    }
}
resources:
  example:
    type: aws:appstream:DirectoryConfig
    properties:
      serviceAccountCredentials:
        accountName: NAME OF ACCOUNT
        accountPassword: PASSWORD OF ACCOUNT
      certificateBasedAuthProperties:
        certificateAuthorityArn: ARN OF CERTIFICATE AUTHORITY
        status: STATUS OF CERTIFICATE BASED AUTHENTICATION
      directoryName: NAME OF DIRECTORY
      organizationalUnitDistinguishedNames:
        - DISTINGUISHED NAME

Import

Using pulumi import, import aws.appstream.DirectoryConfig using the id. For example:

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

Constructors

DirectoryConfig(String name, {DirectoryConfigArgs? args, CustomResourceOptions? options})
Creates a new DirectoryConfig. name The Pulumi resource name. args Arguments used to configure this DirectoryConfig. The set of arguments for DirectoryConfig. options Resource options controlling this resource's behavior.
DirectoryConfig.reference(String urn)
Creates a typed reference to an existing DirectoryConfig resource.

Properties

certificateBasedAuthProperties ↔ Output<DirectoryConfigCertificateBasedAuthProperties?>
Configuration block for the certificate-based authentication properties used to authenticate SAML 2.0 Identity Provider (IdP) user identities to Active Directory domain-joined streaming instances. See certificateBasedAuthProperties below.
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
createdTime ↔ Output<String>
Date and time, in UTC and extended RFC 3339 format, when the directory config was created.
latefinal
directoryName ↔ Output<String>
Fully qualified name of the directory.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
organizationalUnitDistinguishedNames ↔ Output<List<String>>
Distinguished names of the organizational units for computer accounts.
latefinal
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
serviceAccountCredentials ↔ Output<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 serviceAccountCredentials below.
latefinal
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {DirectoryConfigState? state, CustomResourceOptions? options}) → DirectoryConfig
Gets an existing DirectoryConfig resource's state with the given name and id.