[ aws . acm-pca ]

create-certificate-authority-audit-report

Description

Creates an audit report that lists every time that your CA private key is used. The report is saved in the Amazon S3 bucket that you specify on input. The IssueCertificate and RevokeCertificate actions use the private key.

Note

Both PCA and the IAM principal must have permission to write to the S3 bucket that you specify. If the IAM principal making the call does not have permission to write to the bucket, then an exception is thrown. For more information, see Configure Access to ACM Private CA .

ACM Private CAA assets that are stored in Amazon S3 can be protected with encryption. For more information, see Encrypting Your Audit Reports .

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-certificate-authority-audit-report
--certificate-authority-arn <value>
--s3-bucket-name <value>
--audit-report-response-format <value>
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--certificate-authority-arn (string)

The Amazon Resource Name (ARN) of the CA to be audited. This is of the form:

``arn:aws:acm-pca:region :account :certificate-authority/12345678-1234-1234-1234-123456789012 `` .

--s3-bucket-name (string)

The name of the S3 bucket that will contain the audit report.

--audit-report-response-format (string)

The format in which to create the report. This can be either JSON or CSV .

Possible values:

• JSON

• CSV

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those 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. This may not be specified along with --cli-input-yaml.

--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. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. 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.

Examples

To create a certificate authority audit report

The following create-certificate-authority-audit-report command creates an audit report for the private CA identified by the ARN.

aws acm-pca create-certificate-authority-audit-report --certificate-authority-arn arn:aws:acm-pca:us-east-1:accountid:certificate-authority/12345678-1234-1234-1234-123456789012 --s3-bucket-name your-bucket-name --audit-report-response-format JSON

Output

AuditReportId -> (string)

An alphanumeric string that contains a report identifier.

S3Key -> (string)

The key that uniquely identifies the report file in your S3 bucket.