This is the new *CloudFormation Template Reference Guide*. Please update your bookmarks and links. For help getting started with CloudFormation, see the [AWS CloudFormation User Guide](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/Welcome.html).

# AWS::ACMPCA::Certificate
<a name="aws-resource-acmpca-certificate"></a>

The `AWS::ACMPCA::Certificate` resource is used to issue a certificate using your private certificate authority. For more information, see the [IssueCertificate](https://docs.aws.amazon.com/privateca/latest/APIReference/API_IssueCertificate.html) action.

## Syntax
<a name="aws-resource-acmpca-certificate-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-resource-acmpca-certificate-syntax.json"></a>

```
{
  "Type" : "AWS::ACMPCA::Certificate",
  "Properties" : {
      "[ApiPassthrough](#cfn-acmpca-certificate-apipassthrough)" : ApiPassthrough,
      "[CertificateAuthorityArn](#cfn-acmpca-certificate-certificateauthorityarn)" : String,
      "[CertificateSigningRequest](#cfn-acmpca-certificate-certificatesigningrequest)" : String,
      "[SigningAlgorithm](#cfn-acmpca-certificate-signingalgorithm)" : String,
      "[TemplateArn](#cfn-acmpca-certificate-templatearn)" : String,
      "[Validity](#cfn-acmpca-certificate-validity)" : Validity,
      "[ValidityNotBefore](#cfn-acmpca-certificate-validitynotbefore)" : Validity
    }
}
```

### YAML
<a name="aws-resource-acmpca-certificate-syntax.yaml"></a>

```
Type: AWS::ACMPCA::Certificate
Properties:
  [ApiPassthrough](#cfn-acmpca-certificate-apipassthrough): 
    ApiPassthrough
  [CertificateAuthorityArn](#cfn-acmpca-certificate-certificateauthorityarn): String
  [CertificateSigningRequest](#cfn-acmpca-certificate-certificatesigningrequest): String
  [SigningAlgorithm](#cfn-acmpca-certificate-signingalgorithm): String
  [TemplateArn](#cfn-acmpca-certificate-templatearn): String
  [Validity](#cfn-acmpca-certificate-validity): 
    Validity
  [ValidityNotBefore](#cfn-acmpca-certificate-validitynotbefore): 
    Validity
```

## Properties
<a name="aws-resource-acmpca-certificate-properties"></a>

`ApiPassthrough`  <a name="cfn-acmpca-certificate-apipassthrough"></a>
Specifies X.509 certificate information to be included in the issued certificate. An `APIPassthrough` or `APICSRPassthrough` template variant must be selected, or else this parameter is ignored.  
*Required*: No  
*Type*: [ApiPassthrough](aws-properties-acmpca-certificate-apipassthrough.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CertificateAuthorityArn`  <a name="cfn-acmpca-certificate-certificateauthorityarn"></a>
The Amazon Resource Name (ARN) for the private CA issues the certificate.  
*Required*: Yes  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CertificateSigningRequest`  <a name="cfn-acmpca-certificate-certificatesigningrequest"></a>
The certificate signing request (CSR) for the certificate.  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SigningAlgorithm`  <a name="cfn-acmpca-certificate-signingalgorithm"></a>
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) must match the algorithm family of the CA's secret key.
*Required*: Yes  
*Type*: String  
*Allowed values*: `SHA256WITHECDSA | SHA384WITHECDSA | SHA512WITHECDSA | SHA256WITHRSA | SHA384WITHRSA | SHA512WITHRSA | SM3WITHSM2 | ML_DSA_44 | ML_DSA_65 | ML_DSA_87`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`TemplateArn`  <a name="cfn-acmpca-certificate-templatearn"></a>
Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, AWS Private CA defaults to the `EndEntityCertificate/V1` template. For more information about AWS Private CA templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).   
*Required*: No  
*Type*: String  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Validity`  <a name="cfn-acmpca-certificate-validity"></a>
The period of time during which the certificate will be valid.  
*Required*: Yes  
*Type*: [Validity](aws-properties-acmpca-certificate-validity.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ValidityNotBefore`  <a name="cfn-acmpca-certificate-validitynotbefore"></a>
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, AWS 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`.  
*Required*: No  
*Type*: [Validity](aws-properties-acmpca-certificate-validity.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

## Return values
<a name="aws-resource-acmpca-certificate-return-values"></a>

### Ref
<a name="aws-resource-acmpca-certificate-return-values-ref"></a>

This reference should not be used in CloudFormation templates. Instead, use `AWS::ACMPCA::Certificate.Arn` to identify a certificate, and use `AWS::ACMPCA::Certificate.CertificateAuthorityArn` to identify a certificate authority.

### Fn::GetAtt
<a name="aws-resource-acmpca-certificate-return-values-fn--getatt"></a>

The `Fn::GetAtt` intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.

For more information about using the `Fn::GetAtt` intrinsic function, see [Fn::GetAtt](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/intrinsic-function-reference-getatt.html).

#### 
<a name="aws-resource-acmpca-certificate-return-values-fn--getatt-fn--getatt"></a>

`Arn`  <a name="Arn-fn::getatt"></a>
The Amazon Resource Name (ARN) of the issued certificate.

`Certificate`  <a name="Certificate-fn::getatt"></a>
The issued Base64 PEM-encoded certificate.

# AWS::ACMPCA::Certificate ApiPassthrough
<a name="aws-properties-acmpca-certificate-apipassthrough"></a>

Contains X.509 certificate information to be placed in an issued certificate. An `APIPassthrough` or `APICSRPassthrough` template variant must be selected, or else this parameter is ignored. 

If conflicting or duplicate certificate information is supplied from other sources, AWS Private CA applies [order of operation rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations) to determine what information is used.

## Syntax
<a name="aws-properties-acmpca-certificate-apipassthrough-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-apipassthrough-syntax.json"></a>

```
{
  "[Extensions](#cfn-acmpca-certificate-apipassthrough-extensions)" : Extensions,
  "[Subject](#cfn-acmpca-certificate-apipassthrough-subject)" : Subject
}
```

### YAML
<a name="aws-properties-acmpca-certificate-apipassthrough-syntax.yaml"></a>

```
  [Extensions](#cfn-acmpca-certificate-apipassthrough-extensions): 
    Extensions
  [Subject](#cfn-acmpca-certificate-apipassthrough-subject): 
    Subject
```

## Properties
<a name="aws-properties-acmpca-certificate-apipassthrough-properties"></a>

`Extensions`  <a name="cfn-acmpca-certificate-apipassthrough-extensions"></a>
Specifies X.509 extension information for a certificate.  
*Required*: No  
*Type*: [Extensions](aws-properties-acmpca-certificate-extensions.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Subject`  <a name="cfn-acmpca-certificate-apipassthrough-subject"></a>
Contains information about the certificate subject. 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.   
*Required*: No  
*Type*: [Subject](aws-properties-acmpca-certificate-subject.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate CustomAttribute
<a name="aws-properties-acmpca-certificate-customattribute"></a>

Defines the X.500 relative distinguished name (RDN).

## Syntax
<a name="aws-properties-acmpca-certificate-customattribute-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-customattribute-syntax.json"></a>

```
{
  "[ObjectIdentifier](#cfn-acmpca-certificate-customattribute-objectidentifier)" : String,
  "[Value](#cfn-acmpca-certificate-customattribute-value)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-customattribute-syntax.yaml"></a>

```
  [ObjectIdentifier](#cfn-acmpca-certificate-customattribute-objectidentifier): String
  [Value](#cfn-acmpca-certificate-customattribute-value): String
```

## Properties
<a name="aws-properties-acmpca-certificate-customattribute-properties"></a>

`ObjectIdentifier`  <a name="cfn-acmpca-certificate-customattribute-objectidentifier"></a>
Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).  
*Required*: Yes  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-acmpca-certificate-customattribute-value"></a>
  
Specifies the attribute value of relative distinguished name (RDN).  
*Required*: Yes  
*Type*: String  
*Minimum*: `1`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate CustomExtension
<a name="aws-properties-acmpca-certificate-customextension"></a>



Specifies the X.509 extension information for a certificate.

Extensions present in `CustomExtensions` follow the `ApiPassthrough`[template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations). 

## Syntax
<a name="aws-properties-acmpca-certificate-customextension-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-customextension-syntax.json"></a>

```
{
  "[Critical](#cfn-acmpca-certificate-customextension-critical)" : Boolean,
  "[ObjectIdentifier](#cfn-acmpca-certificate-customextension-objectidentifier)" : String,
  "[Value](#cfn-acmpca-certificate-customextension-value)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-customextension-syntax.yaml"></a>

```
  [Critical](#cfn-acmpca-certificate-customextension-critical): Boolean
  [ObjectIdentifier](#cfn-acmpca-certificate-customextension-objectidentifier): String
  [Value](#cfn-acmpca-certificate-customextension-value): String
```

## Properties
<a name="aws-properties-acmpca-certificate-customextension-properties"></a>

`Critical`  <a name="cfn-acmpca-certificate-customextension-critical"></a>
  
Specifies the critical flag of the X.509 extension.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ObjectIdentifier`  <a name="cfn-acmpca-certificate-customextension-objectidentifier"></a>
  
Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://oidref.com/2.5.29)  
*Required*: Yes  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-acmpca-certificate-customextension-value"></a>
  
Specifies the base64-encoded value of the X.509 extension.  
*Required*: Yes  
*Type*: String  
*Pattern*: `(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?`  
*Minimum*: `1`  
*Maximum*: `4096`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate EdiPartyName
<a name="aws-properties-acmpca-certificate-edipartyname"></a>

Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.

## Syntax
<a name="aws-properties-acmpca-certificate-edipartyname-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-edipartyname-syntax.json"></a>

```
{
  "[NameAssigner](#cfn-acmpca-certificate-edipartyname-nameassigner)" : String,
  "[PartyName](#cfn-acmpca-certificate-edipartyname-partyname)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-edipartyname-syntax.yaml"></a>

```
  [NameAssigner](#cfn-acmpca-certificate-edipartyname-nameassigner): String
  [PartyName](#cfn-acmpca-certificate-edipartyname-partyname): String
```

## Properties
<a name="aws-properties-acmpca-certificate-edipartyname-properties"></a>

`NameAssigner`  <a name="cfn-acmpca-certificate-edipartyname-nameassigner"></a>
Specifies the name assigner.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PartyName`  <a name="cfn-acmpca-certificate-edipartyname-partyname"></a>
Specifies the party name.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate ExtendedKeyUsage
<a name="aws-properties-acmpca-certificate-extendedkeyusage"></a>

Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension.

## Syntax
<a name="aws-properties-acmpca-certificate-extendedkeyusage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-extendedkeyusage-syntax.json"></a>

```
{
  "[ExtendedKeyUsageObjectIdentifier](#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier)" : String,
  "[ExtendedKeyUsageType](#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-extendedkeyusage-syntax.yaml"></a>

```
  [ExtendedKeyUsageObjectIdentifier](#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier): String
  [ExtendedKeyUsageType](#cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype): String
```

## Properties
<a name="aws-properties-acmpca-certificate-extendedkeyusage-properties"></a>

`ExtendedKeyUsageObjectIdentifier`  <a name="cfn-acmpca-certificate-extendedkeyusage-extendedkeyusageobjectidentifier"></a>
Specifies a custom `ExtendedKeyUsage` with an object identifier (OID).  
*Required*: No  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExtendedKeyUsageType`  <a name="cfn-acmpca-certificate-extendedkeyusage-extendedkeyusagetype"></a>
Specifies a standard `ExtendedKeyUsage` as defined as in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).  
*Required*: No  
*Type*: String  
*Allowed values*: `SERVER_AUTH | CLIENT_AUTH | CODE_SIGNING | EMAIL_PROTECTION | TIME_STAMPING | OCSP_SIGNING | SMART_CARD_LOGIN | DOCUMENT_SIGNING | CERTIFICATE_TRANSPARENCY`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate Extensions
<a name="aws-properties-acmpca-certificate-extensions"></a>

Contains X.509 extension information for a certificate.

## Syntax
<a name="aws-properties-acmpca-certificate-extensions-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-extensions-syntax.json"></a>

```
{
  "[CertificatePolicies](#cfn-acmpca-certificate-extensions-certificatepolicies)" : [ PolicyInformation, ... ],
  "[CustomExtensions](#cfn-acmpca-certificate-extensions-customextensions)" : [ CustomExtension, ... ],
  "[ExtendedKeyUsage](#cfn-acmpca-certificate-extensions-extendedkeyusage)" : [ ExtendedKeyUsage, ... ],
  "[KeyUsage](#cfn-acmpca-certificate-extensions-keyusage)" : KeyUsage,
  "[SubjectAlternativeNames](#cfn-acmpca-certificate-extensions-subjectalternativenames)" : [ GeneralName, ... ]
}
```

### YAML
<a name="aws-properties-acmpca-certificate-extensions-syntax.yaml"></a>

```
  [CertificatePolicies](#cfn-acmpca-certificate-extensions-certificatepolicies): 
    - PolicyInformation
  [CustomExtensions](#cfn-acmpca-certificate-extensions-customextensions): 
    - CustomExtension
  [ExtendedKeyUsage](#cfn-acmpca-certificate-extensions-extendedkeyusage): 
    - ExtendedKeyUsage
  [KeyUsage](#cfn-acmpca-certificate-extensions-keyusage): 
    KeyUsage
  [SubjectAlternativeNames](#cfn-acmpca-certificate-extensions-subjectalternativenames): 
    - GeneralName
```

## Properties
<a name="aws-properties-acmpca-certificate-extensions-properties"></a>

`CertificatePolicies`  <a name="cfn-acmpca-certificate-extensions-certificatepolicies"></a>
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)](https://csrc.nist.gov/glossary/term/Object_Identifier).  
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*: No  
*Type*: Array of [PolicyInformation](aws-properties-acmpca-certificate-policyinformation.md)  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CustomExtensions`  <a name="cfn-acmpca-certificate-extensions-customextensions"></a>
  
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.](https://oidref.com/2.5.29)  
*Required*: No  
*Type*: Array of [CustomExtension](aws-properties-acmpca-certificate-customextension.md)  
*Minimum*: `1`  
*Maximum*: `150`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`ExtendedKeyUsage`  <a name="cfn-acmpca-certificate-extensions-extendedkeyusage"></a>
Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the `KeyUsage` extension.  
*Required*: No  
*Type*: [Array](aws-properties-acmpca-certificate-extendedkeyusage.md) of [ExtendedKeyUsage](aws-properties-acmpca-certificate-extendedkeyusage.md)  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KeyUsage`  <a name="cfn-acmpca-certificate-extensions-keyusage"></a>
Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.   
*Required*: No  
*Type*: [KeyUsage](aws-properties-acmpca-certificate-keyusage.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SubjectAlternativeNames`  <a name="cfn-acmpca-certificate-extensions-subjectalternativenames"></a>
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*: No  
*Type*: Array of [GeneralName](aws-properties-acmpca-certificate-generalname.md)  
*Minimum*: `1`  
*Maximum*: `150`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate GeneralName
<a name="aws-properties-acmpca-certificate-generalname"></a>

Describes an ASN.1 X.400 `GeneralName` as defined in [RFC 5280](https://datatracker.ietf.org/doc/html/rfc5280). Only one of the following naming options should be provided. Providing more than one option results in an `InvalidArgsException` error.

## Syntax
<a name="aws-properties-acmpca-certificate-generalname-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-generalname-syntax.json"></a>

```
{
  "[DirectoryName](#cfn-acmpca-certificate-generalname-directoryname)" : Subject,
  "[DnsName](#cfn-acmpca-certificate-generalname-dnsname)" : String,
  "[EdiPartyName](#cfn-acmpca-certificate-generalname-edipartyname)" : EdiPartyName,
  "[IpAddress](#cfn-acmpca-certificate-generalname-ipaddress)" : String,
  "[OtherName](#cfn-acmpca-certificate-generalname-othername)" : OtherName,
  "[RegisteredId](#cfn-acmpca-certificate-generalname-registeredid)" : String,
  "[Rfc822Name](#cfn-acmpca-certificate-generalname-rfc822name)" : String,
  "[UniformResourceIdentifier](#cfn-acmpca-certificate-generalname-uniformresourceidentifier)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-generalname-syntax.yaml"></a>

```
  [DirectoryName](#cfn-acmpca-certificate-generalname-directoryname): 
    Subject
  [DnsName](#cfn-acmpca-certificate-generalname-dnsname): String
  [EdiPartyName](#cfn-acmpca-certificate-generalname-edipartyname): 
    EdiPartyName
  [IpAddress](#cfn-acmpca-certificate-generalname-ipaddress): String
  [OtherName](#cfn-acmpca-certificate-generalname-othername): 
    OtherName
  [RegisteredId](#cfn-acmpca-certificate-generalname-registeredid): String
  [Rfc822Name](#cfn-acmpca-certificate-generalname-rfc822name): String
  [UniformResourceIdentifier](#cfn-acmpca-certificate-generalname-uniformresourceidentifier): String
```

## Properties
<a name="aws-properties-acmpca-certificate-generalname-properties"></a>

`DirectoryName`  <a name="cfn-acmpca-certificate-generalname-directoryname"></a>
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 entity, but your private CA can issue more than one certificate with the same DN to the same entity.  
*Required*: No  
*Type*: [Subject](aws-properties-acmpca-certificate-subject.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DnsName`  <a name="cfn-acmpca-certificate-generalname-dnsname"></a>
Represents `GeneralName` as a DNS name.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `253`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EdiPartyName`  <a name="cfn-acmpca-certificate-generalname-edipartyname"></a>
Represents `GeneralName` as an `EdiPartyName` object.  
*Required*: No  
*Type*: [EdiPartyName](aws-properties-acmpca-certificate-edipartyname.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`IpAddress`  <a name="cfn-acmpca-certificate-generalname-ipaddress"></a>
Represents `GeneralName` as an IPv4 or IPv6 address.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `39`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OtherName`  <a name="cfn-acmpca-certificate-generalname-othername"></a>
Represents `GeneralName` using an `OtherName` object.  
*Required*: No  
*Type*: [OtherName](aws-properties-acmpca-certificate-othername.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`RegisteredId`  <a name="cfn-acmpca-certificate-generalname-registeredid"></a>
 Represents `GeneralName` as an object identifier (OID).  
*Required*: No  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Rfc822Name`  <a name="cfn-acmpca-certificate-generalname-rfc822name"></a>
Represents `GeneralName` as an [RFC 822](https://datatracker.ietf.org/doc/html/rfc822) email address.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`UniformResourceIdentifier`  <a name="cfn-acmpca-certificate-generalname-uniformresourceidentifier"></a>
Represents `GeneralName` as a URI.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `253`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate KeyUsage
<a name="aws-properties-acmpca-certificate-keyusage"></a>

Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.

## Syntax
<a name="aws-properties-acmpca-certificate-keyusage-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-keyusage-syntax.json"></a>

```
{
  "[CRLSign](#cfn-acmpca-certificate-keyusage-crlsign)" : Boolean,
  "[DataEncipherment](#cfn-acmpca-certificate-keyusage-dataencipherment)" : Boolean,
  "[DecipherOnly](#cfn-acmpca-certificate-keyusage-decipheronly)" : Boolean,
  "[DigitalSignature](#cfn-acmpca-certificate-keyusage-digitalsignature)" : Boolean,
  "[EncipherOnly](#cfn-acmpca-certificate-keyusage-encipheronly)" : Boolean,
  "[KeyAgreement](#cfn-acmpca-certificate-keyusage-keyagreement)" : Boolean,
  "[KeyCertSign](#cfn-acmpca-certificate-keyusage-keycertsign)" : Boolean,
  "[KeyEncipherment](#cfn-acmpca-certificate-keyusage-keyencipherment)" : Boolean,
  "[NonRepudiation](#cfn-acmpca-certificate-keyusage-nonrepudiation)" : Boolean
}
```

### YAML
<a name="aws-properties-acmpca-certificate-keyusage-syntax.yaml"></a>

```
  [CRLSign](#cfn-acmpca-certificate-keyusage-crlsign): Boolean
  [DataEncipherment](#cfn-acmpca-certificate-keyusage-dataencipherment): Boolean
  [DecipherOnly](#cfn-acmpca-certificate-keyusage-decipheronly): Boolean
  [DigitalSignature](#cfn-acmpca-certificate-keyusage-digitalsignature): Boolean
  [EncipherOnly](#cfn-acmpca-certificate-keyusage-encipheronly): Boolean
  [KeyAgreement](#cfn-acmpca-certificate-keyusage-keyagreement): Boolean
  [KeyCertSign](#cfn-acmpca-certificate-keyusage-keycertsign): Boolean
  [KeyEncipherment](#cfn-acmpca-certificate-keyusage-keyencipherment): Boolean
  [NonRepudiation](#cfn-acmpca-certificate-keyusage-nonrepudiation): Boolean
```

## Properties
<a name="aws-properties-acmpca-certificate-keyusage-properties"></a>

`CRLSign`  <a name="cfn-acmpca-certificate-keyusage-crlsign"></a>
Key can be used to sign CRLs.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DataEncipherment`  <a name="cfn-acmpca-certificate-keyusage-dataencipherment"></a>
Key can be used to decipher data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DecipherOnly`  <a name="cfn-acmpca-certificate-keyusage-decipheronly"></a>
Key can be used only to decipher data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DigitalSignature`  <a name="cfn-acmpca-certificate-keyusage-digitalsignature"></a>
 Key can be used for digital signing.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`EncipherOnly`  <a name="cfn-acmpca-certificate-keyusage-encipheronly"></a>
Key can be used only to encipher data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KeyAgreement`  <a name="cfn-acmpca-certificate-keyusage-keyagreement"></a>
Key can be used in a key-agreement protocol.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KeyCertSign`  <a name="cfn-acmpca-certificate-keyusage-keycertsign"></a>
Key can be used to sign certificates.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`KeyEncipherment`  <a name="cfn-acmpca-certificate-keyusage-keyencipherment"></a>
Key can be used to encipher data.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`NonRepudiation`  <a name="cfn-acmpca-certificate-keyusage-nonrepudiation"></a>
Key can be used for non-repudiation.  
*Required*: No  
*Type*: Boolean  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate OtherName
<a name="aws-properties-acmpca-certificate-othername"></a>

Defines a custom ASN.1 X.400 `GeneralName` using an object identifier (OID) and value. The OID must satisfy the regular expression shown below. For more information, see NIST's definition of [Object Identifier (OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).

## Syntax
<a name="aws-properties-acmpca-certificate-othername-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-othername-syntax.json"></a>

```
{
  "[TypeId](#cfn-acmpca-certificate-othername-typeid)" : String,
  "[Value](#cfn-acmpca-certificate-othername-value)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-othername-syntax.yaml"></a>

```
  [TypeId](#cfn-acmpca-certificate-othername-typeid): String
  [Value](#cfn-acmpca-certificate-othername-value): String
```

## Properties
<a name="aws-properties-acmpca-certificate-othername-properties"></a>

`TypeId`  <a name="cfn-acmpca-certificate-othername-typeid"></a>
Specifies an OID.   
*Required*: Yes  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-acmpca-certificate-othername-value"></a>
Specifies an OID value.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate PolicyInformation
<a name="aws-properties-acmpca-certificate-policyinformation"></a>

Defines the X.509 `CertificatePolicies` extension.

## Syntax
<a name="aws-properties-acmpca-certificate-policyinformation-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-policyinformation-syntax.json"></a>

```
{
  "[CertPolicyId](#cfn-acmpca-certificate-policyinformation-certpolicyid)" : String,
  "[PolicyQualifiers](#cfn-acmpca-certificate-policyinformation-policyqualifiers)" : [ PolicyQualifierInfo, ... ]
}
```

### YAML
<a name="aws-properties-acmpca-certificate-policyinformation-syntax.yaml"></a>

```
  [CertPolicyId](#cfn-acmpca-certificate-policyinformation-certpolicyid): String
  [PolicyQualifiers](#cfn-acmpca-certificate-policyinformation-policyqualifiers): 
    - PolicyQualifierInfo
```

## Properties
<a name="aws-properties-acmpca-certificate-policyinformation-properties"></a>

`CertPolicyId`  <a name="cfn-acmpca-certificate-policyinformation-certpolicyid"></a>
Specifies the object identifier (OID) of the certificate policy under which the certificate was issued. For more information, see NIST's definition of [Object Identifier (OID)](https://csrc.nist.gov/glossary/term/Object_Identifier).  
*Required*: Yes  
*Type*: String  
*Pattern*: `([0-2])\.([0-9]|([0-3][0-9]))((\.([0-9]+)){0,126})`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`PolicyQualifiers`  <a name="cfn-acmpca-certificate-policyinformation-policyqualifiers"></a>
Modifies the given `CertPolicyId` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.  
*Required*: No  
*Type*: Array of [PolicyQualifierInfo](aws-properties-acmpca-certificate-policyqualifierinfo.md)  
*Minimum*: `1`  
*Maximum*: `20`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate PolicyQualifierInfo
<a name="aws-properties-acmpca-certificate-policyqualifierinfo"></a>

Modifies the `CertPolicyId` of a `PolicyInformation` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.

## Syntax
<a name="aws-properties-acmpca-certificate-policyqualifierinfo-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-policyqualifierinfo-syntax.json"></a>

```
{
  "[PolicyQualifierId](#cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid)" : String,
  "[Qualifier](#cfn-acmpca-certificate-policyqualifierinfo-qualifier)" : Qualifier
}
```

### YAML
<a name="aws-properties-acmpca-certificate-policyqualifierinfo-syntax.yaml"></a>

```
  [PolicyQualifierId](#cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid): String
  [Qualifier](#cfn-acmpca-certificate-policyqualifierinfo-qualifier): 
    Qualifier
```

## Properties
<a name="aws-properties-acmpca-certificate-policyqualifierinfo-properties"></a>

`PolicyQualifierId`  <a name="cfn-acmpca-certificate-policyqualifierinfo-policyqualifierid"></a>
Identifies the qualifier modifying a `CertPolicyId`.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `CPS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Qualifier`  <a name="cfn-acmpca-certificate-policyqualifierinfo-qualifier"></a>
Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field.  
*Required*: Yes  
*Type*: [Qualifier](aws-properties-acmpca-certificate-qualifier.md)  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate Qualifier
<a name="aws-properties-acmpca-certificate-qualifier"></a>

Defines a `PolicyInformation` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280. 

## Syntax
<a name="aws-properties-acmpca-certificate-qualifier-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-qualifier-syntax.json"></a>

```
{
  "[CpsUri](#cfn-acmpca-certificate-qualifier-cpsuri)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-qualifier-syntax.yaml"></a>

```
  [CpsUri](#cfn-acmpca-certificate-qualifier-cpsuri): String
```

## Properties
<a name="aws-properties-acmpca-certificate-qualifier-properties"></a>

`CpsUri`  <a name="cfn-acmpca-certificate-qualifier-cpsuri"></a>
Contains a pointer to a certification practice statement (CPS) published by the CA.  
*Required*: Yes  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `256`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate Subject
<a name="aws-properties-acmpca-certificate-subject"></a>

Contains information about the certificate subject. 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.

## Syntax
<a name="aws-properties-acmpca-certificate-subject-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-subject-syntax.json"></a>

```
{
  "[CommonName](#cfn-acmpca-certificate-subject-commonname)" : String,
  "[Country](#cfn-acmpca-certificate-subject-country)" : String,
  "[CustomAttributes](#cfn-acmpca-certificate-subject-customattributes)" : [ CustomAttribute, ... ],
  "[DistinguishedNameQualifier](#cfn-acmpca-certificate-subject-distinguishednamequalifier)" : String,
  "[GenerationQualifier](#cfn-acmpca-certificate-subject-generationqualifier)" : String,
  "[GivenName](#cfn-acmpca-certificate-subject-givenname)" : String,
  "[Initials](#cfn-acmpca-certificate-subject-initials)" : String,
  "[Locality](#cfn-acmpca-certificate-subject-locality)" : String,
  "[Organization](#cfn-acmpca-certificate-subject-organization)" : String,
  "[OrganizationalUnit](#cfn-acmpca-certificate-subject-organizationalunit)" : String,
  "[Pseudonym](#cfn-acmpca-certificate-subject-pseudonym)" : String,
  "[SerialNumber](#cfn-acmpca-certificate-subject-serialnumber)" : String,
  "[State](#cfn-acmpca-certificate-subject-state)" : String,
  "[Surname](#cfn-acmpca-certificate-subject-surname)" : String,
  "[Title](#cfn-acmpca-certificate-subject-title)" : String
}
```

### YAML
<a name="aws-properties-acmpca-certificate-subject-syntax.yaml"></a>

```
  [CommonName](#cfn-acmpca-certificate-subject-commonname): String
  [Country](#cfn-acmpca-certificate-subject-country): String
  [CustomAttributes](#cfn-acmpca-certificate-subject-customattributes): 
    - CustomAttribute
  [DistinguishedNameQualifier](#cfn-acmpca-certificate-subject-distinguishednamequalifier): String
  [GenerationQualifier](#cfn-acmpca-certificate-subject-generationqualifier): String
  [GivenName](#cfn-acmpca-certificate-subject-givenname): String
  [Initials](#cfn-acmpca-certificate-subject-initials): String
  [Locality](#cfn-acmpca-certificate-subject-locality): String
  [Organization](#cfn-acmpca-certificate-subject-organization): String
  [OrganizationalUnit](#cfn-acmpca-certificate-subject-organizationalunit): String
  [Pseudonym](#cfn-acmpca-certificate-subject-pseudonym): String
  [SerialNumber](#cfn-acmpca-certificate-subject-serialnumber): String
  [State](#cfn-acmpca-certificate-subject-state): String
  [Surname](#cfn-acmpca-certificate-subject-surname): String
  [Title](#cfn-acmpca-certificate-subject-title): String
```

## Properties
<a name="aws-properties-acmpca-certificate-subject-properties"></a>

`CommonName`  <a name="cfn-acmpca-certificate-subject-commonname"></a>
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*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Country`  <a name="cfn-acmpca-certificate-subject-country"></a>
Two-digit code that specifies the country in which the certificate subject located.  
*Required*: No  
*Type*: String  
*Pattern*: `[A-Za-z]{2}`  
*Minimum*: `2`  
*Maximum*: `2`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`CustomAttributes`  <a name="cfn-acmpca-certificate-subject-customattributes"></a>
  
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)](https://csrc.nist.gov/glossary/term/Object_Identifier).  
Custom attributes cannot be used in combination with standard attributes.
*Required*: No  
*Type*: Array of [CustomAttribute](aws-properties-acmpca-certificate-customattribute.md)  
*Minimum*: `1`  
*Maximum*: `150`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`DistinguishedNameQualifier`  <a name="cfn-acmpca-certificate-subject-distinguishednamequalifier"></a>
Disambiguating information for the certificate subject.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GenerationQualifier`  <a name="cfn-acmpca-certificate-subject-generationqualifier"></a>
Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `3`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`GivenName`  <a name="cfn-acmpca-certificate-subject-givenname"></a>
First name.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `16`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Initials`  <a name="cfn-acmpca-certificate-subject-initials"></a>
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*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `5`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Locality`  <a name="cfn-acmpca-certificate-subject-locality"></a>
The locality (such as a city or town) in which the certificate subject is located.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Organization`  <a name="cfn-acmpca-certificate-subject-organization"></a>
Legal name of the organization with which the certificate subject is affiliated.   
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`OrganizationalUnit`  <a name="cfn-acmpca-certificate-subject-organizationalunit"></a>
A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Pseudonym`  <a name="cfn-acmpca-certificate-subject-pseudonym"></a>
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*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`SerialNumber`  <a name="cfn-acmpca-certificate-subject-serialnumber"></a>
The certificate serial number.  
*Required*: No  
*Type*: String  
*Pattern*: `[a-zA-Z0-9'()+-.?:/= ]*`  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`State`  <a name="cfn-acmpca-certificate-subject-state"></a>
State in which the subject of the certificate is located.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `128`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Surname`  <a name="cfn-acmpca-certificate-subject-surname"></a>
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*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `40`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Title`  <a name="cfn-acmpca-certificate-subject-title"></a>
A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.  
*Required*: No  
*Type*: String  
*Minimum*: `0`  
*Maximum*: `64`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

# AWS::ACMPCA::Certificate Validity
<a name="aws-properties-acmpca-certificate-validity"></a>

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` operation.

## Syntax
<a name="aws-properties-acmpca-certificate-validity-syntax"></a>

To declare this entity in your CloudFormation template, use the following syntax:

### JSON
<a name="aws-properties-acmpca-certificate-validity-syntax.json"></a>

```
{
  "[Type](#cfn-acmpca-certificate-validity-type)" : String,
  "[Value](#cfn-acmpca-certificate-validity-value)" : Number
}
```

### YAML
<a name="aws-properties-acmpca-certificate-validity-syntax.yaml"></a>

```
  [Type](#cfn-acmpca-certificate-validity-type): String
  [Value](#cfn-acmpca-certificate-validity-value): Number
```

## Properties
<a name="aws-properties-acmpca-certificate-validity-properties"></a>

`Type`  <a name="cfn-acmpca-certificate-validity-type"></a>
Specifies whether the `Value` parameter represents days, months, or years.  
*Required*: Yes  
*Type*: String  
*Allowed values*: `END_DATE | ABSOLUTE | DAYS | MONTHS | YEARS`  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)

`Value`  <a name="cfn-acmpca-certificate-validity-value"></a>
A long integer interpreted according to the value of `Type`, below.  
*Required*: Yes  
*Type*: Number  
*Update requires*: [Replacement](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-updating-stacks-update-behaviors.html#update-replacement)