Fork me on GitHub

Module directoryservice

@pulumi/aws > directoryservice

Index

directoryservice/conditionalForwader.ts directoryservice/directory.ts

class ConditionalForwader

Provides a conditional forwarder for managed Microsoft AD in AWS Directory Service.

constructor

new ConditionalForwader(name: string, args: ConditionalForwaderArgs, opts?: pulumi.CustomResourceOptions)

Create a ConditionalForwader resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ConditionalForwaderState): ConditionalForwader

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property directoryId

public directoryId: pulumi.Output<string>;

The id of directory.

property dnsIps

public dnsIps: pulumi.Output<string[]>;

A list of forwarder IP addresses.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property remoteDomainName

public remoteDomainName: pulumi.Output<string>;

The fully qualified domain name of the remote domain for which forwarders will be used.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

class Directory

Provides a Simple or Managed Microsoft directory in AWS Directory Service.

~> Note: All arguments including the password and customer username will be stored in the raw state as plain-text. Read more about sensitive data in state.

constructor

new Directory(name: string, args: DirectoryArgs, opts?: pulumi.CustomResourceOptions)

Create a Directory resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: DirectoryState): Directory

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

static isInstance(obj: any): boolean

Returns true if the given object is an instance of CustomResource. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property accessUrl

public accessUrl: pulumi.Output<string>;

The access URL for the directory, such as http://alias.awsapps.com.

property alias

public alias: pulumi.Output<string>;

The alias for the directory (must be unique amongst all aliases in AWS). Required for enable_sso.

property connectSettings

public connectSettings: pulumi.Output<{ ... } | undefined>;

Connector related information about the directory. Fields documented below.

property description

public description: pulumi.Output<string | undefined>;

A textual description for the directory.

property dnsIpAddresses

public dnsIpAddresses: pulumi.Output<string[]>;

A list of IP addresses of the DNS servers for the directory or connector.

property edition

public edition: pulumi.Output<string>;

The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise (applies to MicrosoftAD type only).

property enableSso

public enableSso: pulumi.Output<boolean | undefined>;

Whether to enable single-sign on for the directory. Requires alias. Defaults to false.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property name

public name: pulumi.Output<string>;

The fully qualified name for the directory, such as corp.example.com

property password

public password: pulumi.Output<string>;

The password for the directory administrator or connector user.

property securityGroupId

public securityGroupId: pulumi.Output<string>;

The ID of the security group created by the directory (SimpleAD or MicrosoftAD only).

property shortName

public shortName: pulumi.Output<string>;

The short name of the directory, such as CORP.

property size

public size: pulumi.Output<string>;

The size of the directory (Small or Large are accepted values).

property tags

public tags: pulumi.Output<Tags | undefined>;

A mapping of tags to assign to the resource.

property type

public type: pulumi.Output<string | undefined>;

The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property vpcSettings

public vpcSettings: pulumi.Output<{ ... } | undefined>;

VPC related information about the directory. Fields documented below.

interface ConditionalForwaderArgs

The set of arguments for constructing a ConditionalForwader resource.

property directoryId

directoryId: pulumi.Input<string>;

The id of directory.

property dnsIps

dnsIps: pulumi.Input<pulumi.Input<string>[]>;

A list of forwarder IP addresses.

property remoteDomainName

remoteDomainName: pulumi.Input<string>;

The fully qualified domain name of the remote domain for which forwarders will be used.

interface ConditionalForwaderState

Input properties used for looking up and filtering ConditionalForwader resources.

property directoryId

directoryId?: pulumi.Input<string>;

The id of directory.

property dnsIps

dnsIps?: pulumi.Input<pulumi.Input<string>[]>;

A list of forwarder IP addresses.

property remoteDomainName

remoteDomainName?: pulumi.Input<string>;

The fully qualified domain name of the remote domain for which forwarders will be used.

interface DirectoryArgs

The set of arguments for constructing a Directory resource.

property alias

alias?: pulumi.Input<string>;

The alias for the directory (must be unique amongst all aliases in AWS). Required for enable_sso.

property connectSettings

connectSettings?: pulumi.Input<{ ... }>;

Connector related information about the directory. Fields documented below.

property description

description?: pulumi.Input<string>;

A textual description for the directory.

property edition

edition?: pulumi.Input<string>;

The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise (applies to MicrosoftAD type only).

property enableSso

enableSso?: pulumi.Input<boolean>;

Whether to enable single-sign on for the directory. Requires alias. Defaults to false.

property name

name?: pulumi.Input<string>;

The fully qualified name for the directory, such as corp.example.com

property password

password: pulumi.Input<string>;

The password for the directory administrator or connector user.

property shortName

shortName?: pulumi.Input<string>;

The short name of the directory, such as CORP.

property size

size?: pulumi.Input<string>;

The size of the directory (Small or Large are accepted values).

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.

property vpcSettings

vpcSettings?: pulumi.Input<{ ... }>;

VPC related information about the directory. Fields documented below.

interface DirectoryState

Input properties used for looking up and filtering Directory resources.

property accessUrl

accessUrl?: pulumi.Input<string>;

The access URL for the directory, such as http://alias.awsapps.com.

property alias

alias?: pulumi.Input<string>;

The alias for the directory (must be unique amongst all aliases in AWS). Required for enable_sso.

property connectSettings

connectSettings?: pulumi.Input<{ ... }>;

Connector related information about the directory. Fields documented below.

property description

description?: pulumi.Input<string>;

A textual description for the directory.

property dnsIpAddresses

dnsIpAddresses?: pulumi.Input<pulumi.Input<string>[]>;

A list of IP addresses of the DNS servers for the directory or connector.

property edition

edition?: pulumi.Input<string>;

The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise (applies to MicrosoftAD type only).

property enableSso

enableSso?: pulumi.Input<boolean>;

Whether to enable single-sign on for the directory. Requires alias. Defaults to false.

property name

name?: pulumi.Input<string>;

The fully qualified name for the directory, such as corp.example.com

property password

password?: pulumi.Input<string>;

The password for the directory administrator or connector user.

property securityGroupId

securityGroupId?: pulumi.Input<string>;

The ID of the security group created by the directory (SimpleAD or MicrosoftAD only).

property shortName

shortName?: pulumi.Input<string>;

The short name of the directory, such as CORP.

property size

size?: pulumi.Input<string>;

The size of the directory (Small or Large are accepted values).

property tags

tags?: pulumi.Input<Tags>;

A mapping of tags to assign to the resource.

property type

type?: pulumi.Input<string>;

The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.

property vpcSettings

vpcSettings?: pulumi.Input<{ ... }>;

VPC related information about the directory. Fields documented below.