directoryservice

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.directoryservice.ConditionalForwader(resource_name, opts=None, directory_id=None, dns_ips=None, remote_domain_name=None, __props__=None, __name__=None, __opts__=None)

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

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • directory_id (pulumi.Input[str]) – The id of directory.

  • dns_ips (pulumi.Input[list]) – A list of forwarder IP addresses.

  • remote_domain_name (pulumi.Input[str]) – The fully qualified domain name of the remote domain for which forwarders will be used.

directory_id = None

The id of directory.

dns_ips = None

A list of forwarder IP addresses.

remote_domain_name = None

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

static get(resource_name, id, opts=None, directory_id=None, dns_ips=None, remote_domain_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • directory_id (pulumi.Input[str]) – The id of directory.

  • dns_ips (pulumi.Input[list]) – A list of forwarder IP addresses.

  • remote_domain_name (pulumi.Input[str]) – The fully qualified domain name of the remote domain for which forwarders will be used.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.directoryservice.Directory(resource_name, opts=None, alias=None, connect_settings=None, description=None, edition=None, enable_sso=None, name=None, password=None, short_name=None, size=None, tags=None, type=None, vpc_settings=None, __props__=None, __name__=None, __opts__=None)

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.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • alias (pulumi.Input[str]) – The alias for the directory (must be unique amongst all aliases in AWS). Required for enable_sso.

  • connect_settings (pulumi.Input[dict]) – Connector related information about the directory. Fields documented below.

  • description (pulumi.Input[str]) – A textual description for the directory.

  • edition (pulumi.Input[str]) – The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise (applies to MicrosoftAD type only).

  • enable_sso (pulumi.Input[bool]) – Whether to enable single-sign on for the directory. Requires alias. Defaults to false.

  • name (pulumi.Input[str]) – The fully qualified name for the directory, such as corp.example.com

  • password (pulumi.Input[str]) – The password for the directory administrator or connector user.

  • short_name (pulumi.Input[str]) – The short name of the directory, such as CORP.

  • size (pulumi.Input[str]) – The size of the directory (Small or Large are accepted values).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • type (pulumi.Input[str]) – The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.

  • vpc_settings (pulumi.Input[dict]) – VPC related information about the directory. Fields documented below.

The connect_settings object supports the following:

  • customerDnsIps (pulumi.Input[list]) - The DNS IP addresses of the domain to connect to.

  • customerUsername (pulumi.Input[str]) - The username corresponding to the password provided.

  • subnet_ids (pulumi.Input[list]) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (pulumi.Input[str]) - The identifier of the VPC that the directory is in.

The vpc_settings object supports the following:

  • subnet_ids (pulumi.Input[list]) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (pulumi.Input[str]) - The identifier of the VPC that the directory is in.

access_url = None

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

alias = None

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

connect_settings = None

Connector related information about the directory. Fields documented below.

  • customerDnsIps (list) - The DNS IP addresses of the domain to connect to.

  • customerUsername (str) - The username corresponding to the password provided.

  • subnet_ids (list) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (str) - The identifier of the VPC that the directory is in.

description = None

A textual description for the directory.

dns_ip_addresses = None

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

edition = None

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

enable_sso = None

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

name = None

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

password = None

The password for the directory administrator or connector user.

security_group_id = None

The ID of the security group created by the directory.

short_name = None

The short name of the directory, such as CORP.

size = None

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

tags = None

A mapping of tags to assign to the resource.

type = None

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

vpc_settings = None

VPC related information about the directory. Fields documented below.

  • subnet_ids (list) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (str) - The identifier of the VPC that the directory is in.

static get(resource_name, id, opts=None, access_url=None, alias=None, connect_settings=None, description=None, dns_ip_addresses=None, edition=None, enable_sso=None, name=None, password=None, security_group_id=None, short_name=None, size=None, tags=None, type=None, vpc_settings=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • access_url (pulumi.Input[str]) – The access URL for the directory, such as http://alias.awsapps.com.

  • alias (pulumi.Input[str]) – The alias for the directory (must be unique amongst all aliases in AWS). Required for enable_sso.

  • connect_settings (pulumi.Input[dict]) – Connector related information about the directory. Fields documented below.

  • description (pulumi.Input[str]) – A textual description for the directory.

  • dns_ip_addresses (pulumi.Input[list]) – A list of IP addresses of the DNS servers for the directory or connector.

  • edition (pulumi.Input[str]) – The MicrosoftAD edition (Standard or Enterprise). Defaults to Enterprise (applies to MicrosoftAD type only).

  • enable_sso (pulumi.Input[bool]) – Whether to enable single-sign on for the directory. Requires alias. Defaults to false.

  • name (pulumi.Input[str]) – The fully qualified name for the directory, such as corp.example.com

  • password (pulumi.Input[str]) – The password for the directory administrator or connector user.

  • security_group_id (pulumi.Input[str]) – The ID of the security group created by the directory.

  • short_name (pulumi.Input[str]) – The short name of the directory, such as CORP.

  • size (pulumi.Input[str]) – The size of the directory (Small or Large are accepted values).

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

  • type (pulumi.Input[str]) – The directory type (SimpleAD, ADConnector or MicrosoftAD are accepted values). Defaults to SimpleAD.

  • vpc_settings (pulumi.Input[dict]) – VPC related information about the directory. Fields documented below.

The connect_settings object supports the following:

  • customerDnsIps (pulumi.Input[list]) - The DNS IP addresses of the domain to connect to.

  • customerUsername (pulumi.Input[str]) - The username corresponding to the password provided.

  • subnet_ids (pulumi.Input[list]) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (pulumi.Input[str]) - The identifier of the VPC that the directory is in.

The vpc_settings object supports the following:

  • subnet_ids (pulumi.Input[list]) - The identifiers of the subnets for the directory servers (2 subnets in 2 different AZs).

  • vpc_id (pulumi.Input[str]) - The identifier of the VPC that the directory is in.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_aws.directoryservice.LogService(resource_name, opts=None, directory_id=None, log_group_name=None, __props__=None, __name__=None, __opts__=None)

Provides a Log subscription for AWS Directory Service that pushes logs to cloudwatch.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • directory_id (pulumi.Input[str]) – The id of directory.

  • log_group_name (pulumi.Input[str]) – Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.

directory_id = None

The id of directory.

log_group_name = None

Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.

static get(resource_name, id, opts=None, directory_id=None, log_group_name=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • directory_id (pulumi.Input[str]) – The id of directory.

  • log_group_name (pulumi.Input[str]) – Name of the cloudwatch log group to which the logs should be published. The log group should be already created and the directory service principal should be provided with required permission to create stream and publish logs. Changing this value would delete the current subscription and create a new one. A directory can only have one log subscription at a time.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str