@awboost/cfn-resource-types 0.1.18 → 0.1.19

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -1,39 +1,43 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * Resource type definition for `AWS::ACMPCA::Certificate`.
5
- * A certificate issued via a private certificate authority
4
+ * 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.
6
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html}
7
6
  */
8
7
  export type ACMPCACertificateProperties = {
9
8
  /**
10
- * These are fields to be overridden in a certificate at the time of issuance. These requires an API_Passthrough template be used or they will be ignored.
9
+ * 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.
11
10
  */
12
11
  ApiPassthrough?: ApiPassthrough;
13
12
  /**
14
- * The Amazon Resource Name (ARN) for the private CA to issue the certificate.
13
+ * The Amazon Resource Name (ARN) for the private CA issues the certificate.
15
14
  */
16
15
  CertificateAuthorityArn: string;
17
16
  /**
18
- * The certificate signing request (CSR) for the Certificate.
17
+ * The certificate signing request (CSR) for the certificate.
19
18
  * @minLength `1`
20
19
  */
21
20
  CertificateSigningRequest: string;
22
21
  /**
23
- * The name of the algorithm that will be used to sign the Certificate.
24
- */
22
+ * The name of the algorithm that will be used to sign the certificate to be issued.
23
+ This parameter should not be confused with the ``SigningAlgorithm`` parameter used to sign a CSR in the ``CreateCertificateAuthority`` action.
24
+ The specified signing algorithm family (RSA or ECDSA) must match the algorithm family of the CA's secret key.
25
+ */
25
26
  SigningAlgorithm: string;
26
27
  /**
27
- * 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.
28
+ * Specifies a custom configuration template to use when issuing a certificate. If this parameter is not provided, PCAshort defaults to the ``EndEntityCertificate/V1`` template. For more information about PCAshort templates, see [Using Templates](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html).
28
29
  */
29
30
  TemplateArn?: string;
30
31
  /**
31
- * The time before which the Certificate will be valid.
32
+ * The period of time during which the certificate will be valid.
32
33
  */
33
34
  Validity: Validity;
34
35
  /**
35
- * The time after which the Certificate will be valid.
36
- */
36
+ * Information describing the start of the validity period of the certificate. This parameter sets the “Not Before" date for the certificate.
37
+ By default, when issuing a certificate, PCAshort 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.
38
+ Unlike the ``Validity`` parameter, the ``ValidityNotBefore`` parameter is optional.
39
+ The ``ValidityNotBefore`` value is expressed as an explicit date and time, using the ``Validity`` type value ``ABSOLUTE``.
40
+ */
37
41
  ValidityNotBefore?: Validity;
38
42
  };
39
43
  /**
@@ -41,33 +45,26 @@ export type ACMPCACertificateProperties = {
41
45
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html#aws-resource-acmpca-certificate-return-values}
42
46
  */
43
47
  export type ACMPCACertificateAttributes = {
44
- /**
45
- * The ARN of the issued certificate.
46
- */
47
48
  Arn: string;
48
- /**
49
- * The issued certificate in base 64 PEM-encoded format.
50
- */
51
49
  Certificate: string;
52
50
  };
53
51
  /**
54
52
  * Type definition for `AWS::ACMPCA::Certificate.ApiPassthrough`.
55
- * Structure that specifies fields to be overridden in a certificate at the time of issuance. These requires an API Passthrough template be used or they will be ignored.
53
+ * 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.
56
54
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html}
57
55
  */
58
56
  export type ApiPassthrough = {
59
57
  /**
60
- * Structure that contains X.500 extensions for a Certificate.
58
+ * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
61
59
  */
62
60
  Extensions?: Extensions;
63
61
  /**
64
- * Structure that contains X.500 distinguished name information.
62
+ * 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.
65
63
  */
66
64
  Subject?: Subject;
67
65
  };
68
66
  /**
69
67
  * Type definition for `AWS::ACMPCA::Certificate.CustomAttribute`.
70
- * Structure that contains X.500 attribute type and value.
71
68
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html}
72
69
  */
