connectors

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

Overview

Name	connectors
Type	Resource
Id	aws.pca_connector_ad.connectors

Fields

The following fields are returned by SELECT queries:

get_connector

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateConnector. (pattern: <code>^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$</code>)
certificate_authority_arn	string	The Amazon Resource Name (ARN) of the certificate authority being used. (pattern: <code>^arn:[\w-]+:acm-pca:[\w-]+:[0-9]+:certificate-authority/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$</code>)
certificate_enrollment_policy_server_endpoint	string	Certificate enrollment endpoint for Active Directory domain-joined objects reach out to when requesting certificates.
created_at	string (date-time)	The date and time that the connector was created.
directory_id	string	The identifier of the Active Directory. (pattern: <code>^d-[0-9a-f]{10}$</code>)
status	string	Status of the connector. Status can be creating, active, deleting, or failed. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Additional information about the connector status if the status is failed. (CA_CERTIFICATE_REGISTRATION_FAILED, DIRECTORY_ACCESS_DENIED, INTERNAL_FAILURE, INSUFFICIENT_FREE_ADDRESSES, INVALID_SUBNET_IP_PROTOCOL, PRIVATECA_ACCESS_DENIED, PRIVATECA_RESOURCE_NOT_FOUND, SECURITY_GROUP_NOT_IN_VPC, VPC_ACCESS_DENIED, VPC_ENDPOINT_LIMIT_EXCEEDED, VPC_RESOURCE_NOT_FOUND)
updated_at	string (date-time)	The date and time that the connector was updated.
vpc_information	object	Information about your VPC and security groups used with the connector.

list_connectors

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateConnector. (pattern: <code>^arn:[\w-]+:pca-connector-ad:[\w-]+:[0-9]+:connector/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$</code>)
certificate_authority_arn	string	The Amazon Resource Name (ARN) of the certificate authority being used. (pattern: <code>^arn:[\w-]+:acm-pca:[\w-]+:[0-9]+:certificate-authority/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}$</code>)
certificate_enrollment_policy_server_endpoint	string	Certificate enrollment endpoint for Active Directory domain-joined objects to request certificates.
created_at	string (date-time)	The date and time that the connector was created.
directory_id	string	The identifier of the Active Directory. (pattern: <code>^d-[0-9a-f]{10}$</code>)
status	string	Status of the connector. Status can be creating, active, deleting, or failed. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Additional information about the connector status if the status is failed. (CA_CERTIFICATE_REGISTRATION_FAILED, DIRECTORY_ACCESS_DENIED, INTERNAL_FAILURE, INSUFFICIENT_FREE_ADDRESSES, INVALID_SUBNET_IP_PROTOCOL, PRIVATECA_ACCESS_DENIED, PRIVATECA_RESOURCE_NOT_FOUND, SECURITY_GROUP_NOT_IN_VPC, VPC_ACCESS_DENIED, VPC_ENDPOINT_LIMIT_EXCEEDED, VPC_RESOURCE_NOT_FOUND)
updated_at	string (date-time)	The date and time that the connector was updated.
vpc_information	object	Information about your VPC and security groups used with the connector.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connector	select	connector_arn, region		Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
list_connectors	select	region	MaxResults, NextToken	Lists the connectors that you created by using the https:​//docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
create_connector	insert	region, CertificateAuthorityArn, DirectoryId, VpcInformation		Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.
delete_connector	delete	connector_arn, region		Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https:​//docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https:​//docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

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
connector_arn	string	The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
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_connector

Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).

SELECT
arn,
certificate_authority_arn,
certificate_enrollment_policy_server_endpoint,
created_at,
directory_id,
status,
status_reason,
updated_at,
vpc_information
FROM aws.pca_connector_ad.connectors
WHERE connector_arn = '{{ connector_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_connectors

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

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

INSERT examples

create_connector

Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.

INSERT INTO aws.pca_connector_ad.connectors (
CertificateAuthorityArn,
ClientToken,
DirectoryId,
Tags,
VpcInformation,
region
)
SELECT 
'{{ CertificateAuthorityArn }}' /* required */,
'{{ ClientToken }}',
'{{ DirectoryId }}' /* required */,
'{{ Tags }}',
'{{ VpcInformation }}' /* required */,
'{{ region }}'
RETURNING
connector_arn
;

Manifest

# Description fields are for documentation purposes
- name: connectors
props:
  - name: region
    value: "{{ region }}"
    description: Required parameter for the connectors resource.
  - name: CertificateAuthorityArn
    value: "{{ CertificateAuthorityArn }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: DirectoryId
    value: "{{ DirectoryId }}"
  - name: Tags
    value: "{{ Tags }}"
  - name: VpcInformation
    description: |
      Information about your VPC and security groups used with the connector.
    value:
      IpAddressType: "{{ IpAddressType }}"
      SecurityGroupIds:
        - "{{ SecurityGroupIds }}"

DELETE examples

delete_connector

Deletes a connector for Active Directory. You must provide the Amazon Resource Name (ARN) of the connector that you want to delete. You can find the ARN by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_ListConnectors action. Deleting a connector does not deregister your directory with Amazon Web Services Private CA. You can deregister your directory by calling the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_DeleteDirectoryRegistration action.

DELETE FROM aws.pca_connector_ad.connectors
WHERE connector_arn = '{{ connector_arn }}' --required
AND region = '{{ region }}' --required
;