connectors

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

Overview

Name	connectors
Type	Resource
Description	Represents a Connector that connects AWS PrivateCA and your directory
Id	awscc.pcaconnectorad.connectors

Fields

get (all properties)

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

list (identifiers only)

Name	Datatype	Description
connector_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	connectors	INSERT	CertificateAuthorityArn, DirectoryId, VpcInformation, region
delete_resource	connectors	DELETE	Identifier, region
update_resource	connectors	UPDATE	Identifier, PatchDocument, region
list_resources	connectors_list_only	SELECT	region
get_resource	connectors	SELECT	Identifier, region

SELECT examples

get (all properties)

Gets all properties from an individual connector.

SELECT
  region,
  certificate_authority_arn,
  connector_arn,
  directory_id,
  tags,
  vpc_information
FROM awscc.pcaconnectorad.connectors
WHERE
  region = 'us-east-1' AND
  Identifier = '{{ connector_arn }}';

list (identifiers only)

Lists all connectors in a region.

SELECT
  region,
  connector_arn
FROM awscc.pcaconnectorad.connectors_list_only
WHERE
  region = 'us-east-1';

INSERT example

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

Required Properties

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

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorad.connectors (
  CertificateAuthorityArn,
  DirectoryId,
  Tags,
  VpcInformation,
  region
)
SELECT
  '{{ certificate_authority_arn }}',
  '{{ directory_id }}',
  '{{ tags }}',
  '{{ vpc_information }}',
  '{{ region }}';

Manifest

version: 1
name: stack name
description: stack description
providers:
  - aws
globals:
  - name: region
    value: '{{ vars.AWS_REGION }}'
resources:
  - name: connector
    props:
      - name: certificate_authority_arn
        value: '{{ certificate_authority_arn }}'
      - name: directory_id
        value: '{{ directory_id }}'
      - name: tags
        value: {}
      - name: vpc_information
        value:
          security_group_ids:
            - '{{ security_group_ids[0] }}'
          ip_address_type: '{{ ip_address_type }}'

UPDATE example

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

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

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorad.connectors
WHERE
  Identifier = '{{ connector_arn }}' 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,
pca-connector-ad:TagResource

Read

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

Delete

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

List

pca-connector-ad:ListConnectors

Update

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