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 allows certificate issuance through Simple Certificate Enrollment Protocol (SCEP)
Id	awscc.pcaconnectorscep.connectors

Fields

get (all properties)

Name	Datatype	Description
certificate_authority_arn	string
connector_arn	string
type	string
endpoint	string
mobile_device_management	object
▶open_id_configuration	object
tags	object
region	string	AWS region.

list (identifiers only)

Name	Datatype	Description
connector_arn	string
region	string	AWS region.

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

Methods

Name	Resource	Accessible by	Required Params
create_resource	connectors	INSERT	CertificateAuthorityArn, 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,
  type,
  endpoint,
  mobile_device_management,
  open_id_configuration,
  tags
FROM awscc.pcaconnectorscep.connectors
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_arn }}';

list (identifiers only)

Lists all connectors in a region.

SELECT
  region,
  connector_arn
FROM awscc.pcaconnectorscep.connectors_list_only
WHERE
  region = '{{ region }}';

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.pcaconnectorscep.connectors (
  CertificateAuthorityArn,
  region
)
SELECT
  '{{ certificate_authority_arn }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

All Properties

/*+ create */
INSERT INTO awscc.pcaconnectorscep.connectors (
  CertificateAuthorityArn,
  MobileDeviceManagement,
  Tags,
  region
)
SELECT
  '{{ certificate_authority_arn }}',
  '{{ mobile_device_management }}',
  '{{ tags }}',
  '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

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: mobile_device_management
      value: {}
    - name: tags
      value: {}

UPDATE example

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

/*+ update */
UPDATE awscc.pcaconnectorscep.connectors
SET PatchDocument = string('{{ {
    "Tags": tags
} | generate_patch_document }}')
WHERE
  region = '{{ region }}' AND
  Identifier = '{{ connector_arn }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

DELETE example

/*+ delete */
DELETE FROM awscc.pcaconnectorscep.connectors
WHERE
  Identifier = '{{ connector_arn }}' AND
  region = '{{ region }}'
RETURNING
  ErrorCode,
  EventTime,
  Identifier,
  Operation,
  OperationStatus,
  RequestToken,
  ResourceModel,
  RetryAfter,
  StatusMessage,
  TypeName
;

Additional Parameters

Mutable resources in the Cloud Control provider support additional optional parameters which can be supplied with INSERT, UPDATE, or DELETE operations. These include:

Parameter	Description
ClientToken	A unique identifier to ensure the idempotency of the resource request. This allows the provider to accurately distinguish between retries and new requests. A client token is valid for 36 hours once used. After that, a resource request with the same client token is treated as a new request. If you do not specify a client token, one is generated for inclusion in the request.
RoleArn	The ARN of the IAM role used to perform this resource operation. The role specified must have the permissions required for this operation. If you do not specify a role, a temporary session is created using your AWS user credentials.
TypeVersionId	For private resource types, the type version to use in this resource operation. If you do not specify a resource version, the default version is used.

Permissions

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

Create

acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificate,
acm-pca:GetCertificateAuthorityCertificate,
acm-pca:IssueCertificate,
pca-connector-scep:GetConnector,
pca-connector-scep:CreateConnector,
pca-connector-scep:TagResource

Read

pca-connector-scep:ListTagsForResource,
pca-connector-scep:GetConnector

Delete

acm-pca:DescribeCertificateAuthority,
acm-pca:GetCertificate,
acm-pca:GetCertificateAuthorityCertificate,
acm-pca:IssueCertificate,
pca-connector-scep:GetConnector,
pca-connector-scep:DeleteConnector,
pca-connector-scep:UntagResource

List

pca-connector-scep:ListConnectors

Update

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