directory_registrations

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

Overview

Name	directory_registrations
Type	Resource
Id	aws.pca_connector_ad.directory_registrations

Fields

The following fields are returned by SELECT queries:

get_directory_registration

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration. (pattern: <code>^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration/d-[0-9a-f]{10}$</code>)
created_at	string (date-time)	The date and time that the directory registration was created.
directory_id	string	The identifier of the Active Directory. (pattern: <code>^d-[0-9a-f]{10}$</code>)
status	string	Status of the directory registration. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Additional information about the directory registration status if the status is failed. (DIRECTORY_ACCESS_DENIED, DIRECTORY_RESOURCE_NOT_FOUND, DIRECTORY_NOT_ACTIVE, DIRECTORY_NOT_REACHABLE, DIRECTORY_TYPE_NOT_SUPPORTED, INTERNAL_FAILURE)
updated_at	string (date-time)	The date and time that the directory registration was updated.

list_directory_registrations

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration. (pattern: <code>^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:directory-registration/d-[0-9a-f]{10}$</code>)
created_at	string (date-time)	The date and time that the directory registration was created.
directory_id	string	The identifier of the Active Directory. (pattern: <code>^d-[0-9a-f]{10}$</code>)
status	string	Status of the directory registration. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Additional information about the directory registration status if the status is failed. (DIRECTORY_ACCESS_DENIED, DIRECTORY_RESOURCE_NOT_FOUND, DIRECTORY_NOT_ACTIVE, DIRECTORY_NOT_REACHABLE, DIRECTORY_TYPE_NOT_SUPPORTED, INTERNAL_FAILURE)
updated_at	string (date-time)	The date and time that the directory registration was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_directory_registration	select	directory_registration_arn, region		A structure that contains information about your directory registration.
list_directory_registrations	select	region	MaxResults, NextToken	Lists the directory registrations that you created by using the https:​//docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.
create_directory_registration	insert	region, DirectoryId		Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
delete_directory_registration	delete	directory_registration_arn, region		Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

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
directory_registration_arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
region	string	AWS region (default: us-east-1)
MaxResults	integer	Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items.
NextToken	string	Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.

SELECT examples

get_directory_registration

A structure that contains information about your directory registration.

SELECT
arn,
created_at,
directory_id,
status,
status_reason,
updated_at
FROM aws.pca_connector_ad.directory_registrations
WHERE directory_registration_arn = '{{ directory_registration_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_directory_registrations

Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistration action.

SELECT
arn,
created_at,
directory_id,
status,
status_reason,
updated_at
FROM aws.pca_connector_ad.directory_registrations
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_directory_registration

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory

INSERT INTO aws.pca_connector_ad.directory_registrations (
ClientToken,
DirectoryId,
Tags,
region
)
SELECT 
'{{ ClientToken }}',
'{{ DirectoryId }}' /* required */,
'{{ Tags }}',
'{{ region }}'
RETURNING
directory_registration_arn
;

Manifest

# Description fields are for documentation purposes
- name: directory_registrations
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the directory_registrations resource.
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: DirectoryId
    value: "{{ DirectoryId }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_directory_registration

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

DELETE FROM aws.pca_connector_ad.directory_registrations
WHERE directory_registration_arn = '{{ directory_registration_arn }}' --required
AND region = '{{ region }}' --required
;