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	awscc.pcaconnectorad.directory_registrations

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
directory_registration_arn	string
region	string	AWS region.

For more information, see AWS::PCAConnectorAD::DirectoryRegistration.

Methods

Name	Resource	Accessible by	Required Params
create_resource	directory_registrations	INSERT	DirectoryId, region
delete_resource	directory_registrations	DELETE	Identifier, region
update_resource	directory_registrations	UPDATE	Identifier, PatchDocument, region
list_resources	directory_registrations_list_only	SELECT	region
get_resource	directory_registrations	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual directory_registration.

SELECT
  region,
  directory_id,
  directory_registration_arn,
  tags
FROM awscc.pcaconnectorad.directory_registrations
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ directory_registration_arn }}';

list (identifiers only)

Lists all directory_registrations in a region.

SELECT
  region,
  directory_registration_arn
FROM awscc.pcaconnectorad.directory_registrations_list_only
WHERE
  region = 'us-east-1';

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 awscc.pcaconnectorad.directory_registrations (
  DirectoryId,
  region
)
SELECT
  '{{ directory_id }}',
  '{{ region }}';

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.directory_registrations (
  DirectoryId,
  Tags,
  region
)
SELECT
  '{{ directory_id }}',
  '{{ 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: directory_id
        value: '{{ directory_id }}'
      - name: tags
        value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.pcaconnectorad.directory_registrations
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ directory_registration_arn }}';

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorad.directory_registrations
WHERE
  Identifier = '{{ directory_registration_arn }}' AND
  region = 'us-east-1';

Permissions

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

Create

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

Read

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

Delete

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

List

pca-connector-ad:ListDirectoryRegistrations

Update

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