@datafire/amazonaws_acm_pca
v5.0.0
Published
DataFire integration for AWS Certificate Manager Private Certificate Authority
Downloads
3
Readme
@datafire/amazonaws_acm_pca
Client library for AWS Certificate Manager Private Certificate Authority
Installation and Usage
npm install --save @datafire/amazonaws_acm_pca
let amazonaws_acm_pca = require('@datafire/amazonaws_acm_pca').create({
accessKeyId: "",
secretAccessKey: "",
region: ""
});
amazonaws_acm_pca.CreateCertificateAuthority({
"CertificateAuthorityConfiguration": {
"KeyAlgorithm": "",
"SigningAlgorithm": "",
"Subject": {}
},
"CertificateAuthorityType": ""
}).then(data => {
console.log(data);
});
Description
Actions
CreateCertificateAuthority
amazonaws_acm_pca.CreateCertificateAuthority({
"CertificateAuthorityConfiguration": {
"KeyAlgorithm": "",
"SigningAlgorithm": "",
"Subject": {}
},
"CertificateAuthorityType": ""
}, context)
Input
- input
object
- CertificateAuthorityConfiguration required CertificateAuthorityConfiguration
- CertificateAuthorityType required CertificateAuthorityType
- IdempotencyToken IdempotencyToken
- RevocationConfiguration RevocationConfiguration
Output
CreateCertificateAuthorityAuditReport
amazonaws_acm_pca.CreateCertificateAuthorityAuditReport({
"CertificateAuthorityArn": "",
"S3BucketName": "",
"AuditReportResponseFormat": ""
}, context)
Input
- input
object
- AuditReportResponseFormat required AuditReportResponseFormat
- CertificateAuthorityArn required Arn
- S3BucketName required String
Output
DeleteCertificateAuthority
amazonaws_acm_pca.DeleteCertificateAuthority({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
Output
Output schema unknown
DescribeCertificateAuthority
amazonaws_acm_pca.DescribeCertificateAuthority({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
Output
DescribeCertificateAuthorityAuditReport
amazonaws_acm_pca.DescribeCertificateAuthorityAuditReport({
"CertificateAuthorityArn": "",
"AuditReportId": ""
}, context)
Input
- input
object
- AuditReportId required AuditReportId
- CertificateAuthorityArn required Arn
Output
GetCertificate
amazonaws_acm_pca.GetCertificate({
"CertificateAuthorityArn": "",
"CertificateArn": ""
}, context)
Input
Output
- output GetCertificateResponse
GetCertificateAuthorityCertificate
amazonaws_acm_pca.GetCertificateAuthorityCertificate({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
Output
GetCertificateAuthorityCsr
amazonaws_acm_pca.GetCertificateAuthorityCsr({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
Output
ImportCertificateAuthorityCertificate
amazonaws_acm_pca.ImportCertificateAuthorityCertificate({
"CertificateAuthorityArn": "",
"Certificate": "",
"CertificateChain": ""
}, context)
Input
- input
object
- Certificate required CertificateBodyBlob
- CertificateAuthorityArn required Arn
- CertificateChain required CertificateChainBlob
Output
Output schema unknown
IssueCertificate
amazonaws_acm_pca.IssueCertificate({
"CertificateAuthorityArn": "",
"Csr": "",
"SigningAlgorithm": "",
"Validity": {
"Value": 0,
"Type": ""
}
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
- Csr required CsrBlob
- IdempotencyToken IdempotencyToken
- SigningAlgorithm required SigningAlgorithm
- Validity required Validity
Output
- output IssueCertificateResponse
ListCertificateAuthorities
amazonaws_acm_pca.ListCertificateAuthorities({}, context)
Input
- input
object
- MaxResults MaxResults
- NextToken NextToken
Output
ListTags
amazonaws_acm_pca.ListTags({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
- MaxResults MaxResults
- NextToken NextToken
Output
- output ListTagsResponse
RevokeCertificate
amazonaws_acm_pca.RevokeCertificate({
"CertificateAuthorityArn": "",
"CertificateSerial": "",
"RevocationReason": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
- CertificateSerial required String128
- RevocationReason required RevocationReason
Output
Output schema unknown
TagCertificateAuthority
amazonaws_acm_pca.TagCertificateAuthority({
"CertificateAuthorityArn": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
UntagCertificateAuthority
amazonaws_acm_pca.UntagCertificateAuthority({
"CertificateAuthorityArn": "",
"Tags": []
}, context)
Input
Output
Output schema unknown
UpdateCertificateAuthority
amazonaws_acm_pca.UpdateCertificateAuthority({
"CertificateAuthorityArn": ""
}, context)
Input
- input
object
- CertificateAuthorityArn required Arn
- RevocationConfiguration RevocationConfiguration
- Status CertificateAuthorityStatus
Output
Output schema unknown
Definitions
ASN1Subject
- ASN1Subject
object
: Contains information about the certificate subject. The certificate can be one issued by your private certificate authority (CA) or it can be your private CA certificate. The Subject field in the certificate identifies the entity that owns or controls the public key in the certificate. The entity can be a user, computer, device, or service. The Subject must contain an X.500 distinguished name (DN). A DN is a sequence of relative distinguished names (RDNs). The RDNs are separated by commas in the certificate. The DN must be unique for each for each entity, but your private CA can issue more than one certificate with the same DN to the same entity.- CommonName String64
- Country CountryCodeString
- DistinguishedNameQualifier DistinguishedNameQualifierString
- GenerationQualifier String3
- GivenName String16
- Initials String5
- Locality String128
- Organization String64
- OrganizationalUnit String64
- Pseudonym String128
- SerialNumber String64
- State String128
- Surname String40
- Title String64
Arn
- Arn
string
AuditReportId
- AuditReportId
string
AuditReportResponseFormat
- AuditReportResponseFormat
string
(values: JSON, CSV)
AuditReportStatus
- AuditReportStatus
string
(values: CREATING, SUCCESS, FAILED)
Boolean
- Boolean
boolean
CertificateAuthorities
- CertificateAuthorities
array
- items CertificateAuthority
CertificateAuthority
- CertificateAuthority
object
: Contains information about your private certificate authority (CA). Your private CA can issue and revoke X.509 digital certificates. Digital certificates verify that the entity named in the certificate Subject field owns or controls the public key contained in the Subject Public Key Info field. Call the CreateCertificateAuthority function to create your private CA. You must then call the GetCertificateAuthorityCertificate function to retrieve a private CA certificate signing request (CSR). Take the CSR to your on-premises CA and sign it with the root CA certificate or a subordinate certificate. Call the ImportCertificateAuthorityCertificate function to import the signed certificate into AWS Certificate Manager (ACM).- Arn Arn
- CertificateAuthorityConfiguration CertificateAuthorityConfiguration
- CreatedAt TStamp
- FailureReason FailureReason
- LastStateChangeAt TStamp
- NotAfter TStamp
- NotBefore TStamp
- RevocationConfiguration RevocationConfiguration
- Serial String
- Status CertificateAuthorityStatus
- Type CertificateAuthorityType
CertificateAuthorityConfiguration
- CertificateAuthorityConfiguration
object
: Contains configuration information for your private certificate authority (CA). This includes information about the class of public key algorithm and the key pair that your private CA creates when it issues a certificate, the signature algorithm it uses used when issuing certificates, and its X.500 distinguished name. You must specify this information when you call the CreateCertificateAuthority function.- KeyAlgorithm required KeyAlgorithm
- SigningAlgorithm required SigningAlgorithm
- Subject required ASN1Subject
CertificateAuthorityStatus
- CertificateAuthorityStatus
string
(values: CREATING, PENDING_CERTIFICATE, ACTIVE, DISABLED, EXPIRED, FAILED)
CertificateAuthorityType
- CertificateAuthorityType
string
(values: SUBORDINATE)
CertificateBody
- CertificateBody
string
CertificateBodyBlob
- CertificateBodyBlob
string
CertificateChain
- CertificateChain
string
CertificateChainBlob
- CertificateChainBlob
string
CertificateMismatchException
- CertificateMismatchException
object
: The certificate authority certificate you are importing does not comply with conditions specified in the certificate that signed it.- message String
ConcurrentModificationException
- ConcurrentModificationException
object
: A previous update to your private CA is still ongoing.- message String
CountryCodeString
- CountryCodeString
string
CreateCertificateAuthorityAuditReportRequest
- CreateCertificateAuthorityAuditReportRequest
object
- AuditReportResponseFormat required AuditReportResponseFormat
- CertificateAuthorityArn required Arn
- S3BucketName required String
CreateCertificateAuthorityAuditReportResponse
- CreateCertificateAuthorityAuditReportResponse
object
- AuditReportId AuditReportId
- S3Key String
CreateCertificateAuthorityRequest
- CreateCertificateAuthorityRequest
object
- CertificateAuthorityConfiguration required CertificateAuthorityConfiguration
- CertificateAuthorityType required CertificateAuthorityType
- IdempotencyToken IdempotencyToken
- RevocationConfiguration RevocationConfiguration
CreateCertificateAuthorityResponse
- CreateCertificateAuthorityResponse
object
- CertificateAuthorityArn Arn
CrlConfiguration
- CrlConfiguration
object
: Contains configuration information for a certificate revocation list (CRL). Your private certificate authority (CA) creates base CRLs. Delta CRLs are not supported. You can enable CRLs for your new or an existing private CA by setting the Enabled parameter to true. Your private CA writes CRLs to an S3 bucket that you specify in the S3BucketName parameter. You can hide the name of your bucket by specifying a value for the CustomCname parameter. Your private CA copies the CNAME or the S3 bucket name to the CRL Distribution Points extension of each certificate it issues. Your S3 bucket policy must give write permission to ACM PCA. Your private CA uses the value in the ExpirationInDays parameter to calculate the nextUpdate field in the CRL. The CRL is refreshed at 1/2 the age of next update or when a certificate is revoked. When a certificate is revoked, it is recorded in the next CRL that is generated and in the next audit report. Only time valid certificates are listed in the CRL. Expired certificates are not included. CRLs contain the following fields: Version: The current version number defined in RFC 5280 is V2. The integer value is 0x1. Signature Algorithm: The name of the algorithm used to sign the CRL. Issuer: The X.500 distinguished name of your private CA that issued the CRL. Last Update: The issue date and time of this CRL. Next Update: The day and time by which the next CRL will be issued. Revoked Certificates: List of revoked certificates. Each list item contains the following information. Serial Number: The serial number, in hexadecimal format, of the revoked certificate. Revocation Date: Date and time the certificate was revoked. CRL Entry Extensions: Optional extensions for the CRL entry. X509v3 CRL Reason Code: Reason the certificate was revoked. CRL Extensions: Optional extensions for the CRL. X509v3 Authority Key Identifier: Identifies the public key associated with the private key used to sign the certificate. X509v3 CRL Number:: Decimal sequence number for the CRL. Signature Algorithm: Algorithm used by your private CA to sign the CRL. Signature Value: Signature computed over the CRL. Certificate revocation lists created by ACM PCA are DER-encoded. You can use the following OpenSSL command to list a CRL. openssl crl -inform DER -text -in crl_path -noout- CustomCname String253
- Enabled required Boolean
- ExpirationInDays Integer1To5000
- S3BucketName String3To255
CsrBlob
- CsrBlob
string
CsrBody
- CsrBody
string
DeleteCertificateAuthorityRequest
- DeleteCertificateAuthorityRequest
object
- CertificateAuthorityArn required Arn
DescribeCertificateAuthorityAuditReportRequest
- DescribeCertificateAuthorityAuditReportRequest
object
- AuditReportId required AuditReportId
- CertificateAuthorityArn required Arn
DescribeCertificateAuthorityAuditReportResponse
- DescribeCertificateAuthorityAuditReportResponse
object
- AuditReportStatus AuditReportStatus
- CreatedAt TStamp
- S3BucketName String
- S3Key String
DescribeCertificateAuthorityRequest
- DescribeCertificateAuthorityRequest
object
- CertificateAuthorityArn required Arn
DescribeCertificateAuthorityResponse
- DescribeCertificateAuthorityResponse
object
- CertificateAuthority CertificateAuthority
DistinguishedNameQualifierString
- DistinguishedNameQualifierString
string
FailureReason
- FailureReason
string
(values: REQUEST_TIMED_OUT, UNSUPPORTED_ALGORITHM, OTHER)
GetCertificateAuthorityCertificateRequest
- GetCertificateAuthorityCertificateRequest
object
- CertificateAuthorityArn required Arn
GetCertificateAuthorityCertificateResponse
- GetCertificateAuthorityCertificateResponse
object
- Certificate CertificateBody
- CertificateChain CertificateChain
GetCertificateAuthorityCsrRequest
- GetCertificateAuthorityCsrRequest
object
- CertificateAuthorityArn required Arn
GetCertificateAuthorityCsrResponse
- GetCertificateAuthorityCsrResponse
object
- Csr CsrBody
GetCertificateRequest
GetCertificateResponse
- GetCertificateResponse
object
- Certificate CertificateBody
- CertificateChain CertificateChain
IdempotencyToken
- IdempotencyToken
string
ImportCertificateAuthorityCertificateRequest
- ImportCertificateAuthorityCertificateRequest
object
- Certificate required CertificateBodyBlob
- CertificateAuthorityArn required Arn
- CertificateChain required CertificateChainBlob
Integer1To5000
- Integer1To5000
integer
InvalidArgsException
- InvalidArgsException
object
: One or more of the specified arguments was not valid.- message String
InvalidArnException
- InvalidArnException
object
: The requested Amazon Resource Name (ARN) does not refer to an existing resource.- message String
InvalidNextTokenException
- InvalidNextTokenException
object
: The token specified in the NextToken argument is not valid. Use the token returned from your previous call to ListCertificateAuthorities.- message String
InvalidPolicyException
- InvalidPolicyException
object
: The S3 bucket policy is not valid. The policy must give ACM PCA rights to read from and write to the bucket and find the bucket location.- message String
InvalidStateException
- InvalidStateException
object
: The private CA is in a state during which a report cannot be generated.- message String
InvalidTagException
- InvalidTagException
object
: The tag associated with the CA is not valid. The invalid argument is contained in the message field.- message String
IssueCertificateRequest
- IssueCertificateRequest
object
- CertificateAuthorityArn required Arn
- Csr required CsrBlob
- IdempotencyToken IdempotencyToken
- SigningAlgorithm required SigningAlgorithm
- Validity required Validity
IssueCertificateResponse
- IssueCertificateResponse
object
- CertificateArn Arn
KeyAlgorithm
- KeyAlgorithm
string
(values: RSA_2048, RSA_4096, EC_prime256v1, EC_secp384r1)
LimitExceededException
- LimitExceededException
object
: An ACM PCA limit has been exceeded. See the exception message returned to determine the limit that was exceeded.- message String
ListCertificateAuthoritiesRequest
- ListCertificateAuthoritiesRequest
object
- MaxResults MaxResults
- NextToken NextToken
ListCertificateAuthoritiesResponse
- ListCertificateAuthoritiesResponse
object
- CertificateAuthorities CertificateAuthorities
- NextToken NextToken
ListTagsRequest
- ListTagsRequest
object
- CertificateAuthorityArn required Arn
- MaxResults MaxResults
- NextToken NextToken
ListTagsResponse
MalformedCSRException
- MalformedCSRException
object
: The certificate signing request is invalid.- message String
MalformedCertificateException
- MalformedCertificateException
object
: One or more fields in the certificate are invalid.- message String
MaxResults
- MaxResults
integer
NextToken
- NextToken
string
PositiveLong
- PositiveLong
integer
RequestAlreadyProcessedException
- RequestAlreadyProcessedException
object
: Your request has already been completed.- message String
RequestFailedException
- RequestFailedException
object
: The request has failed for an unspecified reason.- message String
RequestInProgressException
- RequestInProgressException
object
: Your request is already in progress.- message String
ResourceNotFoundException
- ResourceNotFoundException
object
: A resource such as a private CA, S3 bucket, certificate, or audit report cannot be found.- message String
RevocationConfiguration
- RevocationConfiguration
object
: Certificate revocation information used by the CreateCertificateAuthority and UpdateCertificateAuthority functions. Your private certificate authority (CA) can create and maintain a certificate revocation list (CRL). A CRL contains information about certificates revoked by your CA. For more information, see RevokeCertificate.- CrlConfiguration CrlConfiguration
RevocationReason
- RevocationReason
string
(values: UNSPECIFIED, KEY_COMPROMISE, CERTIFICATE_AUTHORITY_COMPROMISE, AFFILIATION_CHANGED, SUPERSEDED, CESSATION_OF_OPERATION, PRIVILEGE_WITHDRAWN, A_A_COMPROMISE)
RevokeCertificateRequest
- RevokeCertificateRequest
object
- CertificateAuthorityArn required Arn
- CertificateSerial required String128
- RevocationReason required RevocationReason
SigningAlgorithm
- SigningAlgorithm
string
(values: SHA256WITHECDSA, SHA384WITHECDSA, SHA512WITHECDSA, SHA256WITHRSA, SHA384WITHRSA, SHA512WITHRSA)
String
- String
string
String128
- String128
string
String16
- String16
string
String253
- String253
string
String3
- String3
string
String3To255
- String3To255
string
String40
- String40
string
String5
- String5
string
String64
- String64
string
TStamp
- TStamp
string
Tag
- Tag
object
: Tags are labels that you can use to identify and organize your private CAs. Each tag consists of a key and an optional value. You can associate up to 50 tags with a private CA. To add one or more tags to a private CA, call the TagCertificateAuthority function. To remove a tag, call the UntagCertificateAuthority function.
TagCertificateAuthorityRequest
TagKey
- TagKey
string
TagList
- TagList
array
- items Tag
TagValue
- TagValue
string
TooManyTagsException
- TooManyTagsException
object
: You can associate up to 50 tags with a private CA. Exception information is contained in the exception message field.- message String
UntagCertificateAuthorityRequest
UpdateCertificateAuthorityRequest
- UpdateCertificateAuthorityRequest
object
- CertificateAuthorityArn required Arn
- RevocationConfiguration RevocationConfiguration
- Status CertificateAuthorityStatus
Validity
- Validity
object
: Length of time for which the certificate issued by your private certificate authority (CA), or by the private CA itself, is valid in days, months, or years. You can issue a certificate by calling the IssueCertificate function.- Type required ValidityPeriodType
- Value required PositiveLong
ValidityPeriodType
- ValidityPeriodType
string
(values: END_DATE, ABSOLUTE, DAYS, MONTHS, YEARS)