pcaconnectorad/aws.sdk.kotlin.services.pcaconnectorad/PcaConnectorAdClient

PcaConnectorAdClient

interface PcaConnectorAdClient : SdkClient

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.

Types

Builder

class Builder : AbstractSdkClientBuilder<PcaConnectorAdClient.Config, PcaConnectorAdClient.Config.Builder, PcaConnectorAdClient>

Companion

object Companion : AbstractAwsSdkClientFactory<PcaConnectorAdClient.Config, PcaConnectorAdClient.Config.Builder, PcaConnectorAdClient, PcaConnectorAdClient.Builder>

Config

class Config : AwsSdkClientConfig, CredentialsProviderConfig, HttpAuthConfig, HttpClientConfig, HttpEngineConfig, IdempotencyTokenConfig, RetryClientConfig, RetryStrategyClientConfig, SdkClientConfig, TelemetryConfig

Properties

config

abstract override val config: PcaConnectorAdClient.Config

PcaConnectorAdClient's configuration

Functions

createConnector

abstract suspend fun createConnector(input: CreateConnectorRequest): CreateConnectorResponse

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

createDirectoryRegistration

abstract suspend fun createDirectoryRegistration(input: CreateDirectoryRegistrationRequest): CreateDirectoryRegistrationResponse

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

createServicePrincipalName

abstract suspend fun createServicePrincipalName(input: CreateServicePrincipalNameRequest): CreateServicePrincipalNameResponse

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.

createTemplate

abstract suspend fun createTemplate(input: CreateTemplateRequest): CreateTemplateResponse

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

createTemplateGroupAccessControlEntry

abstract suspend fun createTemplateGroupAccessControlEntry(input: CreateTemplateGroupAccessControlEntryRequest): CreateTemplateGroupAccessControlEntryResponse

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

deleteConnector

abstract suspend fun deleteConnector(input: DeleteConnectorRequest): DeleteConnectorResponse

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.

deleteDirectoryRegistration

abstract suspend fun deleteDirectoryRegistration(input: DeleteDirectoryRegistrationRequest): DeleteDirectoryRegistrationResponse

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

deleteServicePrincipalName

abstract suspend fun deleteServicePrincipalName(input: DeleteServicePrincipalNameRequest): DeleteServicePrincipalNameResponse

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

deleteTemplate

abstract suspend fun deleteTemplate(input: DeleteTemplateRequest): DeleteTemplateResponse

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

deleteTemplateGroupAccessControlEntry

abstract suspend fun deleteTemplateGroupAccessControlEntry(input: DeleteTemplateGroupAccessControlEntryRequest): DeleteTemplateGroupAccessControlEntryResponse

Deletes a group access control entry.

getConnector

abstract suspend fun getConnector(input: GetConnectorRequest): GetConnectorResponse

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

getDirectoryRegistration

abstract suspend fun getDirectoryRegistration(input: GetDirectoryRegistrationRequest): GetDirectoryRegistrationResponse

A structure that contains information about your directory registration.

getServicePrincipalName

abstract suspend fun getServicePrincipalName(input: GetServicePrincipalNameRequest): GetServicePrincipalNameResponse

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

getTemplate

abstract suspend fun getTemplate(input: GetTemplateRequest): GetTemplateResponse

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

getTemplateGroupAccessControlEntry

abstract suspend fun getTemplateGroupAccessControlEntry(input: GetTemplateGroupAccessControlEntryRequest): GetTemplateGroupAccessControlEntryResponse

Retrieves the group access control entries for a template.

listConnectors

abstract suspend fun listConnectors(input: ListConnectorsRequest = ListConnectorsRequest { }): ListConnectorsResponse

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

listDirectoryRegistrations

abstract suspend fun listDirectoryRegistrations(input: ListDirectoryRegistrationsRequest = ListDirectoryRegistrationsRequest { }): ListDirectoryRegistrationsResponse

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

listServicePrincipalNames

abstract suspend fun listServicePrincipalNames(input: ListServicePrincipalNamesRequest): ListServicePrincipalNamesResponse

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

listTagsForResource

abstract suspend fun listTagsForResource(input: ListTagsForResourceRequest): ListTagsForResourceResponse

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

listTemplateGroupAccessControlEntries

abstract suspend fun listTemplateGroupAccessControlEntries(input: ListTemplateGroupAccessControlEntriesRequest): ListTemplateGroupAccessControlEntriesResponse

Lists group access control entries you created.

listTemplates

abstract suspend fun listTemplates(input: ListTemplatesRequest): ListTemplatesResponse

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

tagResource

abstract suspend fun tagResource(input: TagResourceRequest): TagResourceResponse

Adds one or more tags to your resource.

untagResource

abstract suspend fun untagResource(input: UntagResourceRequest): UntagResourceResponse

Removes one or more tags from your resource.

updateTemplate

abstract suspend fun updateTemplate(input: UpdateTemplateRequest): UpdateTemplateResponse

Update template configuration to define the information included in certificates.

updateTemplateGroupAccessControlEntry

abstract suspend fun updateTemplateGroupAccessControlEntry(input: UpdateTemplateGroupAccessControlEntryRequest): UpdateTemplateGroupAccessControlEntryResponse

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

Inherited functions

expect abstract fun close()

createConnector

inline suspend fun PcaConnectorAdClient.createConnector(crossinline block: CreateConnectorRequest.Builder.() -> Unit): CreateConnectorResponse

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

createDirectoryRegistration

inline suspend fun PcaConnectorAdClient.createDirectoryRegistration(crossinline block: CreateDirectoryRegistrationRequest.Builder.() -> Unit): CreateDirectoryRegistrationResponse

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

