Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . ds ]

register-certificate

Description

Registers a certificate for a secure LDAP or client certificate authentication.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  register-certificate
--directory-id <value>
--certificate-data <value>
[--type <value>]
[--client-cert-auth-settings <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--directory-id (string)

The identifier of the directory.

--certificate-data (string)

The certificate PEM string that needs to be registered.

--type (string)

The function that the registered certificate performs. Valid values include ClientLDAPS or ClientCertAuth . The default value is ClientLDAPS .

Possible values:

  • ClientCertAuth
  • ClientLDAPS

--client-cert-auth-settings (structure)

A ClientCertAuthSettings object that contains client certificate authentication settings.

OCSPUrl -> (string)

Specifies the URL of the default OCSP server used to check for revocation status. A secondary value to any OCSP address found in the AIA extension of the user certificate.

Shorthand Syntax:

OCSPUrl=string

JSON Syntax:

{
  "OCSPUrl": "string"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

CertificateId -> (string)

The identifier of the certificate.