AWS Tools for Windows PowerShell
Command Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Synopsis

Calls the AWS Certificate Manager Private Certificate Authority IssueCertificate API operation.

Syntax

New-PCACertificate
-CertificateAuthorityArn <String>
-Extensions_CertificatePolicy <PolicyInformation[]>
-Subject_CommonName <String>
-Subject_Country <String>
-KeyUsage_CRLSign <Boolean>
-Csr <Byte[]>
-Subject_CustomAttribute <CustomAttribute[]>
-Extensions_CustomExtension <CustomExtension[]>
-KeyUsage_DataEncipherment <Boolean>
-KeyUsage_DecipherOnly <Boolean>
-KeyUsage_DigitalSignature <Boolean>
-Subject_DistinguishedNameQualifier <String>
-KeyUsage_EncipherOnly <Boolean>
-Extensions_ExtendedKeyUsage <ExtendedKeyUsage[]>
-Subject_GenerationQualifier <String>
-Subject_GivenName <String>
-IdempotencyToken <String>
-Subject_Initial <String>
-KeyUsage_KeyAgreement <Boolean>
-KeyUsage_KeyCertSign <Boolean>
-KeyUsage_KeyEncipherment <Boolean>
-Subject_Locality <String>
-KeyUsage_NonRepudiation <Boolean>
-Subject_Organization <String>
-Subject_OrganizationalUnit <String>
-Subject_Pseudonym <String>
-Subject_SerialNumber <String>
-SigningAlgorithm <SigningAlgorithm>
-Subject_State <String>
-Extensions_SubjectAlternativeName <GeneralName[]>
-Subject_Surname <String>
-TemplateArn <String>
-Subject_Title <String>
-Validity <Validity>
-ValidityNotBefore <Validity>
-Select <String>
-PassThru <SwitchParameter>
-Force <SwitchParameter>

Description

Uses your private certificate authority (CA), or one that has been shared with you, to issue a client certificate. This action returns the Amazon Resource Name (ARN) of the certificate. You can retrieve the certificate by calling the GetCertificate action and specifying the ARN. You cannot use the ACM ListCertificateAuthorities action to retrieve the ARNs of the certificates that you issue by using ACM Private CA.

Parameters