createServicePrincipalName

inline suspend fun PcaConnectorAdClient.createServicePrincipalName(crossinline block: CreateServicePrincipalNameRequest.Builder.() -> Unit): CreateServicePrincipalNameResponse

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.

createTemplate

inline suspend fun PcaConnectorAdClient.createTemplate(crossinline block: CreateTemplateRequest.Builder.() -> Unit): CreateTemplateResponse

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

createTemplateGroupAccessControlEntry

inline suspend fun PcaConnectorAdClient.createTemplateGroupAccessControlEntry(crossinline block: CreateTemplateGroupAccessControlEntryRequest.Builder.() -> Unit): CreateTemplateGroupAccessControlEntryResponse

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

deleteConnector

inline suspend fun PcaConnectorAdClient.deleteConnector(crossinline block: DeleteConnectorRequest.Builder.() -> Unit): DeleteConnectorResponse

deleteDirectoryRegistration

inline suspend fun PcaConnectorAdClient.deleteDirectoryRegistration(crossinline block: DeleteDirectoryRegistrationRequest.Builder.() -> Unit): DeleteDirectoryRegistrationResponse

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

deleteServicePrincipalName

inline suspend fun PcaConnectorAdClient.deleteServicePrincipalName(crossinline block: DeleteServicePrincipalNameRequest.Builder.() -> Unit): DeleteServicePrincipalNameResponse

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

deleteTemplate

inline suspend fun PcaConnectorAdClient.deleteTemplate(crossinline block: DeleteTemplateRequest.Builder.() -> Unit): DeleteTemplateResponse

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

deleteTemplateGroupAccessControlEntry

inline suspend fun PcaConnectorAdClient.deleteTemplateGroupAccessControlEntry(crossinline block: DeleteTemplateGroupAccessControlEntryRequest.Builder.() -> Unit): DeleteTemplateGroupAccessControlEntryResponse

Deletes a group access control entry.

getConnector

inline suspend fun PcaConnectorAdClient.getConnector(crossinline block: GetConnectorRequest.Builder.() -> Unit): GetConnectorResponse

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

getDirectoryRegistration

inline suspend fun PcaConnectorAdClient.getDirectoryRegistration(crossinline block: GetDirectoryRegistrationRequest.Builder.() -> Unit): GetDirectoryRegistrationResponse

A structure that contains information about your directory registration.

getServicePrincipalName

inline suspend fun PcaConnectorAdClient.getServicePrincipalName(crossinline block: GetServicePrincipalNameRequest.Builder.() -> Unit): GetServicePrincipalNameResponse

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

getTemplate

inline suspend fun PcaConnectorAdClient.getTemplate(crossinline block: GetTemplateRequest.Builder.() -> Unit): GetTemplateResponse

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

getTemplateGroupAccessControlEntry

inline suspend fun PcaConnectorAdClient.getTemplateGroupAccessControlEntry(crossinline block: GetTemplateGroupAccessControlEntryRequest.Builder.() -> Unit): GetTemplateGroupAccessControlEntryResponse

Retrieves the group access control entries for a template.

listConnectors

inline suspend fun PcaConnectorAdClient.listConnectors(crossinline block: ListConnectorsRequest.Builder.() -> Unit): ListConnectorsResponse

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

listDirectoryRegistrations

inline suspend fun PcaConnectorAdClient.listDirectoryRegistrations(crossinline block: ListDirectoryRegistrationsRequest.Builder.() -> Unit): ListDirectoryRegistrationsResponse

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

listServicePrincipalNames

inline suspend fun PcaConnectorAdClient.listServicePrincipalNames(crossinline block: ListServicePrincipalNamesRequest.Builder.() -> Unit): ListServicePrincipalNamesResponse

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

listTagsForResource

inline suspend fun PcaConnectorAdClient.listTagsForResource(crossinline block: ListTagsForResourceRequest.Builder.() -> Unit): ListTagsForResourceResponse

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

listTemplateGroupAccessControlEntries

inline suspend fun PcaConnectorAdClient.listTemplateGroupAccessControlEntries(crossinline block: ListTemplateGroupAccessControlEntriesRequest.Builder.() -> Unit): ListTemplateGroupAccessControlEntriesResponse

Lists group access control entries you created.

listTemplates

inline suspend fun PcaConnectorAdClient.listTemplates(crossinline block: ListTemplatesRequest.Builder.() -> Unit): ListTemplatesResponse

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

tagResource

inline suspend fun PcaConnectorAdClient.tagResource(crossinline block: TagResourceRequest.Builder.() -> Unit): TagResourceResponse

Adds one or more tags to your resource.

untagResource

inline suspend fun PcaConnectorAdClient.untagResource(crossinline block: UntagResourceRequest.Builder.() -> Unit): UntagResourceResponse

Removes one or more tags from your resource.

updateTemplate

inline suspend fun PcaConnectorAdClient.updateTemplate(crossinline block: UpdateTemplateRequest.Builder.() -> Unit): UpdateTemplateResponse

Update template configuration to define the information included in certificates.

updateTemplateGroupAccessControlEntry

inline suspend fun PcaConnectorAdClient.updateTemplateGroupAccessControlEntry(crossinline block: UpdateTemplateGroupAccessControlEntryRequest.Builder.() -> Unit): UpdateTemplateGroupAccessControlEntryResponse

Update a group access control entry you created using CreateTemplateGroupAccessControlEntry.

withConfig

fun PcaConnectorAdClient.withConfig(block: PcaConnectorAdClient.Config.Builder.() -> Unit): PcaConnectorAdClient

Create a copy of the client with one or more configuration values overridden. This method allows the caller to perform scoped config overrides for one or more client operations.