acmpca_create_certificate_authority_audit_report: Creates an audit report that lists every time that your CA...

Description Usage Arguments Value Request syntax

View source: R/acmpca_operations.R

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 issue_certificate and revoke_certificate actions use the private key.

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.

Usage

1
2
acmpca_create_certificate_authority_audit_report(
  CertificateAuthorityArn, S3BucketName, AuditReportResponseFormat)

Arguments

CertificateAuthorityArn

[required] 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 .

S3BucketName

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

AuditReportResponseFormat

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

Value

A list with the following syntax:

1
2
3
4
list(
  AuditReportId = "string",
  S3Key = "string"
)

Request syntax

1
2
3
4
5
svc$create_certificate_authority_audit_report(
  CertificateAuthorityArn = "string",
  S3BucketName = "string",
  AuditReportResponseFormat = "JSON"|"CSV"
)

paws.security.identity documentation built on Aug. 23, 2021, 9:16 a.m.