ca_enrollment_policies
Creates, updates, deletes, gets or lists a ca_enrollment_policies resource.
Overview
| Name | ca_enrollment_policies |
| Type | Resource |
| Id | aws.ds.ca_enrollment_policies |
Fields
The following fields are returned by SELECT queries:
- describe_ca_enrollment_policy
| Name | Datatype | Description |
|---|---|---|
ca_enrollment_policy_status | string | The current status of the CA enrollment policy. This indicates if automatic certificate enrollment is currently active, inactive, or in a transitional state. Valid values: IN_PROGRESS - The policy is being activated T SUCCESS - The policy is active and automatic certificate enrollment is operational FAILED - The policy activation or deactivation failed DISABLING - The policy is being deactivated DISABLED - The policy is inactive and automatic certificate enrollment is not available IMPAIRED - Network connectivity is impaired. (InProgress, Success, Failed, Disabling, Disabled, Impaired) |
ca_enrollment_policy_status_reason | string | Additional information explaining the current status of the CA enrollment policy, particularly useful when the policy is in an error or transitional state. |
directory_id | string | The identifier of the directory associated with this CA enrollment policy. (pattern: <code>^d-[0-9a-f]{10}$</code>) |
last_updated_date_time | string (date-time) | The date and time when the CA enrollment policy was last modified or updated. |
pca_connector_arn | string | The Amazon Resource Name (ARN) of the Amazon Web Services Private Certificate Authority (PCA) connector that is configured for automatic certificate enrollment in this directory. (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>) |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_ca_enrollment_policy | select | region | Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority. |
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 |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_ca_enrollment_policy
Retrieves detailed information about the certificate authority (CA) enrollment policy for the specified directory. This policy determines how client certificates are automatically enrolled and managed through Amazon Web Services Private Certificate Authority.
SELECT
ca_enrollment_policy_status,
ca_enrollment_policy_status_reason,
directory_id,
last_updated_date_time,
pca_connector_arn
FROM aws.ds.ca_enrollment_policies
WHERE region = '{{ region }}' -- required
;