-CertificateAuthorityArn <String>
The Amazon Resource Name (ARN) that was returned when you called CreateCertificateAuthority. This must be of the form:arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012
Required?True
Position?1
Accept pipeline input?True (ByValue, ByPropertyName)
-Csr <Byte[]>
The certificate signing request (CSR) for the certificate you want to issue. As an example, you can use the following OpenSSL command to create the CSR and a 2048 bit RSA private key. openssl req -new -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csrIf you have a configuration file, you can then use the following OpenSSL command. The usr_cert block in the configuration file contains your X509 version 3 extensions. openssl req -new -config openssl_rsa.cnf -extensions usr_cert -newkey rsa:2048 -days 365 -keyout private/test_cert_priv_key.pem -out csr/test_cert_.csrNote: A CSR must provide either a subject name or a subject alternative name or the request will be rejected. The cmdlet will automatically convert the supplied parameter of type string, string[], System.IO.FileInfo or System.IO.Stream to byte[] before supplying it to the service.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Extensions_CertificatePolicy <PolicyInformation[]>
Contains a sequence of one or more policy information terms, each of which consists of an object identifier (OID) and optional qualifiers. For more information, see NIST's definition of Object Identifier (OID).In an end-entity certificate, these terms indicate the policy under which the certificate was issued and the purposes for which it may be used. In a CA certificate, these terms limit the set of policies for certification paths that include this certificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_CertificatePolicies
-Extensions_CustomExtension <CustomExtension[]>
Contains a sequence of one or more X.509 extensions, each of which consists of an object identifier (OID), a base64-encoded value, and the critical flag. For more information, see the Global OID reference database.The OID value of a CustomExtension must not match the OID of a predefined extension.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_CustomExtensions
-Extensions_ExtendedKeyUsage <ExtendedKeyUsage[]>
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the KeyUsage extension.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_ExtendedKeyUsage
-Extensions_SubjectAlternativeName <GeneralName[]>
The subject alternative name extension allows identities to be bound to the subject of the certificate. These identities may be included in addition to or in place of the identity in the subject field of the certificate.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_SubjectAlternativeNames
This parameter overrides confirmation prompts to force the cmdlet to continue its operation. This parameter should always be used with caution.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-IdempotencyToken <String>
Alphanumeric string that can be used to distinguish between calls to the IssueCertificate action. Idempotency tokens for IssueCertificate time out after one minute. Therefore, if you call IssueCertificate multiple times with the same idempotency token within one minute, ACM Private CA recognizes that you are requesting only one certificate and will issue only one. If you change the idempotency token for each call, PCA recognizes that you are requesting multiple certificates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-KeyUsage_CRLSign <Boolean>
Key can be used to sign CRLs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_CRLSign
-KeyUsage_DataEncipherment <Boolean>
Key can be used to decipher data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_DataEncipherment
-KeyUsage_DecipherOnly <Boolean>
Key can be used only to decipher data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_DecipherOnly
-KeyUsage_DigitalSignature <Boolean>
Key can be used for digital signing.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_DigitalSignature
-KeyUsage_EncipherOnly <Boolean>
Key can be used only to encipher data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_EncipherOnly
-KeyUsage_KeyAgreement <Boolean>
Key can be used in a key-agreement protocol.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_KeyAgreement
-KeyUsage_KeyCertSign <Boolean>
Key can be used to sign certificates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_KeyCertSign
-KeyUsage_KeyEncipherment <Boolean>
Key can be used to encipher data.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_KeyEncipherment
-KeyUsage_NonRepudiation <Boolean>
Key can be used for non-repudiation.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Extensions_KeyUsage_NonRepudiation
-PassThru <SwitchParameter>
Changes the cmdlet behavior to return the value passed to the CertificateAuthorityArn parameter. The -PassThru parameter is deprecated, use -Select '^CertificateAuthorityArn' instead. This parameter will be removed in a future version.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Select <String>
Use the -Select parameter to control the cmdlet output. The default value is 'CertificateArn'. Specifying -Select '*' will result in the cmdlet returning the whole service response (Amazon.ACMPCA.Model.IssueCertificateResponse). Specifying the name of a property of type Amazon.ACMPCA.Model.IssueCertificateResponse will result in that property being returned. Specifying -Select '^ParameterName' will result in the cmdlet returning the selected cmdlet parameter value.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-SigningAlgorithm <SigningAlgorithm>
The name of the algorithm that will be used to sign the certificate to be issued.This parameter should not be confused with the SigningAlgorithm parameter used to sign a CSR in the CreateCertificateAuthority action.The specified signing algorithm family (RSA or ECDSA) much match the algorithm family of the CA's secret key.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-Subject_CommonName <String>
For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit. Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_CommonName
-Subject_Country <String>
Two-digit code that specifies the country in which the certificate subject located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Country
-Subject_CustomAttribute <CustomAttribute[]>
Contains a sequence of one or more X.500 relative distinguished names (RDNs), each of which consists of an object identifier (OID) and a value. For more information, see NIST’s definition of Object Identifier (OID).Custom attributes cannot be used in combination with standard attributes.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_CustomAttributes
-Subject_DistinguishedNameQualifier <String>
Disambiguating information for the certificate subject.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_DistinguishedNameQualifier
-Subject_GenerationQualifier <String>
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_GenerationQualifier
-Subject_GivenName <String>
First name.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_GivenName
-Subject_Initial <String>
Concatenation that typically contains the first letter of the GivenName, the first letter of the middle name if one exists, and the first letter of the Surname.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Initials
-Subject_Locality <String>
The locality (such as a city or town) in which the certificate subject is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Locality
-Subject_Organization <String>
Legal name of the organization with which the certificate subject is affiliated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Organization
-Subject_OrganizationalUnit <String>
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_OrganizationalUnit
-Subject_Pseudonym <String>
Typically a shortened version of a longer GivenName. For example, Jonathan is often shortened to John. Elizabeth is often shortened to Beth, Liz, or Eliza.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Pseudonym
-Subject_SerialNumber <String>
The certificate serial number.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_SerialNumber
-Subject_State <String>
State in which the subject of the certificate is located.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_State
-Subject_Surname <String>
Family name. In the US and the UK, for example, the surname of an individual is ordered last. In Asian cultures the surname is typically ordered first.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Surname
-Subject_Title <String>
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesApiPassthrough_Subject_Title
-TemplateArn <String>
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, ACM Private CA defaults to the EndEntityCertificate/V1 template. For CA certificates, you should choose the shortest path length that meets your needs. The path length is indicated by the PathLenN portion of the ARN, where N is the CA depth.Note: The CA depth configured on a subordinate CA certificate must not exceed the limit set by its parents in the CA hierarchy.For a list of TemplateArn values supported by ACM Private CA, see Understanding Certificate Templates.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-Validity <Validity>
Information describing the end of the validity period of the certificate. This parameter sets the “Not After” date for the certificate.Certificate validity is the period of time during which a certificate is valid. Validity can be expressed as an explicit date and time when the certificate expires, or as a span of time after issuance, stated in days, months, or years. For more information, see Validity in RFC 5280. This value is unaffected when ValidityNotBefore is also specified. For example, if Validity is set to 20 days in the future, the certificate will expire 20 days from issuance time regardless of the ValidityNotBefore value.The end of the validity period configured on a certificate must not exceed the limit set on its parents in the CA hierarchy.
Required?True
Position?Named
Accept pipeline input?True (ByPropertyName)
-ValidityNotBefore <Validity>
Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.By default, when issuing a certificate, ACM Private CA sets the "Not Before" date to the issuance time minus 60 minutes. This compensates for clock inconsistencies across computer systems. The ValidityNotBefore parameter can be used to customize the “Not Before” value. Unlike the Validity parameter, the ValidityNotBefore parameter is optional.The ValidityNotBefore value is expressed as an explicit date and time, using the Validity type value ABSOLUTE. For more information, see Validity in this API reference and Validity in RFC 5280.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)

