connectors

Creates, updates, deletes or gets a connector resource or lists connectors in a region

Overview

Name	connectors
Type	Resource
Description	Definition of AWS::PCAConnectorAD::Connector Resource Type
Id	aws.pcaconnectorad.connectors

Fields

Name	Datatype	Description
certificate_authority_arn	string
connector_arn	string
directory_id	string
tags	object
vpc_information	object
region	string	AWS region.

Methods

Name	Accessible by	Required Params
create_resource	INSERT	CertificateAuthorityArn, DirectoryId, VpcInformation, 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 connectors in a region.

SELECT
region,
certificate_authority_arn,
connector_arn,
directory_id,
tags,
vpc_information
FROM aws.pcaconnectorad.connectors
WHERE region = 'us-east-1';

Gets all properties from an individual connector.

SELECT
region,
certificate_authority_arn,
connector_arn,
directory_id,
tags,
vpc_information
FROM aws.pcaconnectorad.connectors
WHERE region = 'us-east-1' AND data__Identifier = '<ConnectorArn>';

INSERT example

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

Required Properties

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

All Properties

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

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector
    props:
      - name: CertificateAuthorityArn
        value: '{{ CertificateAuthorityArn }}'
      - name: DirectoryId
        value: '{{ DirectoryId }}'
      - name: Tags
        value: {}
      - name: VpcInformation
        value:
          SecurityGroupIds:
            - '{{ SecurityGroupIds[0] }}'

DELETE example

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

Permissions

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

Create

acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificateAuthorityCertificate,
acm-pca:GetCertificate,
acm-pca:IssueCertificate,
ds:DescribeDirectories,
ec2:CreateTags,
ec2:CreateVpcEndpoint,
ec2:DescribeVpcEndpoints,
pca-connector-ad:CreateConnector,
pca-connector-ad:GetConnector

Read

pca-connector-ad:ListTagsForResource,
pca-connector-ad:GetConnector

Delete

pca-connector-ad:GetConnector,
pca-connector-ad:DeleteConnector,
ec2:DeleteVpcEndpoints,
ec2:DescribeVpcEndpoints

List

pca-connector-ad:ListConnectors

Update

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