PcaConnectorAdClient

Amazon Web Services Private CA Connector for Active Directory creates a connector between Amazon Web Services Private CA and Active Directory (AD) that enables you to provision security certificates for AD signed by a private CA that you own. For more information, see Amazon Web Services Private CA Connector for Active Directory .

Installation

NPM
npm install @aws-sdk/client-pca-connector-ad
Yarn
yarn add @aws-sdk/client-pca-connector-ad
pnpm
pnpm add @aws-sdk/client-pca-connector-ad

PcaConnectorAdClient Operations

Command
Summary
CreateConnectorCommand

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

CreateDirectoryRegistrationCommand

Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory

CreateServicePrincipalNameCommand

Creates a service principal name (SPN) for the service account in Active Directory. Kerberos authentication uses SPNs to associate a service instance with a service sign-in account.

CreateTemplateCommand

Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.

CreateTemplateGroupAccessControlEntryCommand

Create a group access control entry. Allow or deny Active Directory groups from enrolling and/or autoenrolling with the template based on the group security identifiers (SIDs).

DeleteConnectorCommand

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.

DeleteDirectoryRegistrationCommand

Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.

DeleteServicePrincipalNameCommand

Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.

DeleteTemplateCommand

Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.

DeleteTemplateGroupAccessControlEntryCommand

Deletes a group access control entry.

GetConnectorCommand

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

GetDirectoryRegistrationCommand

A structure that contains information about your directory registration.

GetServicePrincipalNameCommand

Lists the service principal name that the connector uses to authenticate with Active Directory.

GetTemplateCommand

Retrieves a certificate template that the connector uses to issue certificates from a private CA.

GetTemplateGroupAccessControlEntryCommand

Retrieves the group access control entries for a template.

ListConnectorsCommand
ListDirectoryRegistrationsCommand
ListServicePrincipalNamesCommand

Lists the service principal names that the connector uses to authenticate with Active Directory.

ListTagsForResourceCommand

Lists the tags, if any, that are associated with your resource.

ListTemplateGroupAccessControlEntriesCommand

Lists group access control entries you created.

ListTemplatesCommand

Lists the templates, if any, that are associated with a connector.

TagResourceCommand

Adds one or more tags to your resource.

UntagResourceCommand

Removes one or more tags from your resource.

UpdateTemplateCommand

Update template configuration to define the information included in certificates.

UpdateTemplateGroupAccessControlEntryCommand

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry .

PcaConnectorAdClient Configuration

Parameter
Type
Description
defaultsMode
Optional
DefaultsMode | Provider<DefaultsMode>
The @smithy/smithy-client#DefaultsMode that will be used to determine how certain default configuration options are resolved in the SDK.
disableHostPrefix
Optional
boolean
Disable dynamically changing the endpoint of the client based on the hostPrefix trait of an operation.
extensions
Optional
RuntimeExtension[]
Optional extensions
logger
Optional
Logger
Optional logger for logging debug/info/warn/error.
maxAttempts
Optional
number | Provider<number>
Value for how many times a request will be made at most in case of retry.
profile
Optional
string
Setting a client profile is similar to setting a value for the AWS_PROFILE environment variable. Setting a profile on a client in code only affects the single client instance, unlike AWS_PROFILE.When set, and only for environments where an AWS configuration file exists, fields configurable by this file will be retrieved from the specified profile within that file. Conflicting code configuration and environment variables will still have higher priority.For client credential resolution that involves checking the AWS configuration file, the client's profile (this value) will be used unless a different profile is set in the credential provider options.
region
Optional
string | Provider<string>
The AWS region to which this client will send requests
requestHandler
Optional
__HttpHandlerUserInput
The HTTP handler to use or its constructor options. Fetch in browser and Https in Nodejs.
retryMode
Optional
string | Provider<string>
Specifies which retry algorithm to use.
useDualstackEndpoint
Optional
boolean | Provider<boolean>
Enables IPv6/IPv4 dualstack endpoint.
useFipsEndpoint
Optional
boolean | Provider<boolean>
Enables FIPS compatible endpoints.
Additional config fields are described in the full configuration type: PcaConnectorAdClientConfig