UNPKG

20.1 kBTypeScriptView Raw
1import * as cdk from '@aws-cdk/core';
2import * as cfn_parse from '@aws-cdk/core/lib/helpers-internal';
3/**
4 * Properties for defining a `CfnAccount`
5 *
6 * @struct
7 * @stability external
8 *
9 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html
10 */
11export interface CfnAccountProps {
12 /**
13 * Object containing expiration events options associated with an AWS account . For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.
14 *
15 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html#cfn-certificatemanager-account-expiryeventsconfiguration
16 */
17 readonly expiryEventsConfiguration: CfnAccount.ExpiryEventsConfigurationProperty | cdk.IResolvable;
18}
19/**
20 * A CloudFormation `AWS::CertificateManager::Account`
21 *
22 * The `AWS::CertificateManager::Account` resource defines the expiry event configuration that determines the number of days prior to expiry when ACM starts generating EventBridge events.
23 *
24 * @cloudformationResource AWS::CertificateManager::Account
25 * @stability external
26 *
27 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html
28 */
29export declare class CfnAccount extends cdk.CfnResource implements cdk.IInspectable {
30 /**
31 * The CloudFormation resource type name for this resource class.
32 */
33 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CertificateManager::Account";
34 /**
35 * A factory method that creates a new instance of this class from an object
36 * containing the CloudFormation properties of this resource.
37 * Used in the @aws-cdk/cloudformation-include module.
38 *
39 * @internal
40 */
41 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnAccount;
42 /**
43 * ID of the AWS account that owns the certificate.
44 * @cloudformationAttribute AccountId
45 */
46 readonly attrAccountId: string;
47 /**
48 * Object containing expiration events options associated with an AWS account . For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.
49 *
50 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-account.html#cfn-certificatemanager-account-expiryeventsconfiguration
51 */
52 expiryEventsConfiguration: CfnAccount.ExpiryEventsConfigurationProperty | cdk.IResolvable;
53 /**
54 * Create a new `AWS::CertificateManager::Account`.
55 *
56 * @param scope - scope in which this resource is defined
57 * @param id - scoped id of the resource
58 * @param props - resource properties
59 */
60 constructor(scope: cdk.Construct, id: string, props: CfnAccountProps);
61 /**
62 * Examines the CloudFormation resource and discloses attributes.
63 *
64 * @param inspector - tree inspector to collect and process attributes
65 *
66 */
67 inspect(inspector: cdk.TreeInspector): void;
68 protected get cfnProperties(): {
69 [key: string]: any;
70 };
71 protected renderProperties(props: {
72 [key: string]: any;
73 }): {
74 [key: string]: any;
75 };
76}
77export declare namespace CfnAccount {
78 /**
79 * Object containing expiration events options associated with an AWS account . For more information, see [ExpiryEventsConfiguration](https://docs.aws.amazon.com/acm/latest/APIReference/API_ExpiryEventsConfiguration.html) in the API reference.
80 *
81 * @struct
82 * @stability external
83 *
84 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-account-expiryeventsconfiguration.html
85 */
86 interface ExpiryEventsConfigurationProperty {
87 /**
88 * This option specifies the number of days prior to certificate expiration when ACM starts generating `EventBridge` events. ACM sends one event per day per certificate until the certificate expires. By default, accounts receive events starting 45 days before certificate expiration.
89 *
90 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-account-expiryeventsconfiguration.html#cfn-certificatemanager-account-expiryeventsconfiguration-daysbeforeexpiry
91 */
92 readonly daysBeforeExpiry?: number;
93 }
94}
95/**
96 * Properties for defining a `CfnCertificate`
97 *
98 * @struct
99 * @stability external
100 *
101 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html
102 */
103export interface CfnCertificateProps {
104 /**
105 * The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, `*.example.com` protects `www.example.com` , `site.example.com` , and `images.example.com.`
106 *
107 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname
108 */
109 readonly domainName: string;
110 /**
111 * The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the [AWS Private Certificate Authority](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide. The ARN must have the following form:
112 *
113 * `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012`
114 *
115 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateauthorityarn
116 */
117 readonly certificateAuthorityArn?: string;
118 /**
119 * You can opt out of certificate transparency logging by specifying the `DISABLED` option. Opt in by specifying `ENABLED` .
120 *
121 * If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.
122 *
123 * Changing the certificate transparency logging preference will update the existing resource by calling `UpdateCertificateOptions` on the certificate. This action will not create a new resource.
124 *
125 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificatetransparencyloggingpreference
126 */
127 readonly certificateTransparencyLoggingPreference?: string;
128 /**
129 * Domain information that domain name registrars use to verify your identity.
130 *
131 * > In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the `DomainName` property needs to be identical to one of the `DomainName` property supplied in DomainValidationOptions, if the ValidationMethod is **DNS**. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.
132 *
133 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions
134 */
135 readonly domainValidationOptions?: Array<CfnCertificate.DomainValidationOptionProperty | cdk.IResolvable> | cdk.IResolvable;
136 /**
137 * Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add www.example.net to a certificate for which the `DomainName` field is www.example.com if users can reach your site by using either name.
138 *
139 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames
140 */
141 readonly subjectAlternativeNames?: string[];
142 /**
143 * Key-value pairs that can identify the certificate.
144 *
145 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags
146 */
147 readonly tags?: cdk.CfnTag[];
148 /**
149 * The method you want to use to validate that you own or control the domain associated with a public certificate. You can [validate with DNS](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or [validate with email](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html) . We recommend that you use DNS validation.
150 *
151 * If not specified, this property defaults to email validation.
152 *
153 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod
154 */
155 readonly validationMethod?: string;
156}
157/**
158 * A CloudFormation `AWS::CertificateManager::Certificate`
159 *
160 * The `AWS::CertificateManager::Certificate` resource requests an AWS Certificate Manager ( ACM ) certificate that you can use to enable secure connections. For example, you can deploy an ACM certificate to an Elastic Load Balancer to enable HTTPS support. For more information, see [RequestCertificate](https://docs.aws.amazon.com/acm/latest/APIReference/API_RequestCertificate.html) in the AWS Certificate Manager API Reference.
161 *
162 * > When you use the `AWS::CertificateManager::Certificate` resource in a CloudFormation stack, domain validation is handled automatically if all three of the following are true: The certificate domain is hosted in Amazon Route 53, the domain resides in your AWS account , and you are using DNS validation.
163 * >
164 * > However, if the certificate uses email validation, or if the domain is not hosted in Route 53, then the stack will remain in the `CREATE_IN_PROGRESS` state. Further stack operations are delayed until you validate the certificate request, either by acting upon the instructions in the validation email, or by adding a CNAME record to your DNS configuration. For more information, see [Option 1: DNS Validation](https://docs.aws.amazon.com/acm/latest/userguide/dns-validation.html) and [Option 2: Email Validation](https://docs.aws.amazon.com/acm/latest/userguide/email-validation.html) .
165 *
166 * @cloudformationResource AWS::CertificateManager::Certificate
167 * @stability external
168 *
169 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html
170 */
171export declare class CfnCertificate extends cdk.CfnResource implements cdk.IInspectable {
172 /**
173 * The CloudFormation resource type name for this resource class.
174 */
175 static readonly CFN_RESOURCE_TYPE_NAME = "AWS::CertificateManager::Certificate";
176 /**
177 * A factory method that creates a new instance of this class from an object
178 * containing the CloudFormation properties of this resource.
179 * Used in the @aws-cdk/cloudformation-include module.
180 *
181 * @internal
182 */
183 static _fromCloudFormation(scope: cdk.Construct, id: string, resourceAttributes: any, options: cfn_parse.FromCloudFormationOptions): CfnCertificate;
184 /**
185 * The fully qualified domain name (FQDN), such as www.example.com, with which you want to secure an ACM certificate. Use an asterisk (*) to create a wildcard certificate that protects several sites in the same domain. For example, `*.example.com` protects `www.example.com` , `site.example.com` , and `images.example.com.`
186 *
187 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainname
188 */
189 domainName: string;
190 /**
191 * The Amazon Resource Name (ARN) of the private certificate authority (CA) that will be used to issue the certificate. If you do not provide an ARN and you are trying to request a private certificate, ACM will attempt to issue a public certificate. For more information about private CAs, see the [AWS Private Certificate Authority](https://docs.aws.amazon.com/privateca/latest/userguide/PcaWelcome.html) user guide. The ARN must have the following form:
192 *
193 * `arn:aws:acm-pca:region:account:certificate-authority/12345678-1234-1234-1234-123456789012`
194 *
195 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificateauthorityarn
196 */
197 certificateAuthorityArn: string | undefined;
198 /**
199 * You can opt out of certificate transparency logging by specifying the `DISABLED` option. Opt in by specifying `ENABLED` .
200 *
201 * If you do not specify a certificate transparency logging preference on a new CloudFormation template, or if you remove the logging preference from an existing template, this is the same as explicitly enabling the preference.
202 *
203 * Changing the certificate transparency logging preference will update the existing resource by calling `UpdateCertificateOptions` on the certificate. This action will not create a new resource.
204 *
205 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-certificatetransparencyloggingpreference
206 */
207 certificateTransparencyLoggingPreference: string | undefined;
208 /**
209 * Domain information that domain name registrars use to verify your identity.
210 *
211 * > In order for a AWS::CertificateManager::Certificate to be provisioned and validated in CloudFormation automatically, the `DomainName` property needs to be identical to one of the `DomainName` property supplied in DomainValidationOptions, if the ValidationMethod is **DNS**. Failing to keep them like-for-like will result in failure to create the domain validation records in Route53.
212 *
213 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-domainvalidationoptions
214 */
215 domainValidationOptions: Array<CfnCertificate.DomainValidationOptionProperty | cdk.IResolvable> | cdk.IResolvable | undefined;
216 /**
217 * Additional FQDNs to be included in the Subject Alternative Name extension of the ACM certificate. For example, you can add www.example.net to a certificate for which the `DomainName` field is www.example.com if users can reach your site by using either name.
218 *
219 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-subjectalternativenames
220 */
221 subjectAlternativeNames: string[] | undefined;
222 /**
223 * Key-value pairs that can identify the certificate.
224 *
225 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-tags
226 */
227 readonly tags: cdk.TagManager;
228 /**
229 * The method you want to use to validate that you own or control the domain associated with a public certificate. You can [validate with DNS](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-dns.html) or [validate with email](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-validate-email.html) . We recommend that you use DNS validation.
230 *
231 * If not specified, this property defaults to email validation.
232 *
233 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html#cfn-certificatemanager-certificate-validationmethod
234 */
235 validationMethod: string | undefined;
236 /**
237 * Create a new `AWS::CertificateManager::Certificate`.
238 *
239 * @param scope - scope in which this resource is defined
240 * @param id - scoped id of the resource
241 * @param props - resource properties
242 */
243 constructor(scope: cdk.Construct, id: string, props: CfnCertificateProps);
244 /**
245 * Examines the CloudFormation resource and discloses attributes.
246 *
247 * @param inspector - tree inspector to collect and process attributes
248 *
249 */
250 inspect(inspector: cdk.TreeInspector): void;
251 protected get cfnProperties(): {
252 [key: string]: any;
253 };
254 protected renderProperties(props: {
255 [key: string]: any;
256 }): {
257 [key: string]: any;
258 };
259}
260export declare namespace CfnCertificate {
261 /**
262 * `DomainValidationOption` is a property of the [AWS::CertificateManager::Certificate](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-certificatemanager-certificate.html) resource that specifies the AWS Certificate Manager ( ACM ) certificate domain to validate. Depending on the chosen validation method, ACM checks the domain's DNS record for a validation CNAME, or it attempts to send a validation email message to the domain owner.
263 *
264 * @struct
265 * @stability external
266 *
267 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html
268 */
269 interface DomainValidationOptionProperty {
270 /**
271 * A fully qualified domain name (FQDN) in the certificate request.
272 *
273 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoptions-domainname
274 */
275 readonly domainName: string;
276 /**
277 * The `HostedZoneId` option, which is available if you are using Route 53 as your domain registrar, causes ACM to add your CNAME to the domain record. Your list of `DomainValidationOptions` must contain one and only one of the domain-validation options, and the `HostedZoneId` can be used only when `DNS` is specified as your validation method.
278 *
279 * Use the Route 53 `ListHostedZones` API to discover IDs for available hosted zones.
280 *
281 * This option is required for publicly trusted certificates.
282 *
283 * > The `ListHostedZones` API returns IDs in the format "/hostedzone/Z111111QQQQQQQ", but CloudFormation requires the IDs to be in the format "Z111111QQQQQQQ".
284 *
285 * When you change your `DomainValidationOptions` , a new resource is created.
286 *
287 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-hostedzoneid
288 */
289 readonly hostedZoneId?: string;
290 /**
291 * The domain name to which you want ACM to send validation emails. This domain name is the suffix of the email addresses that you want ACM to use. This must be the same as the `DomainName` value or a superdomain of the `DomainName` value. For example, if you request a certificate for `testing.example.com` , you can specify `example.com` as this value. In that case, ACM sends domain validation emails to the following five addresses:
292 *
293 * - admin@example.com
294 * - administrator@example.com
295 * - hostmaster@example.com
296 * - postmaster@example.com
297 * - webmaster@example.com
298 *
299 * @link http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-certificatemanager-certificate-domainvalidationoption.html#cfn-certificatemanager-certificate-domainvalidationoption-validationdomain
300 */
301 readonly validationDomain?: string;
302 }
303}