@aws-lite/acm
Maintained by: @architect
Install
npm i @aws-lite/acm
Optionally install types:
npm i -D @aws-lite/acm-types
Methods
DeleteCertificate
Properties
CertificateArn
(string) [required]-
ARN of the ACM certificate
Example
await aws.ACM.DeleteCertificate({
CertificateArn: String, // required
})
DescribeCertificate
Properties
CertificateArn
(string) [required]-
ARN of the ACM certificate
Example
await aws.ACM.DescribeCertificate({
CertificateArn: String, // required
})
ListCertificates
Properties
CertificateStatuses
(array)-
Array of status values (strings) to define a filter for certificates; array can contain:
PENDING_VALIDATION
,ISSUED
,INACTIVE
,EXPIRED
,VALIDATION_TIMED_OUT
,REVOKED
,FAILED
Includes
(object)-
Object defining a filter for the certificate list
- Example
await aws.ACM.ListCertificates({ CertificateStatuses: Array, Includes: Object, MaxItems: Number, NextToken: String, SortBy: String, SortOrder: String, paginate: Boolean || String, })
RequestCertificate
Properties
DomainName
(string) [required]-
Domain name to be secured with an ACM certificate; use
*
as a wildcard; example:example.*.com
CertificateAuthorityArn
(string)-
ARN of a private certificate authority that will issue the certificate; ACM will attempt to issue a public certificate if this is not defined
- More details (AWS)
IdempotencyToken
(string)-
Identifier used to distinguish between calls to
RequestCertificate
- More details (AWS)
Options
(object)-
CertificateOptions
object to specify if the certificate will be added to a transparency log - More details (AWS)
Tags
(array)-
Array containing 1 to 50
Tag
objects to be associated with the certificate - Example
await aws.ACM.RequestCertificate({ DomainName: String, // required CertificateAuthorityArn: String, DomainValidationOptions: Array, IdempotencyToken: String, KeyAlgorithm: String, Options: Object, SubjectAlternativeNames: Array, Tags: Array, ValidationMethod: String, })
Methods yet to be implemented
Please help out by opening a PR!