directory_registrations

Creates, updates, deletes or gets a directory_registration resource or lists directory_registrations in a region

Overview

Name	directory_registrations
Type	Resource
Description	Definition of AWS::PCAConnectorAD::DirectoryRegistration Resource Type
Id	aws.pcaconnectorad.directory_registrations

Fields

Name	Datatype	Description
directory_id	string
directory_registration_arn	string
tags	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	DirectoryId, region
delete_resource	DELETE	data__Identifier, region
update_resource	UPDATE	data__Identifier, data__PatchDocument, region
list_resources	SELECT	region
get_resource	SELECT	data__Identifier, region

SELECT examples

Gets all directory_registrations in a region.

SELECT
region,
directory_id,
directory_registration_arn,
tags
FROM aws.pcaconnectorad.directory_registrations
WHERE region = 'us-east-1';

Gets all properties from an individual directory_registration.

SELECT
region,
directory_id,
directory_registration_arn,
tags
FROM aws.pcaconnectorad.directory_registrations
WHERE region = 'us-east-1' AND data__Identifier = '<DirectoryRegistrationArn>';

INSERT example

Use the following StackQL query and manifest file to create a new directory_registration resource, using stack-deploy.

Required Properties

/*+ create */
INSERT INTO aws.pcaconnectorad.directory_registrations (
 DirectoryId,
 region
)
SELECT 
'{{ DirectoryId }}',
'{{ region }}';

All Properties

/*+ create */
INSERT INTO aws.pcaconnectorad.directory_registrations (
 DirectoryId,
 Tags,
 region
)
SELECT 
 '{{ DirectoryId }}',
 '{{ Tags }}',
 '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: directory_registration
    props:
      - name: DirectoryId
        value: '{{ DirectoryId }}'
      - name: Tags
        value: {}

DELETE example

/*+ delete */
DELETE FROM aws.pcaconnectorad.directory_registrations
WHERE data__Identifier = '<DirectoryRegistrationArn>'
AND region = 'us-east-1';

Permissions

To operate on the directory_registrations resource, the following permissions are required:

Create

pca-connector-ad:GetDirectoryRegistration,
pca-connector-ad:CreateDirectoryRegistration,
ds:AuthorizeApplication,
ds:DescribeDirectories

Read

pca-connector-ad:ListTagsForResource,
pca-connector-ad:GetDirectoryRegistration

Delete

pca-connector-ad:GetDirectoryRegistration,
pca-connector-ad:DeleteDirectoryRegistration,
ds:DescribeDirectories,
ds:UnauthorizeApplication,
ds:UpdateAuthorizedApplication

List

pca-connector-ad:ListDirectoryRegistrations

Update

pca-connector-ad:ListTagsForResource,
pca-connector-ad:TagResource,
pca-connector-ad:UntagResource