microsoft_ads

Creates, updates, deletes, gets or lists a microsoft_ads resource.

Overview

Name	microsoft_ads
Type	Resource
Id	aws.ds.microsoft_ads

Fields

The following fields are returned by SELECT queries:

SELECT not supported for this resource, use SHOW METHODS to view available operations for the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
create_microsoft_ad	insert	region, Name, Password, VpcSettings		Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
region	string	AWS region (default: us-east-1)

INSERT examples

create_microsoft_ad

Creates a Microsoft AD directory in the Amazon Web Services Cloud. For more information, see Managed Microsoft AD in the Directory Service Admin Guide. Before you call CreateMicrosoftAD, ensure that all of the required permissions have been explicitly granted through a policy. For details about what permissions are required to run the CreateMicrosoftAD operation, see Directory Service API Permissions: Actions, Resources, and Conditions Reference.

INSERT INTO aws.ds.microsoft_ads (
Name,
ShortName,
Password,
Description,
VpcSettings,
Edition,
Tags,
NetworkType,
region
)
SELECT 
'{{ Name }}' /* required */,
'{{ ShortName }}',
'{{ Password }}' /* required */,
'{{ Description }}',
'{{ VpcSettings }}' /* required */,
'{{ Edition }}',
'{{ Tags }}',
'{{ NetworkType }}',
'{{ region }}'
RETURNING
directory_id
;

Manifest

# Description fields are for documentation purposes
- name: microsoft_ads
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the microsoft_ads resource.
  - name: Name
    value: "{{ Name }}"
    description: |
      The fully qualified domain name for the Managed Microsoft AD directory, such as corp.example.com. This name will resolve inside your VPC only. It does not need to be publicly resolvable.
  - name: ShortName
    value: "{{ ShortName }}"
    description: |
      The NetBIOS name for your domain, such as CORP. If you don't specify a NetBIOS name, it will default to the first part of your directory DNS. For example, CORP for the directory DNS corp.example.com.
  - name: Password
    value: "{{ Password }}"
    description: |
      The password for the default administrative user named Admin. If you need to change the password for the administrator account, you can use the ResetUserPassword API call.
  - name: Description
    value: "{{ Description }}"
    description: |
      A description for the directory. This label will appear on the Amazon Web Services console Directory Details page after the directory is created.
  - name: VpcSettings
    description: |
      Contains VPC information for the CreateDirectory, CreateMicrosoftAD, or CreateHybridAD operation.
    value:
      VpcId: "{{ VpcId }}"
      SubnetIds:
        - "{{ SubnetIds }}"
  - name: Edition
    value: "{{ Edition }}"
    description: |
      Managed Microsoft AD is available in two editions: Standard and Enterprise. Enterprise is the default.
    valid_values: ['Enterprise', 'Standard', 'Hybrid']
  - name: Tags
    description: |
      The tags to be assigned to the Managed Microsoft AD directory.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"
  - name: NetworkType
    value: "{{ NetworkType }}"
    description: |
      The network type for your domain. The default value is IPv4 or IPv6 based on the provided subnet capabilities.
    valid_values: ['Dual-stack', 'IPv4', 'IPv6']