connectors

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

Overview

Name	connectors
Type	Resource
Id	aws.pca_connector_scep.connectors

Fields

The following fields are returned by SELECT queries:

get_connector

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the connector. (pattern: <code>arn:aws(-[a-z]+):pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d:\d{12}: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 associated with the connector. (pattern: <code>arn:aws(-[a-z]+):acm-pca:[a-z]+(-[a-z]+)+-[1-9]\d:\d{12}:certificate-authority/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}</code>)
created_at	string (date-time)	The date and time that the connector was created.
endpoint	string	The connector's HTTPS public SCEP URL.
mobile_device_management	object	If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations. If you provide an IntuneConfiguration, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.
open_id_configuration	object	Contains OpenID Connect (OIDC) parameters for use with Connector for SCEP for Microsoft Intune. For more information about using Connector for SCEP for Microsoft Intune, see Using Connector for SCEP for Microsoft Intune.
status	string	The connector's status. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Information about why connector creation failed, if status is FAILED. (INTERNAL_FAILURE, PRIVATECA_ACCESS_DENIED, PRIVATECA_INVALID_STATE, PRIVATECA_RESOURCE_NOT_FOUND, VPC_ENDPOINT_RESOURCE_NOT_FOUND, VPC_ENDPOINT_DNS_ENTRIES_NOT_FOUND)
type	string	The connector type. (GENERAL_PURPOSE, INTUNE)
updated_at	string (date-time)	The date and time that the connector was updated.

list_connectors

Name	Datatype	Description
arn	string	The Amazon Resource Name (ARN) of the connector. (pattern: <code>arn:aws(-[a-z]+):pca-connector-scep:[a-z]+(-[a-z]+)+-[1-9]\d:\d{12}: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 connector's associated certificate authority. (pattern: <code>arn:aws(-[a-z]+):acm-pca:[a-z]+(-[a-z]+)+-[1-9]\d:\d{12}:certificate-authority/[0-9a-f]{8}(-[0-9a-f]{4}){3}-[0-9a-f]{12}</code>)
created_at	string (date-time)	The date and time that the challenge was created.
endpoint	string	The connector's HTTPS public SCEP URL.
mobile_device_management	object	If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations. If you provide an IntuneConfiguration, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.
open_id_configuration	object	Contains OpenID Connect (OIDC) parameters for use with Microsoft Intune.
status	string	The connector's status. Status can be creating, active, deleting, or failed. (CREATING, ACTIVE, DELETING, FAILED)
status_reason	string	Information about why connector creation failed, if status is FAILED. (INTERNAL_FAILURE, PRIVATECA_ACCESS_DENIED, PRIVATECA_INVALID_STATE, PRIVATECA_RESOURCE_NOT_FOUND, VPC_ENDPOINT_RESOURCE_NOT_FOUND, VPC_ENDPOINT_DNS_ENTRIES_NOT_FOUND)
type	string	The connector type. (GENERAL_PURPOSE, INTUNE)
updated_at	string (date-time)	The date and time that the challenge was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_connector	select	connector_arn, region		Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.
list_connectors	select	region	MaxResults, NextToken	Lists the connectors belonging to your Amazon Web Services account.
create_connector	insert	region, CertificateAuthorityArn		Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.
delete_connector	delete	connector_arn, region		Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

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) of the connector to delete.
region	string	AWS region (default: us-east-1)
MaxResults	integer	The maximum number of objects that you want Connector for SCEP to return for this request. If more objects are available, in the response, Connector for SCEP provides a NextToken value that you can use in a subsequent call to get the next batch of objects.
NextToken	string	When you request a list of objects with a MaxResults setting, if the number of objects that are still available for retrieval exceeds the maximum you requested, Connector for SCEP returns a NextToken value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.

SELECT examples

get_connector

Retrieves details about the specified Connector. Calling this action returns important details about the connector, such as the public SCEP URL where your clients can request certificates.

SELECT
arn,
certificate_authority_arn,
created_at,
endpoint,
mobile_device_management,
open_id_configuration,
status,
status_reason,
type,
updated_at
FROM aws.pca_connector_scep.connectors
WHERE connector_arn = '{{ connector_arn }}' -- required
AND region = '{{ region }}' -- required
;

list_connectors

Lists the connectors belonging to your Amazon Web Services account.

SELECT
arn,
certificate_authority_arn,
created_at,
endpoint,
mobile_device_management,
open_id_configuration,
status,
status_reason,
type,
updated_at
FROM aws.pca_connector_scep.connectors
WHERE region = '{{ region }}' -- required
AND MaxResults = '{{ MaxResults }}'
AND NextToken = '{{ NextToken }}'
;

INSERT examples

create_connector

Creates a SCEP connector. A SCEP connector links Amazon Web Services Private Certificate Authority to your SCEP-compatible devices and mobile device management (MDM) systems. Before you create a connector, you must complete a set of prerequisites, including creation of a private certificate authority (CA) to use with this connector. For more information, see Connector for SCEP prerequisites.

INSERT INTO aws.pca_connector_scep.connectors (
CertificateAuthorityArn,
MobileDeviceManagement,
VpcEndpointId,
ClientToken,
Tags,
region
)
SELECT 
'{{ CertificateAuthorityArn }}' /* required */,
'{{ MobileDeviceManagement }}',
'{{ VpcEndpointId }}',
'{{ ClientToken }}',
'{{ Tags }}',
'{{ 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: MobileDeviceManagement
    description: |
      If you don't supply a value, by default Connector for SCEP creates a connector for general-purpose use. A general-purpose connector is designed to work with clients or endpoints that support the SCEP protocol, except Connector for SCEP for Microsoft Intune. For information about considerations and limitations with using Connector for SCEP, see Considerations and Limitations. If you provide an IntuneConfiguration, Connector for SCEP creates a connector for use with Microsoft Intune, and you manage the challenge passwords using Microsoft Intune. For more information, see Using Connector for SCEP for Microsoft Intune.
    value:
      Intune:
        AzureApplicationId: "{{ AzureApplicationId }}"
        Domain: "{{ Domain }}"
  - name: VpcEndpointId
    value: "{{ VpcEndpointId }}"
  - name: ClientToken
    value: "{{ ClientToken }}"
  - name: Tags
    value: "{{ Tags }}"

DELETE examples

delete_connector

Deletes the specified Connector. This operation also deletes any challenges associated with the connector.

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