hybrid_ads

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

Overview

Name	hybrid_ads
Type	Resource
Id	aws.ds.hybrid_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_hybrid_ad	insert	region, SecretArn, AssessmentId		Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services. You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation. Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.
update_hybrid_ad	update	region, DirectoryId		Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings. Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes. The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410]. You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.

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_hybrid_ad

Creates a hybrid directory that connects your self-managed Active Directory (AD) infrastructure and Amazon Web Services. You must have a successful directory assessment using StartADAssessment to validate your environment compatibility before you use this operation. Updates are applied asynchronously. Use DescribeDirectories to monitor the progress of directory creation.

INSERT INTO aws.ds.hybrid_ads (
SecretArn,
AssessmentId,
Tags,
region
)
SELECT 
'{{ SecretArn }}' /* required */,
'{{ AssessmentId }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
directory_id
;

Manifest

# Description fields are for documentation purposes
- name: hybrid_ads
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the hybrid_ads resource.
  - name: SecretArn
    value: "{{ SecretArn }}"
    description: |
      The Amazon Resource Name (ARN) of the Amazon Web Services Secrets Manager secret that contains the credentials for the service account used to join hybrid domain controllers to your self-managed AD domain. This secret is used once and not stored. The secret must contain key-value pairs with keys matching customerAdAdminDomainUsername and customerAdAdminDomainPassword. For example: {"customerAdAdminDomainUsername":"carlos_salazar","customerAdAdminDomainPassword":"ExamplePassword123!"}.
  - name: AssessmentId
    value: "{{ AssessmentId }}"
    description: |
      The unique identifier of the successful directory assessment that validates your self-managed AD environment. You must have a successful directory assessment before you create a hybrid directory.
  - name: Tags
    description: |
      The tags to be assigned to the directory. Each tag consists of a key and value pair. You can specify multiple tags as a list.
    value:
      - Key: "{{ Key }}"
        Value: "{{ Value }}"

UPDATE examples

update_hybrid_ad

Updates the configuration of an existing hybrid directory. You can recover hybrid directory administrator account or modify self-managed instance settings. Updates are applied asynchronously. Use DescribeHybridADUpdate to monitor the progress of configuration changes. The InstanceIds must have a one-to-one correspondence with CustomerDnsIps, meaning that if the IP address for instance i-10243410 is 10.24.34.100 and the IP address for instance i-10243420 is 10.24.34.200, then the input arrays must maintain the same order relationship, either [10.24.34.100, 10.24.34.200] paired with [i-10243410, i-10243420] or [10.24.34.200, 10.24.34.100] paired with [i-10243420, i-10243410]. You must provide at least one update to UpdateHybridADRequest$HybridAdministratorAccountUpdate or UpdateHybridADRequest$SelfManagedInstancesSettings.

UPDATE aws.ds.hybrid_ads
SET 
DirectoryId = '{{ DirectoryId }}',
HybridAdministratorAccountUpdate = '{{ HybridAdministratorAccountUpdate }}',
SelfManagedInstancesSettings = '{{ SelfManagedInstancesSettings }}'
WHERE 
region = '{{ region }}' --required
AND DirectoryId = '{{ DirectoryId }}' --required
RETURNING
assessment_id,
directory_id;