@aws-lite/acm
v0.0.3
Published
Official `aws-lite` plugin for ACM
Downloads
41
Keywords
Readme
@aws-lite/acm
Official
aws-liteplugin for ACM
Maintained by: @architect
Install
npm i @aws-lite/acmOptionally install types:
npm i -D @aws-lite/acm-typesReference
Reference documentation with examples at aws-lite.org
Reference
Reference documentation with examples at aws-lite.org
Methods
DeleteCertificate
Properties:
CertificateArn(string) [required]- ARN of the ACM certificate
DescribeCertificate
Properties:
CertificateArn(string) [required]- ARN of the ACM certificate
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
- Array of status values (strings) to define a filter for certificates; array can contain:
Includes(object)- Object defining a filter for the certificate list
- More details (AWS)
MaxItems(number)- Maximum number of values to be returned
NextToken(string)- Pagination token
SortBy(string)- Specify the create date to sort results; must also specify
SortOrder
- Specify the create date to sort results; must also specify
SortOrder(string)- Specify the order results will be sorted; value can be one of:
ASCENDING,DESCENDING, must also specifySortBy
- Specify the order results will be sorted; value can be one of:
paginate(boolean, string)- Enable automatic result pagination; use this instead of making your own individual pagination requests
RequestCertificate
Properties:
DomainName(string) [required]- Domain name to be secured with an ACM certificate; use
*as a wildcard; example:example.*.com
- Domain name to be secured with an ACM certificate; use
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)
DomainValidationOptions(array)- Array containing 1 to 100
DomainValidationOptionobjects that tell ACM where to send emails to validate domain ownership - More details (AWS)
- Array containing 1 to 100
IdempotencyToken(string)- Identifier used to distinguish between calls to
RequestCertificate - More details (AWS)
- Identifier used to distinguish between calls to
KeyAlgorithm(string)- Specify the encryption algorithm used to generate public/private keys (default: RSA); can be one of:
RSA_1024,RSA_2048,RSA_3072,RSA_4096,EC_prime256v1,EC_secp384r1,EC_secp521r1 - More details (AWS)
- Specify the encryption algorithm used to generate public/private keys (default: RSA); can be one of:
Options(object)CertificateOptionsobject to specify if the certificate will be added to a transparency log- More details (AWS)
SubjectAlternativeNames(array)- Array containing 1 to 50
FQDNs to be included in the Subject Alternative Name extension of the ACM certificate - More details (AWS)
- Array containing 1 to 50
Tags(array)- Array containing 1 to 50
Tagobjects to be associated with the certificate - More details (AWS)
- Array containing 1 to 50
ValidationMethod(string)- Method to use when requesting a public certificate to validate ownership of the domain being secured; can be one of:
EMAIL,DNS
- Method to use when requesting a public certificate to validate ownership of the domain being secured; can be one of:
Methods yet to be implemented
Please help out by opening a PR!
AddTagsToCertificateExportCertificateGetAccountConfigurationGetCertificateImportCertificateListTagsForCertificatePutAccountConfigurationRemoveTagsFromCertificateRenewCertificateResendValidationEmailUpdateCertificateOptions
