Client

pcaconnectorad

R Documentation

PcaConnectorAd¶

Description¶

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.

Usage¶

pcaconnectorad(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- pcaconnectorad(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

create_connector: Creates a connector between Amazon Web Services Private CA and an Active Directory
create_directory_registration: Creates a directory registration that authorizes communication between Amazon Web Services Private CA and an Active Directory
create_service_principal_name: Creates a service principal name (SPN) for the service account in Active Directory
create_template: Creates an Active Directory compatible certificate template; Create a group access control entry
delete_connector: Deletes a connector for Active Directory
delete_directory_registration: Deletes a directory registration
delete_service_principal_name: Deletes the service principal name (SPN) used by a connector to authenticate with your Active Directory
delete_template: Deletes a template; Deletes a group access control entry
get_connector: Lists information about your connector
get_directory_registration: A structure that contains information about your directory registration
get_service_principal_name: Lists the service principal name that the connector uses to authenticate with Active Directory
get_template: Retrieves a certificate template that the connector uses to issue certificates from a private CA; Retrieves the group access control entries for a template
list_connectors: Lists the connectors that you created by using the https://docs
list_directory_registrations: Lists the directory registrations that you created by using the https://docs
list_service_principal_names: Lists the service principal names that the connector uses to authenticate with Active Directory
list_tags_for_resource: Lists the tags, if any, that are associated with your resource; Lists group access control entries you created
list_templates: Lists the templates, if any, that are associated with a connector
tag_resource: Adds one or more tags to your resource
untag_resource: Removes one or more tags from your resource
update_template: Update template configuration to define the information included in certificates; Update a group access control entry you created using CreateTemplateGroupAccessControlEntry

Examples¶

## Not run: 
svc <- pcaconnectorad()
svc$create_connector(
  Foo = 123
)

## End(Not run)