Pca Connector Ad
This page documents function available when using the Pca_Connector_Ad module, created with @service Pca_Connector_Ad.
Index
Main.Pca_Connector_Ad.create_connectorMain.Pca_Connector_Ad.create_directory_registrationMain.Pca_Connector_Ad.create_service_principal_nameMain.Pca_Connector_Ad.create_templateMain.Pca_Connector_Ad.create_template_group_access_control_entryMain.Pca_Connector_Ad.delete_connectorMain.Pca_Connector_Ad.delete_directory_registrationMain.Pca_Connector_Ad.delete_service_principal_nameMain.Pca_Connector_Ad.delete_templateMain.Pca_Connector_Ad.delete_template_group_access_control_entryMain.Pca_Connector_Ad.get_connectorMain.Pca_Connector_Ad.get_directory_registrationMain.Pca_Connector_Ad.get_service_principal_nameMain.Pca_Connector_Ad.get_templateMain.Pca_Connector_Ad.get_template_group_access_control_entryMain.Pca_Connector_Ad.list_connectorsMain.Pca_Connector_Ad.list_directory_registrationsMain.Pca_Connector_Ad.list_service_principal_namesMain.Pca_Connector_Ad.list_tags_for_resourceMain.Pca_Connector_Ad.list_template_group_access_control_entriesMain.Pca_Connector_Ad.list_templatesMain.Pca_Connector_Ad.tag_resourceMain.Pca_Connector_Ad.untag_resourceMain.Pca_Connector_Ad.update_templateMain.Pca_Connector_Ad.update_template_group_access_control_entry
Documentation
Main.Pca_Connector_Ad.create_connector — Method
create_connector(certificate_authority_arn, directory_id, vpc_information)
create_connector(certificate_authority_arn, directory_id, vpc_information, params::Dict{String,<:Any})Creates a connector between Amazon Web Services Private CA and an Active Directory. You must specify the private CA, directory ID, and security groups.
Arguments
certificate_authority_arn: The Amazon Resource Name (ARN) of the certificate authority being used.directory_id: The identifier of the Active Directory.vpc_information: Security group IDs that describe the inbound and outbound rules.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Idempotency token."Tags": Metadata assigned to a connector consisting of a key-value pair.
Main.Pca_Connector_Ad.create_directory_registration — Method
create_directory_registration(directory_id)
create_directory_registration(directory_id, params::Dict{String,<:Any})Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
Arguments
directory_id: The identifier of the Active Directory.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Idempotency token."Tags": Metadata assigned to a directory registration consisting of a key-value pair.
Main.Pca_Connector_Ad.create_service_principal_name — Method
create_service_principal_name(connector_arn, directory_registration_arn)
create_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})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.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Idempotency token.
Main.Pca_Connector_Ad.create_template — Method
create_template(connector_arn, definition, name)
create_template(connector_arn, definition, name, params::Dict{String,<:Any})Creates an Active Directory compatible certificate template. The connectors issues certificates using these templates based on the requester’s Active Directory group membership.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.definition: Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings.name: Name of the template. The template name must be unique.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Idempotency token."Tags": Metadata assigned to a template consisting of a key-value pair.
Main.Pca_Connector_Ad.create_template_group_access_control_entry — Method
create_template_group_access_control_entry(access_rights, group_display_name, group_security_identifier, template_arn)
create_template_group_access_control_entry(access_rights, group_display_name, group_security_identifier, template_arn, params::Dict{String,<:Any})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).
Arguments
access_rights: Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template.group_display_name: Name of the Active Directory group. This name does not need to match the group name in Active Directory.group_security_identifier: Security identifier (SID) of the group object from Active Directory. The SID starts with "S-".template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"ClientToken": Idempotency token.
Main.Pca_Connector_Ad.delete_connector — Method
delete_connector(connector_arn)
delete_connector(connector_arn, params::Dict{String,<:Any})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/APIListConnectors 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/APIDeleteDirectoryRegistra tion action.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
Main.Pca_Connector_Ad.delete_directory_registration — Method
delete_directory_registration(directory_registration_arn)
delete_directory_registration(directory_registration_arn, params::Dict{String,<:Any})Deletes a directory registration. Deleting a directory registration deauthorizes Amazon Web Services Private CA with the directory.
Arguments
directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Main.Pca_Connector_Ad.delete_service_principal_name — Method
delete_service_principal_name(connector_arn, directory_registration_arn)
delete_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Main.Pca_Connector_Ad.delete_template — Method
delete_template(template_arn)
delete_template(template_arn, params::Dict{String,<:Any})Deletes a template. Certificates issued using the template are still valid until they are revoked or expired.
Arguments
template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Main.Pca_Connector_Ad.delete_template_group_access_control_entry — Method
delete_template_group_access_control_entry(group_security_identifier, template_arn)
delete_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})Deletes a group access control entry.
Arguments
group_security_identifier: Security identifier (SID) of the group object from Active Directory. The SID starts with "S-".template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Main.Pca_Connector_Ad.get_connector — Method
get_connector(connector_arn)
get_connector(connector_arn, params::Dict{String,<:Any})Lists information about your connector. You specify the connector on input by its ARN (Amazon Resource Name).
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
Main.Pca_Connector_Ad.get_directory_registration — Method
get_directory_registration(directory_registration_arn)
get_directory_registration(directory_registration_arn, params::Dict{String,<:Any})A structure that contains information about your directory registration.
Arguments
directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Main.Pca_Connector_Ad.get_service_principal_name — Method
get_service_principal_name(connector_arn, directory_registration_arn)
get_service_principal_name(connector_arn, directory_registration_arn, params::Dict{String,<:Any})Lists the service principal name that the connector uses to authenticate with Active Directory.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Main.Pca_Connector_Ad.get_template — Method
get_template(template_arn)
get_template(template_arn, params::Dict{String,<:Any})Retrieves a certificate template that the connector uses to issue certificates from a private CA.
Arguments
template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Main.Pca_Connector_Ad.get_template_group_access_control_entry — Method
get_template_group_access_control_entry(group_security_identifier, template_arn)
get_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})Retrieves the group access control entries for a template.
Arguments
group_security_identifier: Security identifier (SID) of the group object from Active Directory. The SID starts with "S-".template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Main.Pca_Connector_Ad.list_connectors — Method
list_connectors()
list_connectors(params::Dict{String,<:Any})Lists the connectors that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateConnector action.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items."NextToken": Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Main.Pca_Connector_Ad.list_directory_registrations — Method
list_directory_registrations()
list_directory_registrations(params::Dict{String,<:Any})Lists the directory registrations that you created by using the https://docs.aws.amazon.com/pca-connector-ad/latest/APIReference/API_CreateDirectoryRegistra tion action.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items."NextToken": Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Main.Pca_Connector_Ad.list_service_principal_names — Method
list_service_principal_names(directory_registration_arn)
list_service_principal_names(directory_registration_arn, params::Dict{String,<:Any})Lists the service principal names that the connector uses to authenticate with Active Directory.
Arguments
directory_registration_arn: The Amazon Resource Name (ARN) that was returned when you called CreateDirectoryRegistration.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items."NextToken": Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Main.Pca_Connector_Ad.list_tags_for_resource — Method
list_tags_for_resource(resource_arn)
list_tags_for_resource(resource_arn, params::Dict{String,<:Any})Lists the tags, if any, that are associated with your resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) that was returned when you created the resource.
Main.Pca_Connector_Ad.list_template_group_access_control_entries — Method
list_template_group_access_control_entries(template_arn)
list_template_group_access_control_entries(template_arn, params::Dict{String,<:Any})Lists group access control entries you created.
Arguments
template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items."NextToken": Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Main.Pca_Connector_Ad.list_templates — Method
list_templates(connector_arn)
list_templates(connector_arn, params::Dict{String,<:Any})Lists the templates, if any, that are associated with a connector.
Arguments
connector_arn: The Amazon Resource Name (ARN) that was returned when you called CreateConnector.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"MaxResults": Use this parameter when paginating results to specify the maximum number of items to return in the response on each page. If additional items exist beyond the number you specify, the NextToken element is sent in the response. Use this NextToken value in a subsequent request to retrieve additional items."NextToken": Use this parameter when paginating results in a subsequent request after you receive a response with truncated results. Set it to the value of the NextToken parameter from the response you just received.
Main.Pca_Connector_Ad.tag_resource — Method
tag_resource(resource_arn, tags)
tag_resource(resource_arn, tags, params::Dict{String,<:Any})Adds one or more tags to your resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) that was returned when you created the resource.tags: Metadata assigned to a directory registration consisting of a key-value pair.
Main.Pca_Connector_Ad.untag_resource — Method
untag_resource(resource_arn, tag_keys)
untag_resource(resource_arn, tag_keys, params::Dict{String,<:Any})Removes one or more tags from your resource.
Arguments
resource_arn: The Amazon Resource Name (ARN) that was returned when you created the resource.tag_keys: Specifies a list of tag keys that you want to remove from the specified resources.
Main.Pca_Connector_Ad.update_template — Method
update_template(template_arn)
update_template(template_arn, params::Dict{String,<:Any})Update template configuration to define the information included in certificates.
Arguments
template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"Definition": Template configuration to define the information included in certificates. Define certificate validity and renewal periods, certificate request handling and enrollment options, key usage extensions, application policies, and cryptography settings."ReenrollAllCertificateHolders": This setting allows the major version of a template to be increased automatically. All members of Active Directory groups that are allowed to enroll with a template will receive a new certificate issued using that template.
Main.Pca_Connector_Ad.update_template_group_access_control_entry — Method
update_template_group_access_control_entry(group_security_identifier, template_arn)
update_template_group_access_control_entry(group_security_identifier, template_arn, params::Dict{String,<:Any})Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.
Arguments
group_security_identifier: Security identifier (SID) of the group object from Active Directory. The SID starts with "S-".template_arn: The Amazon Resource Name (ARN) that was returned when you called CreateTemplate.
Optional Parameters
Optional parameters can be passed as a params::Dict{String,<:Any}. Valid keys are:
"AccessRights": Allow or deny permissions for an Active Directory group to enroll or autoenroll certificates for a template."GroupDisplayName": Name of the Active Directory group. This name does not need to match the group name in Active Directory.