View Source AWS.PcaConnectorAd (aws-elixir v1.0.0)

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.

Summary

Functions

create_connector(client, input, options \\ [])

Creates a connector between Amazon Web Services Private CA and an Active Directory.

create_directory_registration(client, input, options \\ [])

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

create_service_principal_name(client, connector_arn, directory_registration_arn, input, options \\ [])

Creates a service principal name (SPN) for the service account in Active Directory.

create_template(client, input, options \\ [])

Creates an Active Directory compatible certificate template.

create_template_group_access_control_entry(client, template_arn, input, options \\ [])

Create a group access control entry.

delete_connector(client, connector_arn, input, options \\ [])

Deletes a connector for Active Directory.

delete_directory_registration(client, directory_registration_arn, input, options \\ [])

Deletes a directory registration.

delete_service_principal_name(client, connector_arn, directory_registration_arn, input, options \\ [])

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

delete_template(client, template_arn, input, options \\ [])

Deletes a template.

delete_template_group_access_control_entry(client, group_security_identifier, template_arn, input, options \\ [])

Deletes a group access control entry.

get_connector(client, connector_arn, options \\ [])

Lists information about your connector.

get_directory_registration(client, directory_registration_arn, options \\ [])

A structure that contains information about your directory registration.

get_service_principal_name(client, connector_arn, directory_registration_arn, options \\ [])

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

get_template(client, template_arn, options \\ [])

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

get_template_group_access_control_entry(client, group_security_identifier, template_arn, options \\ [])

Retrieves the group access control entries for a template.

list_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_directory_registrations(client, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_service_principal_names(client, directory_registration_arn, max_results \\ nil, next_token \\ nil, options \\ [])

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

list_tags_for_resource(client, resource_arn, options \\ [])

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

list_template_group_access_control_entries(client, template_arn, max_results \\ nil, next_token \\ nil, options \\ [])

Lists group access control entries you created.

list_templates(client, connector_arn, max_results \\ nil, next_token \\ nil, options \\ [])

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

metadata()
tag_resource(client, resource_arn, input, options \\ [])

Adds one or more tags to your resource.

untag_resource(client, resource_arn, input, options \\ [])

Removes one or more tags from your resource.

update_template(client, template_arn, input, options \\ [])

Update template configuration to define the information included in certificates.

update_template_group_access_control_entry(client, group_security_identifier, template_arn, input, options \\ [])

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Functions

Link to this function

create_connector(client, input, options \\ [])

View Source

Creates a connector between Amazon Web Services Private CA and an Active Directory.

You must specify the private CA, directory ID, and security groups.

Link to this function

create_directory_registration(client, input, options \\ [])

View Source

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

Link to this function

create_service_principal_name(client, connector_arn, directory_registration_arn, input, options \\ [])

View Source

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.

Link to this function

create_template(client, input, options \\ [])

View Source

Creates an Active Directory compatible certificate template.

The connectors issues certificates using these templates based on the requester’s Active Directory group membership.

Link to this function

create_template_group_access_control_entry(client, template_arn, input, options \\ [])

View Source

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).

Link to this function

delete_connector(client, connector_arn, input, options \\ [])

View Source

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.

Link to this function

delete_directory_registration(client, directory_registration_arn, input, options \\ [])

View Source

Deletes a directory registration.

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

Link to this function

delete_service_principal_name(client, connector_arn, directory_registration_arn, input, options \\ [])

View Source

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

Link to this function

delete_template(client, template_arn, input, options \\ [])

View Source

Deletes a template.

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

Link to this function

delete_template_group_access_control_entry(client, group_security_identifier, template_arn, input, options \\ [])

View Source

Deletes a group access control entry.

Link to this function

get_connector(client, connector_arn, options \\ [])

View Source

Lists information about your connector.

You specify the connector on input by its ARN (Amazon Resource Name).

Link to this function

get_directory_registration(client, directory_registration_arn, options \\ [])

View Source

A structure that contains information about your directory registration.

Link to this function

get_service_principal_name(client, connector_arn, directory_registration_arn, options \\ [])

View Source

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

Link to this function

get_template(client, template_arn, options \\ [])

View Source

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

Link to this function

get_template_group_access_control_entry(client, group_security_identifier, template_arn, options \\ [])

View Source

Retrieves the group access control entries for a template.

Link to this function

list_connectors(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_directory_registrations(client, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_service_principal_names(client, directory_registration_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

list_tags_for_resource(client, resource_arn, options \\ [])

View Source

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

Link to this function

list_template_group_access_control_entries(client, template_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

Lists group access control entries you created.

Link to this function

list_templates(client, connector_arn, max_results \\ nil, next_token \\ nil, options \\ [])

View Source

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

Link to this function

metadata()

View Source
Link to this function

tag_resource(client, resource_arn, input, options \\ [])

View Source

Adds one or more tags to your resource.

Link to this function

untag_resource(client, resource_arn, input, options \\ [])

View Source

Removes one or more tags from your resource.

Link to this function

update_template(client, template_arn, input, options \\ [])

View Source

Update template configuration to define the information included in certificates.

Link to this function

update_template_group_access_control_entry(client, group_security_identifier, template_arn, input, options \\ [])

View Source

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.