Common Credential and Region Parameters

-AccessKey <String>
The AWS access key for the user account. This can be a temporary access key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAK
-Credential <AWSCredentials>
An AWSCredentials object instance containing access and secret key information, and optionally a token for session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-EndpointUrl <String>
The endpoint to make the call against.Note: This parameter is primarily for internal AWS use and is not required/should not be specified for normal usage. The cmdlets normally determine which endpoint to call based on the region specified to the -Region parameter or set as default in the shell (via Set-DefaultAWSRegion). Only specify this parameter if you must direct the call to a specific custom endpoint.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
-NetworkCredential <PSCredential>
Used with SAML-based authentication when ProfileName references a SAML role profile. Contains the network credentials to be supplied during authentication with the configured identity provider's endpoint. This parameter is not required if the user's default network identity can or should be used during authentication.
Required?False
Position?Named
Accept pipeline input?True (ByValue, ByPropertyName)
-ProfileLocation <String>
Used to specify the name and location of the ini-format credential file (shared with the AWS CLI and other AWS SDKs)If this optional parameter is omitted this cmdlet will search the encrypted credential file used by the AWS SDK for .NET and AWS Toolkit for Visual Studio first. If the profile is not found then the cmdlet will search in the ini-format credential file at the default location: (user's home directory)\.aws\credentials.If this parameter is specified then this cmdlet will only search the ini-format credential file at the location given.As the current folder can vary in a shell or during script execution it is advised that you use specify a fully qualified path instead of a relative path.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesAWSProfilesLocation, ProfilesLocation
-ProfileName <String>
The user-defined name of an AWS credentials or SAML-based role profile containing credential information. The profile is expected to be found in the secure credential file shared with the AWS SDK for .NET and AWS Toolkit for Visual Studio. You can also specify the name of a profile stored in the .ini-format credential file used with the AWS CLI and other AWS SDKs.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesStoredCredentials, AWSProfileName
-Region <Object>
The system name of an AWS region or an AWSRegion instance. This governs the endpoint that will be used when calling service operations. Note that the AWS resources referenced in a call are usually region-specific.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesRegionToCall
-SecretKey <String>
The AWS secret key for the user account. This can be a temporary secret key if the corresponding session token is supplied to the -SessionToken parameter.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesSK, SecretAccessKey
-SessionToken <String>
The session token if the access and secret keys are temporary session-based credentials.
Required?False
Position?Named
Accept pipeline input?True (ByPropertyName)
AliasesST

Outputs

This cmdlet returns a System.String object. The service call response (type Amazon.ACMPCA.Model.IssueCertificateResponse) can also be referenced from properties attached to the cmdlet entry in the $AWSHistory stack.

Supported Version

AWS Tools for PowerShell: 2.x.y.z