73
70
  export type CustomAttribute = {
@@ -79,7 +76,6 @@ export type CustomAttribute = {
79
76
  };
80
77
  /**
81
78
  * Type definition for `AWS::ACMPCA::Certificate.CustomExtension`.
82
- * Structure that contains X.509 extension information for a certificate.
83
79
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html}
84
80
  */
85
81
  export type CustomExtension = {
@@ -92,7 +88,6 @@ export type CustomExtension = {
92
88
  };
93
89
  /**
94
90
  * Type definition for `AWS::ACMPCA::Certificate.EdiPartyName`.
95
- * Structure that contains X.509 EdiPartyName information.
96
91
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html}
97
92
  */
98
93
  export type EdiPartyName = {
@@ -101,7 +96,6 @@ export type EdiPartyName = {
101
96
  };
102
97
  /**
103
98
  * Type definition for `AWS::ACMPCA::Certificate.ExtendedKeyUsage`.
104
- * Structure that contains X.509 ExtendedKeyUsage information.
105
99
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html}
106
100
  */
107
101
  export type ExtendedKeyUsage = {
@@ -113,7 +107,7 @@ export type ExtendedKeyUsage = {
113
107
  };
114
108
  /**
115
109
  * Type definition for `AWS::ACMPCA::Certificate.Extensions`.
116
- * Structure that contains X.500 extensions for a Certificate.
110
+ * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
117
111
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html}
118
112
  */
119
113
  export type Extensions = {
@@ -124,36 +118,30 @@ export type Extensions = {
124
118
  CustomExtensions?: CustomExtension[];
125
119
  ExtendedKeyUsage?: ExtendedKeyUsage[];
126
120
  /**
127
- * Structure that contains X.509 KeyUsage information.
121
+ * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
128
122
  */
129
123
  KeyUsage?: KeyUsage;
130
124
  SubjectAlternativeNames?: GeneralName[];
131
125
  };
132
126
  /**
133
127
  * Type definition for `AWS::ACMPCA::Certificate.GeneralName`.
134
- * Structure that contains X.509 GeneralName information. Assign one and ONLY one field.
128
+ * 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.
135
129
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html}
136
130
  */
137
131
  export type GeneralName = {
138
132
  /**
139
- * Structure that contains X.500 distinguished name information.
133
+ * 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.
140
134
  */
141
135
  DirectoryName?: Subject;
142
136
  /**
143
137
  * String that contains X.509 DnsName information.
144
138
  */
145
139
  DnsName?: string;
146
- /**
147
- * Structure that contains X.509 EdiPartyName information.
148
- */
149
140
  EdiPartyName?: EdiPartyName;
150
141
  /**
151
142
  * String that contains X.509 IpAddress information.
152
143
  */
153
144
  IpAddress?: string;
154
- /**
155
- * Structure that contains X.509 OtherName information.
156
- */
157
145
  OtherName?: OtherName;
158
146
  /**
159
147
  * String that contains X.509 ObjectIdentifier information.
@@ -170,7 +158,6 @@ export type GeneralName = {
170
158
  };
171
159
  /**
172
160
  * Type definition for `AWS::ACMPCA::Certificate.KeyUsage`.
173
- * Structure that contains X.509 KeyUsage information.
174
161
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html}
175
162
  */
176
163
  export type KeyUsage = {
@@ -186,7 +173,6 @@ export type KeyUsage = {
186
173
  };
187
174
  /**
188
175
  * Type definition for `AWS::ACMPCA::Certificate.OtherName`.
189
- * Structure that contains X.509 OtherName information.
190
176
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html}
191
177
  */
192
178
  export type OtherName = {
@@ -198,7 +184,6 @@ export type OtherName = {
198
184
  };
199
185
  /**
200
186
  * Type definition for `AWS::ACMPCA::Certificate.PolicyInformation`.
201
- * Structure that contains X.509 Policy information.
202
187
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html}
203
188
  */
204
189
  export type PolicyInformation = {
@@ -210,19 +195,14 @@ export type PolicyInformation = {
210
195
  };
211
196
  /**
212
197
  * Type definition for `AWS::ACMPCA::Certificate.PolicyQualifierInfo`.
213
- * Structure that contains X.509 Policy qualifier information.
214
198
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html}
215
199
  */
216
200
  export type PolicyQualifierInfo = {
217
201
  PolicyQualifierId: string;
218
- /**
219
- * Structure that contains a X.509 policy qualifier.
220
- */
221
202
  Qualifier: Qualifier;
222
203
  };
223
204
  /**
224
205
  * Type definition for `AWS::ACMPCA::Certificate.Qualifier`.
225
- * Structure that contains a X.509 policy qualifier.
226
206
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html}
227
207
  */
228
208
  export type Qualifier = {
@@ -230,41 +210,89 @@ export type Qualifier = {
230
210
  };
231
211
  /**
232
212
  * Type definition for `AWS::ACMPCA::Certificate.Subject`.
233
- * Structure that contains X.500 distinguished name information.
213
+ * 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.
234
214
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-subject.html}
235
215
  */
236
216
  export type Subject = {
217
+ /**
218
+ * For CA and end-entity certificates in a private PKI, the common name (CN) can be any string within the length limit.
219
+ Note: In publicly trusted certificates, the common name must be a fully qualified domain name (FQDN) associated with the certificate subject.
220
+ */
237
221
  CommonName?: string;
222
+ /**
223
+ * Two-digit code that specifies the country in which the certificate subject located.
224
+ */
238
225
  Country?: string;
239
226
  /**
240
227
  * Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.
241
228
  */
242
229
  CustomAttributes?: CustomAttribute[];
230
+ /**
231
+ * Disambiguating information for the certificate subject.
232
+ */
243
233
  DistinguishedNameQualifier?: string;
234
+ /**
235
+ * Typically a qualifier appended to the name of an individual. Examples include Jr. for junior, Sr. for senior, and III for third.
236
+ */
244
237
  GenerationQualifier?: string;
238
+ /**
239
+ * First name.
240
+ */
245
241
  GivenName?: string;
242
+ /**
243
+ * 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*.
244
+ */
246
245
  Initials?: string;
246
+ /**
247
+ * The locality (such as a city or town) in which the certificate subject is located.
248
+ */
247
249
  Locality?: string;
250
+ /**
251
+ * Legal name of the organization with which the certificate subject is affiliated.
252
+ */
248
253
  Organization?: string;
254
+ /**
255
+ * A subdivision or unit of the organization (such as sales or finance) with which the certificate subject is affiliated.
256
+ */
249
257
  OrganizationalUnit?: string;
258
+ /**
259
+ * 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.
260
+ */
250
261
  Pseudonym?: string;
262
+ /**
263
+ * The certificate serial number.
264
+ */
251
265
  SerialNumber?: string;
266
+ /**
267
+ * State in which the subject of the certificate is located.
268
+ */
252
269
  State?: string;
270
+ /**
271
+ * 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.
272
+ */
253
273
  Surname?: string;
274
+ /**
275
+ * A title such as Mr. or Ms., which is pre-pended to the name to refer formally to the certificate subject.
276
+ */
254
277
  Title?: string;
255
278
  };
256
279
  /**
257
280
  * Type definition for `AWS::ACMPCA::Certificate.Validity`.
258
- * Validity for a certificate.
281
+ * 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.
259
282
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-validity.html}
260
283
  */
261
284
  export type Validity = {
285
+ /**
286
+ * Specifies whether the ``Value`` parameter represents days, months, or years.
287
+ */
262
288
  Type: string;
289
+ /**
290
+ * Time period.
291
+ */
263
292
  Value: number;
264
293
  };
265
294
  /**
266
- * Resource type definition for `AWS::ACMPCA::Certificate`.
267
- * A certificate issued via a private certificate authority
295
+ * 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.
268
296
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html}
269
297
  */
270
298
  export declare class ACMPCACertificate extends $Resource<"AWS::ACMPCA::Certificate", ACMPCACertificateProperties, ACMPCACertificateAttributes> {
@@ -1,7 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource type definition for `AWS::ACMPCA::Certificate`.
4
- * A certificate issued via a private certificate authority
3
+ * 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.
5
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-acmpca-certificate.html}
6
5
  */
7
6
  export class ACMPCACertificate extends $Resource {
@@ -1,9 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * The AWS::SecurityHub::AutomationRule resource represents the Automation Rule in your account. One rule resource is created for each Automation Rule in which you configure rule criteria and actions.
5
-
6
-
4
+ * The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
7
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html}
8
6
  */
9
7
  export type SecurityHubAutomationRuleProperties = {
@@ -13,33 +11,27 @@ export type SecurityHubAutomationRuleProperties = {
13
11
  */
14
12
  Actions?: AutomationRulesAction[];
15
13
  /**
16
- * The rule criteria for evaluating findings
14
+ * A set of [Security Finding Format (ASFF)](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-findings-format.html) finding field attributes and corresponding expected values that ASH uses to filter findings. If a rule is enabled and a finding matches the criteria specified in this parameter, ASH applies the rule action to the finding.
17
15
  */
18
16
  Criteria?: AutomationRulesFindingFilters;
19
17
  /**
20
- * Rule description
21
18
  * @minLength `1`
22
19
  * @maxLength `1024`
23
20
  */
24
21
  Description?: string;
25
- /**
26
- * If Rule is a terminal rule
27
- */
28
22
  IsTerminal?: boolean;
29
23
  /**
30
- * Rule name
31
24
  * @minLength `1`
32
25
  * @maxLength `256`
33
26
  */
34
27
  RuleName?: string;
35
28
  /**
36
- * Rule order value
37
29
  * @min `1`
38
30
  * @max `1000`
39
31
  */
40
32
  RuleOrder?: number;
41
33
  /**
42
- * Status of the Rule upon creation
34
+ * Whether the rule is active after it is created. If this parameter is equal to ``ENABLED``, ASH applies the rule to findings and finding updates after the rule is created.
43
35
  */
44
36
  RuleStatus?: "ENABLED" | "DISABLED";
45
37
  /**
@@ -53,29 +45,28 @@ export type SecurityHubAutomationRuleProperties = {
53
45
  */
54
46
  export type SecurityHubAutomationRuleAttributes = {
55
47
  /**
56
- * The date and time when Automation Rule was created
48
+ * The date and time, in UTC and ISO 8601 format.
57
49
  * @pattern `^(\d\d\d\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\d)|[3][0-1])[T](?:([0-1](\d)|[2][0-3]):[0-5](\d):[0-5](\d)|23:59:60)(?:\.(\d)+)?([Z]|[+-](\d\d)(:?(\d\d))?)$`
58
50
  */
59
51
  CreatedAt: string;
60
52
  /**
61
- * The identifier by which created the rule
62
53
  * @minLength `1`
63
54
  * @maxLength `256`
64
55
  */
65
56
  CreatedBy: string;
66
57
  /**
67
- * An Automation Rule Arn is automatically created
68
58
  * @pattern `arn:aws\S*:securityhub:\S*`
69
59
  */
70
60
  RuleArn: string;
71
61
  /**
72
- * The date and time when Automation Rule was last updated
62
+ * The date and time, in UTC and ISO 8601 format.
73
63
  * @pattern `^(\d\d\d\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\d)|[3][0-1])[T](?:([0-1](\d)|[2][0-3]):[0-5](\d):[0-5](\d)|23:59:60)(?:\.(\d)+)?([Z]|[+-](\d\d)(:?(\d\d))?)$`
74
64
  */
75
65
  UpdatedAt: string;
76
66
  };
77
67
  /**
78
68
  * Type definition for `AWS::SecurityHub::AutomationRule.arnOrId`.
69
+ * The Amazon Resource Name (ARN) or Id of the automation rule.
79
70
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-arnorid.html}
80
71
  */
81
72
  export type arnOrId = string | string;
@@ -84,45 +75,55 @@ export type arnOrId = string | string;
84
75
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesaction.html}
85
76
  */
86
77
  export type AutomationRulesAction = {
78
+ /**
79
+ * The rule action will update the ``Note`` field of a finding.
80
+ */
87
81
  FindingFieldsUpdate: AutomationRulesFindingFieldsUpdate;
88
82
  Type: "FINDING_FIELDS_UPDATE";
89
83
  };
90
84
  /**
91
85
  * Type definition for `AWS::SecurityHub::AutomationRule.AutomationRulesFindingFieldsUpdate`.
86
+ * The rule action will update the ``Note`` field of a finding.
92
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-automationrulesfindingfieldsupdate.html}
93
88
  */
94
89
  export type AutomationRulesFindingFieldsUpdate = {
95
90
  /**
91
+ * Integer from 0 to 100.
96
92
  * @min `0`
97
93
  * @max `100`
98
94
  */
99
95
  Confidence?: number;
100
96
  /**
97
+ * Integer from 0 to 100.
101
98
  * @min `0`
102
99
  * @max `100`
103
100
  */
104
101
  Criticality?: number;
105
102
  /**
106
- * Note added to the finding
103
+ * The rule action will update the ``Note`` field of a finding.
107
104
  */
108
105
  Note?: NoteUpdate;
109
106
  /**
107
+ * The rule action will update the ``RelatedFindings`` field of a finding.
110
108
  * @minLength `1`
111
109
  * @maxLength `10`
112
110
  */
113
111
  RelatedFindings?: RelatedFinding[];
114
112
  /**
115
- * Severity of the finding
113
+ * The rule action will update the ``Severity`` field of a finding.
116
114
  */
117
115
  Severity?: SeverityUpdate;
118
116
  /**
119
117
  * @maxLength `50`
120
118
  */
121
119
  Types?: string[];
120
+ /**
121
+ * An object of user-defined name and value string pair added to a finding.
122
+ */
122
123
  UserDefinedFields?: map;
123
124
  VerificationState?: "UNKNOWN" | "TRUE_POSITIVE" | "FALSE_POSITIVE" | "BENIGN_POSITIVE";
124
125
  /**
125
- * Workflow status set for the finding
126
+ * The rule action will update the ``Workflow`` field of a finding.
126
127
  */
127
128
  Workflow?: WorkflowUpdate;
128
129
  };
@@ -279,10 +280,12 @@ export type AutomationRulesFindingFilters = {
279
280
  export type DateFilter = {
280
281
  DateRange?: DateRange;
281
282
  /**
283
+ * The date and time, in UTC and ISO 8601 format.
282
284
  * @pattern `^(\d\d\d\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\d)|[3][0-1])[T](?:([0-1](\d)|[2][0-3]):[0-5](\d):[0-5](\d)|23:59:60)(?:\.(\d)+)?([Z]|[+-](\d\d)(:?(\d\d))?)$`
283
285
  */
284
286
  End?: string;
285
287
  /**
288
+ * The date and time, in UTC and ISO 8601 format.
286
289
  * @pattern `^(\d\d\d\d)-([0][1-9]|[1][0-2])-([0][1-9]|[1-2](\d)|[3][0-1])[T](?:([0-1](\d)|[2][0-3]):[0-5](\d):[0-5](\d)|23:59:60)(?:\.(\d)+)?([Z]|[+-](\d\d)(:?(\d\d))?)$`
287
290
  */
288
291
  Start?: string;
@@ -297,6 +300,7 @@ export type DateRange = {
297
300
  };
298
301
  /**
299
302
  * Type definition for `AWS::SecurityHub::AutomationRule.map`.
303
+ * An object of user-defined name and value string pair added to a finding.
300
304
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-map.html}
301
305
  */
302
306
  export type map = Record<string, string>;
@@ -319,6 +323,9 @@ export type NoteUpdate = {
319
323
  * @maxLength `512`
320
324
  */
321
325
  Text: string;
326
+ /**
327
+ * The Amazon Resource Name (ARN) or Id of the automation rule.
328
+ */
322
329
  UpdatedBy: arnOrId;
323
330
  };
324
331
  /**
@@ -332,11 +339,16 @@ export type NumberFilter = {
332
339
  };
333
340
  /**
334
341
  * Type definition for `AWS::SecurityHub::AutomationRule.RelatedFinding`.
342
+ * Provides details about a list of findings that the current finding relates to.
335
343
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-relatedfinding.html}
336
344
  */
337
345
  export type RelatedFinding = {
346
+ /**
347
+ * The Amazon Resource Name (ARN) or Id of the automation rule.
348
+ */
338
349
  Id: arnOrId;
339
350
  /**
351
+ * The Amazon Resource Name (ARN) for the product that generated a related finding.
340
352
  * @minLength `12`
341
353
  * @maxLength `2048`
342
354
  * @pattern `^arn:(aws|aws-cn|aws-us-gov|aws-iso-?[a-z]{0,2}):[A-Za-z0-9]{1,63}:[a-z]+-([a-z]{1,10}-)?[a-z]+-[0-9]+:([0-9]{12})?:.+$`
@@ -350,6 +362,7 @@ export type RelatedFinding = {
350
362
  export type SeverityUpdate = {
351
363
  Label?: "INFORMATIONAL" | "LOW" | "MEDIUM" | "HIGH" | "CRITICAL";
352
364
  /**
365
+ * Integer from 0 to 100.
353
366
  * @min `0`
354
367
  * @max `100`
355
368
  */
@@ -361,11 +374,15 @@ export type SeverityUpdate = {
361
374
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfilter.html}
362
375
  */
363
376
  export type StringFilter = {
377
+ /**
378
+ * The condition to apply to a string value when filtering Security Hub findings.
379
+ */
364
380
  Comparison: StringFilterComparison;
365
381
  Value: string;
366
382
  };
367
383
  /**
368
384
  * Type definition for `AWS::SecurityHub::AutomationRule.StringFilterComparison`.
385
+ * The condition to apply to a string value when filtering Security Hub findings.
369
386
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-automationrule-stringfiltercomparison.html}
370
387
  */
371
388
  export type StringFilterComparison = "EQUALS" | "PREFIX" | "NOT_EQUALS" | "PREFIX_NOT_EQUALS" | "CONTAINS" | "NOT_CONTAINS";
@@ -383,9 +400,7 @@ export type WorkflowUpdate = {
383
400
  Status: "NEW" | "NOTIFIED" | "RESOLVED" | "SUPPRESSED";
384
401
  };
385
402
  /**
386
- * The AWS::SecurityHub::AutomationRule resource represents the Automation Rule in your account. One rule resource is created for each Automation Rule in which you configure rule criteria and actions.
387
-
388
-
403
+ * The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
389
404
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html}
390
405
  */
391
406
  export declare class SecurityHubAutomationRule extends $Resource<"AWS::SecurityHub::AutomationRule", SecurityHubAutomationRuleProperties, SecurityHubAutomationRuleAttributes> {
@@ -1,8 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::SecurityHub::AutomationRule resource represents the Automation Rule in your account. One rule resource is created for each Automation Rule in which you configure rule criteria and actions.
4
-
5
-
3
+ * The ``AWS::SecurityHub::AutomationRule`` resource specifies an automation rule based on input parameters. For more information, see [Automation rules](https://docs.aws.amazon.com/securityhub/latest/userguide/automation-rules.html) in the *User Guide*.
6
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-automationrule.html}
7
5
  */
8
6
  export class SecurityHubAutomationRule extends $Resource {
@@ -1,18 +1,21 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-builder/template";
3
3
  /**
4
- * The AWS::SecurityHub::Standard resource represents the implementation of an individual AWS Security Hub Standard in your account. It requires you have SecurityHub enabled before you can enable the Standard.
4
+ * The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
5
+ You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.
6
+ For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-standard.html}
6
8
  */
7
9
  export type SecurityHubStandardProperties = {
8
10
  /**
9
- * StandardsControls to disable from this Standard.
11
+ * Specifies which controls are to be disabled in a standard.
12
+ *Maximum*: ``100``
10
13
  * @minLength `0`
11
14
  * @maxLength `100`
12
15
  */
13
16
  DisabledStandardsControls?: StandardsControl[];
14
17
  /**
15
- * The ARN of the Standard being enabled
18
+ * The ARN of the standard that you want to enable. To view a list of available ASH standards and their ARNs, use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
16
19
  * @pattern `arn:aws\S*:securityhub:\S`
17
20
  */
18
21
  StandardsArn: string;
@@ -23,29 +26,30 @@ export type SecurityHubStandardProperties = {
23
26
  */
24
27
  export type SecurityHubStandardAttributes = {
25
28
  /**
26
- * The ARN of the StandardsSubscription for the account ID, region, and Standard.
27
29
  * @pattern `arn:aws\S*:securityhub:\S*`
28
30
  */
29
31
  StandardsSubscriptionArn: string;
30
32
  };
31
33
  /**
32
34
  * Type definition for `AWS::SecurityHub::Standard.StandardsControl`.
33
- * An individual StandardsControl within the Standard.
35
+ * Provides details about an individual security control. For a list of ASH controls, see [controls reference](https://docs.aws.amazon.com/securityhub/latest/userguide/securityhub-controls-reference.html) in the *User Guide*.
34
36
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-securityhub-standard-standardscontrol.html}
35
37
  */
36
38
  export type StandardsControl = {
37
39
  /**
38
- * the reason the standard control is disabled
40
+ * A user-defined reason for changing a control's enablement status in a specified standard. If you are disabling a control, then this property is required.
39
41
  */
40
42
  Reason?: string;
41
43
  /**
42
- * the Arn for the standard control.
44
+ * The Amazon Resource Name (ARN) of the control.
43
45
  * @pattern `arn:aws\S*:securityhub:\S*`
44
46
  */
45
47
  StandardsControlArn: string;
46
48
  };
47
49
  /**
48
- * The AWS::SecurityHub::Standard resource represents the implementation of an individual AWS Security Hub Standard in your account. It requires you have SecurityHub enabled before you can enable the Standard.
50
+ * The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
51
+ You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.
52
+ For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
49
53
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-standard.html}
50
54
  */
51
55
  export declare class SecurityHubStandard extends $Resource<"AWS::SecurityHub::Standard", SecurityHubStandardProperties, SecurityHubStandardAttributes> {
@@ -1,6 +1,8 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::SecurityHub::Standard resource represents the implementation of an individual AWS Security Hub Standard in your account. It requires you have SecurityHub enabled before you can enable the Standard.
3
+ * The ``AWS::SecurityHub::Standard`` resource specifies the enablement of a security standard. The standard is identified by the ``StandardsArn`` property. To view a list of ASH standards and their Amazon Resource Names (ARNs), use the [DescribeStandards](https://docs.aws.amazon.com/securityhub/1.0/APIReference/API_DescribeStandards.html) API operation.
4
+ You must create a separate ``AWS::SecurityHub::Standard`` resource for each standard that you want to enable.
5
+ For more information about ASH standards, see [standards reference](https://docs.aws.amazon.com/securityhub/latest/userguide/standards-reference.html) in the *User Guide*.
4
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-securityhub-standard.html}
5
7
  */
6
8
  export class SecurityHubStandard extends $Resource {
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.18",
3
+ "version": "0.1.19",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },