Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

[ aws . appstream ]

update-directory-config

Description

Updates the specified Directory Config object in AppStream 2.0. This object includes the configuration information required to join fleets and image builders to Microsoft Active Directory domains.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  update-directory-config
--directory-name <value>
[--organizational-unit-distinguished-names <value>]
[--service-account-credentials <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--directory-name (string)

The name of the Directory Config object.

--organizational-unit-distinguished-names (list)

The distinguished names of the organizational units for computer accounts.

Syntax:

"string" "string" ...

--service-account-credentials (structure)

The credentials for the service account used by the fleet or image builder to connect to the directory.

Shorthand Syntax:

AccountName=string,AccountPassword=string

JSON Syntax:

{
  "AccountName": "string",
  "AccountPassword": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

DirectoryConfig -> (structure)

Information about the Directory Config object.

DirectoryName -> (string)

The fully qualified name of the directory (for example, corp.example.com).

OrganizationalUnitDistinguishedNames -> (list)

The distinguished names of the organizational units for computer accounts.

(string)

ServiceAccountCredentials -> (structure)

The credentials for the service account used by the fleet or image builder to connect to the directory.

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.

CreatedTime -> (timestamp)

The time the directory configuration was created.