@awboost/cfn-resource-types 0.1.23 → 0.1.25

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.
@@ -50,12 +50,13 @@ export type ACMPCACertificateAttributes = {
50
50
  };
51
51
  /**
52
52
  * Type definition for `AWS::ACMPCA::Certificate.ApiPassthrough`.
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.
53
+ * 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.
54
+ 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.
54
55
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-apipassthrough.html}
55
56
  */
56
57
  export type ApiPassthrough = {
57
58
  /**
58
- * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
59
+ * Specifies X.509 extension information for a certificate.
59
60
  */
60
61
  Extensions?: Extensions;
61
62
  /**
@@ -65,67 +66,100 @@ export type ApiPassthrough = {
65
66
  };
66
67
  /**
67
68
  * Type definition for `AWS::ACMPCA::Certificate.CustomAttribute`.
69
+ * Defines the X.500 relative distinguished name (RDN).
68
70
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customattribute.html}
69
71
  */
70
72
  export type CustomAttribute = {
71
73
  /**
72
- * String that contains X.509 ObjectIdentifier information.
74
+ * Specifies the object identifier (OID) of the attribute type of the relative distinguished name (RDN).
73
75
  */
74
76
  ObjectIdentifier: string;
77
+ /**
78
+ * Specifies the attribute value of relative distinguished name (RDN).
79
+ */
75
80
  Value: string;
76
81
  };
77
82
  /**
78
83
  * Type definition for `AWS::ACMPCA::Certificate.CustomExtension`.
84
+ * Specifies the X.509 extension information for a certificate.
85
+ Extensions present in ``CustomExtensions`` follow the ``ApiPassthrough`` [template rules](https://docs.aws.amazon.com/privateca/latest/userguide/UsingTemplates.html#template-order-of-operations).
79
86
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-customextension.html}
80
87
  */
81
88
  export type CustomExtension = {
89
+ /**
90
+ * Specifies the critical flag of the X.509 extension.
91
+ */
82
92
  Critical?: boolean;
83
93
  /**
84
- * String that contains X.509 ObjectIdentifier information.
94
+ * Specifies the object identifier (OID) of the X.509 extension. For more information, see the [Global OID reference database.](https://docs.aws.amazon.com/https://oidref.com/2.5.29)
85
95
  */
86
96
  ObjectIdentifier: string;
97
+ /**
98
+ * Specifies the base64-encoded value of the X.509 extension.
99
+ */
87
100
  Value: string;
88
101
  };
89
102
  /**
90
103
  * Type definition for `AWS::ACMPCA::Certificate.EdiPartyName`.
104
+ * Describes an Electronic Data Interchange (EDI) entity as described in as defined in [Subject Alternative Name](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280) in RFC 5280.
91
105
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-edipartyname.html}
92
106
  */
93
107
  export type EdiPartyName = {
108
+ /**
109
+ * Specifies the name assigner.
110
+ */
94
111
  NameAssigner: string;
112
+ /**
113
+ * Specifies the party name.
114
+ */
95
115
  PartyName: string;
96
116
  };
97
117
  /**
98
118
  * Type definition for `AWS::ACMPCA::Certificate.ExtendedKeyUsage`.
119
+ * Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.
99
120
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extendedkeyusage.html}
100
121
  */
101
122
  export type ExtendedKeyUsage = {
102
123
  /**
103
- * String that contains X.509 ObjectIdentifier information.
124
+ * Specifies a custom ``ExtendedKeyUsage`` with an object identifier (OID).
104
125
  */
105
126
  ExtendedKeyUsageObjectIdentifier?: string;
127
+ /**
128
+ * Specifies a standard ``ExtendedKeyUsage`` as defined as in [RFC 5280](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.12).
129
+ */
106
130
  ExtendedKeyUsageType?: string;
107
131
  };
108
132
  /**
109
133
  * Type definition for `AWS::ACMPCA::Certificate.Extensions`.
110
- * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
134
+ * Contains X.509 extension information for a certificate.
111
135
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-extensions.html}
112
136
  */
113
137
  export type Extensions = {
138
+ /**
139
+ * 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://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
140
+ 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.
141
+ */
114
142
  CertificatePolicies?: PolicyInformation[];
115
143
  /**
116
- * Array of X.509 extensions for a certificate.
144
+ * 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://docs.aws.amazon.com/https://oidref.com/2.5.29)
117
145
  */
118
146
  CustomExtensions?: CustomExtension[];
147
+ /**
148
+ * Specifies additional purposes for which the certified public key may be used other than basic purposes indicated in the ``KeyUsage`` extension.
149
+ */
119
150
  ExtendedKeyUsage?: ExtendedKeyUsage[];
120
151
  /**
121
152
  * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
122
153
  */
123
154
  KeyUsage?: KeyUsage;
155
+ /**
156
+ * 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.
157
+ */
124
158
  SubjectAlternativeNames?: GeneralName[];
125
159
  };
126
160
  /**
127
161
  * Type definition for `AWS::ACMPCA::Certificate.GeneralName`.
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.
162
+ * Describes an ASN.1 X.400 ``GeneralName`` as defined in [RFC 5280](https://docs.aws.amazon.com/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.
129
163
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-generalname.html}
130
164
  */
131
165
  export type GeneralName = {
@@ -134,78 +168,131 @@ export type GeneralName = {
134
168
  */
135
169
  DirectoryName?: Subject;
136
170
  /**
137
- * String that contains X.509 DnsName information.
171
+ * Represents ``GeneralName`` as a DNS name.
138
172
  */
139
173
  DnsName?: string;
174
+ /**
175
+ * Represents ``GeneralName`` as an ``EdiPartyName`` object.
176
+ */
140
177
  EdiPartyName?: EdiPartyName;
141
178
  /**
142
- * String that contains X.509 IpAddress information.
179
+ * Represents ``GeneralName`` as an IPv4 or IPv6 address.
143
180
  */
144
181
  IpAddress?: string;
182
+ /**
183
+ * Represents ``GeneralName`` using an ``OtherName`` object.
184
+ */
145
185
  OtherName?: OtherName;
146
186
  /**
147
- * String that contains X.509 ObjectIdentifier information.
187
+ * Represents ``GeneralName`` as an object identifier (OID).
148
188
  */
149
189
  RegisteredId?: string;
150
190
  /**
151
- * String that contains X.509 Rfc822Name information.
191
+ * Represents ``GeneralName`` as an [RFC 822](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc822) email address.
152
192
  */
153
193
  Rfc822Name?: string;
154
194
  /**
155
- * String that contains X.509 UniformResourceIdentifier information.
195
+ * Represents ``GeneralName`` as a URI.
156
196
  */
157
197
  UniformResourceIdentifier?: string;
158
198
  };
159
199
  /**
160
200
  * Type definition for `AWS::ACMPCA::Certificate.KeyUsage`.
201
+ * Defines one or more purposes for which the key contained in the certificate can be used. Default value for each option is false.
161
202
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-keyusage.html}
162
203
  */
163
204
  export type KeyUsage = {
205
+ /**
206
+ * Key can be used to sign CRLs.
207
+ */
164
208
  CRLSign?: boolean;
209
+ /**
210
+ * Key can be used to decipher data.
211
+ */
165
212
  DataEncipherment?: boolean;
213
+ /**
214
+ * Key can be used only to decipher data.
215
+ */
166
216
  DecipherOnly?: boolean;
217
+ /**
218
+ * Key can be used for digital signing.
219
+ */
167
220
  DigitalSignature?: boolean;
221
+ /**
222
+ * Key can be used only to encipher data.
223
+ */
168
224
  EncipherOnly?: boolean;
225
+ /**
226
+ * Key can be used in a key-agreement protocol.
227
+ */
169
228
  KeyAgreement?: boolean;
229
+ /**
230
+ * Key can be used to sign certificates.
231
+ */
170
232
  KeyCertSign?: boolean;
233
+ /**
234
+ * Key can be used to encipher data.
235
+ */
171
236
  KeyEncipherment?: boolean;
237
+ /**
238
+ * Key can be used for non-repudiation.
239
+ */
172
240
  NonRepudiation?: boolean;
173
241
  };
174
242
  /**
175
243
  * Type definition for `AWS::ACMPCA::Certificate.OtherName`.
244
+ * 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://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
176
245
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-othername.html}
177
246
  */
178
247
  export type OtherName = {
179
248
  /**
180
- * String that contains X.509 ObjectIdentifier information.
249
+ * Specifies an OID.
181
250
  */
182
251
  TypeId: string;
252
+ /**
253
+ * Specifies an OID value.
254
+ */
183
255
  Value: string;
184
256
  };
185
257
  /**
186
258
  * Type definition for `AWS::ACMPCA::Certificate.PolicyInformation`.
259
+ * Defines the X.509 ``CertificatePolicies`` extension.
187
260
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyinformation.html}
188
261
  */
189
262
  export type PolicyInformation = {
190
263
  /**
191
- * String that contains X.509 ObjectIdentifier information.
264
+ * 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://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
192
265
  */
193
266
  CertPolicyId: string;
267
+ /**
268
+ * Modifies the given ``CertPolicyId`` with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.
269
+ */
194
270
  PolicyQualifiers?: PolicyQualifierInfo[];
195
271
  };
196
272
  /**
197
273
  * Type definition for `AWS::ACMPCA::Certificate.PolicyQualifierInfo`.
274
+ * Modifies the ``CertPolicyId`` of a ``PolicyInformation`` object with a qualifier. AWS Private CA supports the certification practice statement (CPS) qualifier.
198
275
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-policyqualifierinfo.html}
199
276
  */
200
277
  export type PolicyQualifierInfo = {
278
+ /**
279
+ * Identifies the qualifier modifying a ``CertPolicyId``.
280
+ */
201
281
  PolicyQualifierId: string;
282
+ /**
283
+ * Defines the qualifier type. AWS Private CA supports the use of a URI for a CPS qualifier in this field.
284
+ */
202
285
  Qualifier: Qualifier;
203
286
  };
204
287
  /**
205
288
  * Type definition for `AWS::ACMPCA::Certificate.Qualifier`.
289
+ * Defines a ``PolicyInformation`` qualifier. AWS Private CA supports the [certification practice statement (CPS) qualifier](https://docs.aws.amazon.com/https://datatracker.ietf.org/doc/html/rfc5280#section-4.2.1.4) defined in RFC 5280.
206
290
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-acmpca-certificate-qualifier.html}
207
291
  */
208
292
  export type Qualifier = {
293
+ /**
294
+ * Contains a pointer to a certification practice statement (CPS) published by the CA.
295
+ */
209
296
  CpsUri: string;
210
297
  };
211
298
  /**
@@ -224,8 +311,9 @@ export type Subject = {
224
311
  */
225
312
  Country?: string;
226
313
  /**
227
- * Array of X.500 attribute type and value. CustomAttributes cannot be used along with pre-defined attributes.
228
- */
314
+ * 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://docs.aws.amazon.com/https://csrc.nist.gov/glossary/term/Object_Identifier).
315
+ Custom attributes cannot be used in combination with standard attributes.
316
+ */
229
317
  CustomAttributes?: CustomAttribute[];
230
318
  /**
231
319
  * Disambiguating information for the certificate subject.
@@ -287,7 +375,7 @@ export type Validity = {
287
375
  */
288
376
  Type: string;
289
377
  /**
290
- * Time period.
378
+ * A long integer interpreted according to the value of ``Type``, below.
291
379
  */
292
380
  Value: number;
293
381
  };
@@ -26,7 +26,7 @@ export type DMSDataProviderProperties = {
26
26
  /**
27
27
  * The property describes a data engine for the data provider.
28
28
  */
29
- Engine: "postgresql" | "mysql" | "oracle" | "sqlserver" | "aurora" | "aurora_postgresql";
29
+ Engine: "postgres" | "mysql" | "oracle" | "sqlserver" | "aurora" | "aurora_postgresql";
30
30
  /**
31
31
  * The property describes the exact settings which can be modified
32
32
  */
@@ -1,25 +1,76 @@
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::EFS::FileSystem
4
+ * The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html}
6
6
  */
7
7
  export type EFSFileSystemProperties = {
8
+ /**
9
+ * For One Zone file systems, specify the AWS Availability Zone in which to create the file system. Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/availability-durability.html#file-system-type) in the *Amazon EFS User Guide*.
10
+ One Zone file systems are not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
11
+ */
8
12
  AvailabilityZoneName?: string;
13
+ /**
14
+ * Use the ``BackupPolicy`` to turn automatic backups on or off for the file system.
15
+ */
9
16
  BackupPolicy?: BackupPolicy;
10
17
  /**
11
- * Whether to bypass the FileSystemPolicy lockout safety check. The policy lockout safety check determines whether the policy in the request will prevent the principal making the request to be locked out from making future PutFileSystemPolicy requests on the file system. Set BypassPolicyLockoutSafetyCheck to True only when you intend to prevent the principal that is making the request from making a subsequent PutFileSystemPolicy request on the file system. Defaults to false
18
+ * (Optional) A boolean that specifies whether or not to bypass the ``FileSystemPolicy`` lockout safety check. The lockout safety check determines whether the policy in the request will lock out, or prevent, the IAM principal that is making the request from making future ``PutFileSystemPolicy`` requests on this file system. Set ``BypassPolicyLockoutSafetyCheck`` to ``True`` only when you intend to prevent the IAM principal that is making the request from making subsequent ``PutFileSystemPolicy`` requests on this file system. The default value is ``False``.
12
19
  */
13
20
  BypassPolicyLockoutSafetyCheck?: boolean;
21
+ /**
22
+ * A Boolean value that, if true, creates an encrypted file system. When creating an encrypted file system, you have the option of specifying a KmsKeyId for an existing kms-key-long. If you don't specify a kms-key, then the default kms-key for EFS, ``/aws/elasticfilesystem``, is used to protect the encrypted file system.
23
+ */
14
24
  Encrypted?: boolean;
25
+ /**
26
+ * The ``FileSystemPolicy`` for the EFS file system. A file system policy is an IAM resource policy used to control NFS access to an EFS file system. For more information, see [Using to control NFS access to Amazon EFS](https://docs.aws.amazon.com/efs/latest/ug/iam-access-control-nfs-efs.html) in the *Amazon EFS User Guide*.
27
+ */
15
28
  FileSystemPolicy?: Record<string, any>;
29
+ /**
30
+ * Describes the protection on the file system.
31
+ */
16
32
  FileSystemProtection?: FileSystemProtection;
33
+ /**
34
+ * Use to create one or more tags associated with the file system. Each tag is a user-defined key-value pair. Name your file system on creation by including a ``"Key":"Name","Value":"{value}"`` key-value pair. Each key must be unique. For more information, see [Tagging resources](https://docs.aws.amazon.com/general/latest/gr/aws_tagging.html) in the *General Reference Guide*.
35
+ */
17
36
  FileSystemTags?: ElasticFileSystemTag[];
37
+ /**
38
+ * The ID of the kms-key-long to be used to protect the encrypted file system. This parameter is only required if you want to use a nondefault kms-key. If this parameter is not specified, the default kms-key for EFS is used. This ID can be in one of the following formats:
39
+ + Key ID - A unique identifier of the key, for example ``1234abcd-12ab-34cd-56ef-1234567890ab``.
40
+ + ARN - An Amazon Resource Name (ARN) for the key, for example ``arn:aws:kms:us-west-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``.
41
+ + Key alias - A previously created display name for a key, for example ``alias/projectKey1``.
42
+ + Key alias ARN - An ARN for a key alias, for example ``arn:aws:kms:us-west-2:444455556666:alias/projectKey1``.
43
+
44
+ If ``KmsKeyId`` is specified, the ``Encrypted`` parameter must be set to true.
45
+ */
18
46
  KmsKeyId?: string;
47
+ /**
48
+ * An array of ``LifecyclePolicy`` objects that define the file system's ``LifecycleConfiguration`` object. A ``LifecycleConfiguration`` object informs Lifecycle management of the following:
49
+ + When to move files in the file system from primary storage to IA storage.
50
+ + When to move files in the file system from primary storage or IA storage to Archive storage.
51
+ + When to move files that are in IA or Archive storage to primary storage.
52
+
53
+ EFS requires that each ``LifecyclePolicy`` object have only a single transition. This means that in a request body, ``LifecyclePolicies`` needs to be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive`` ``TransitionToPrimaryStorageClass``. See the example requests in the following section for more information.
54
+ */
19
55
  LifecyclePolicies?: LifecyclePolicy[];
56
+ /**
57
+ * The Performance mode of the file system. We recommend ``generalPurpose`` performance mode for all file systems. File systems using the ``maxIO`` performance mode can scale to higher levels of aggregate throughput and operations per second with a tradeoff of slightly higher latencies for most file operations. The performance mode can't be changed after the file system has been created. The ``maxIO`` mode is not supported on One Zone file systems.
58
+ Due to the higher per-operation latencies with Max I/O, we recommend using General Purpose performance mode for all file systems.
59
+ Default is ``generalPurpose``.
60
+ */
20
61
  PerformanceMode?: string;
62
+ /**
63
+ * The throughput, measured in mebibytes per second (MiBps), that you want to provision for a file system that you're creating. Required if ``ThroughputMode`` is set to ``provisioned``. Valid values are 1-3414 MiBps, with the upper limit depending on Region. To increase this limit, contact SUP. For more information, see [Amazon EFS quotas that you can increase](https://docs.aws.amazon.com/efs/latest/ug/limits.html#soft-limits) in the *Amazon EFS User Guide*.
64
+ */
21
65
  ProvisionedThroughputInMibps?: number;
66
+ /**
67
+ * Describes the replication configuration for a specific file system.
68
+ */
22
69
  ReplicationConfiguration?: ReplicationConfiguration;
70
+ /**
71
+ * Specifies the throughput mode for the file system. The mode can be ``bursting``, ``provisioned``, or ``elastic``. If you set ``ThroughputMode`` to ``provisioned``, you must also set a value for ``ProvisionedThroughputInMibps``. After you create the file system, you can decrease your file system's Provisioned throughput or change between the throughput modes, with certain time restrictions. For more information, see [Specifying throughput with provisioned mode](https://docs.aws.amazon.com/efs/latest/ug/performance.html#provisioned-throughput) in the *Amazon EFS User Guide*.
72
+ Default is ``bursting``.
73
+ */
23
74
  ThroughputMode?: string;
24
75
  };
25
76
  /**
@@ -32,41 +83,77 @@ export type EFSFileSystemAttributes = {
32
83
  };
33
84
  /**
34
85
  * Type definition for `AWS::EFS::FileSystem.BackupPolicy`.
86
+ * The backup policy turns automatic backups for the file system on or off.
35
87
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-backuppolicy.html}
36
88
  */
37
89
  export type BackupPolicy = {
90
+ /**
91
+ * Set the backup policy status for the file system.
92
+ + *ENABLED* - Turns automatic backups on for the file system.
93
+ + *DISABLED* - Turns automatic backups off for the file system.
94
+ */
38
95
  Status: string;
39
96
  };
40
97
  /**
41
98
  * Type definition for `AWS::EFS::FileSystem.ElasticFileSystemTag`.
99
+ * A tag is a key-value pair attached to a file system. Allowed characters in the ``Key`` and ``Value`` properties are letters, white space, and numbers that can be represented in UTF-8, and the following characters:``+ - = . _ : /``
42
100
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-elasticfilesystemtag.html}
43
101
  */
44
102
  export type ElasticFileSystemTag = {
103
+ /**
104
+ * The tag key (String). The key can't start with ``aws:``.
105
+ */
45
106
  Key: string;
107
+ /**
108
+ * The value of the tag key.
109
+ */
46
110
  Value: string;
47
111
  };
48
112
  /**
49
113
  * Type definition for `AWS::EFS::FileSystem.FileSystemProtection`.
114
+ * Describes the protection on the file system.
50
115
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-filesystemprotection.html}
51
116
  */
52
117
  export type FileSystemProtection = {
118
+ /**
119
+ * The status of the file system's replication overwrite protection.
120
+ + ``ENABLED`` – The file system cannot be used as the destination file system in a replication configuration. The file system is writeable. Replication overwrite protection is ``ENABLED`` by default.
121
+ + ``DISABLED`` – The file system can be used as the destination file system in a replication configuration. The file system is read-only and can only be modified by EFS replication.
122
+ + ``REPLICATING`` – The file system is being used as the destination file system in a replication configuration. The file system is read-only and is only modified only by EFS replication.
123
+
124
+ If the replication configuration is deleted, the file system's replication overwrite protection is re-enabled, the file system becomes writeable.
125
+ */
53
126
  ReplicationOverwriteProtection?: "DISABLED" | "ENABLED";
54
127
  };
55
128
  /**
56
129
  * Type definition for `AWS::EFS::FileSystem.LifecyclePolicy`.
130
+ * Describes a policy used by Lifecycle management that specifies when to transition files into and out of the EFS storage classes. For more information, see [Managing file system storage](https://docs.aws.amazon.com/efs/latest/ug/lifecycle-management-efs.html).
131
+ + Each ``LifecyclePolicy`` object can have only a single transition. This means that in a request body, ``LifecyclePolicies`` must be structured as an array of ``LifecyclePolicy`` objects, one object for each transition, ``TransitionToIA``, ``TransitionToArchive``, ``TransitionToPrimaryStorageClass``.
132
+ + See the AWS::EFS::FileSystem examples for the correct ``LifecyclePolicy`` structure. Do not use the syntax shown on this page.
57
133
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-lifecyclepolicy.html}
58
134
  */
59
135
  export type LifecyclePolicy = {
136
+ /**
137
+ * The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
138
+ */
60
139
  TransitionToArchive?: string;
140
+ /**
141
+ * The number of days after files were last accessed in primary storage (the Standard storage class) at which to move them to Infrequent Access (IA) storage. Metadata operations such as listing the contents of a directory don't count as file access events.
142
+ */
61
143
  TransitionToIA?: string;
144
+ /**
145
+ * Whether to move files back to primary (Standard) storage after they are accessed in IA or Archive storage. Metadata operations such as listing the contents of a directory don't count as file access events.
146
+ */
62
147
  TransitionToPrimaryStorageClass?: string;
63
148
  };
64
149
  /**
65
150
  * Type definition for `AWS::EFS::FileSystem.ReplicationConfiguration`.
151
+ * Describes the replication configuration for a specific file system.
66
152
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationconfiguration.html}
67
153
  */
68
154
  export type ReplicationConfiguration = {
69
155
  /**
156
+ * An array of destination objects. Only one destination object is supported.
70
157
  * @minLength `1`
71
158
  * @maxLength `1`
72
159
  */
@@ -74,16 +161,32 @@ export type ReplicationConfiguration = {
74
161
  };
75
162
  /**
76
163
  * Type definition for `AWS::EFS::FileSystem.ReplicationDestination`.
164
+ * Describes the destination file system in the replication configuration.
77
165
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-efs-filesystem-replicationdestination.html}
78
166
  */
79
167
  export type ReplicationDestination = {
168
+ /**
169
+ * The AWS For One Zone file systems, the replication configuration must specify the Availability Zone in which the destination file system is located.
170
+ Use the format ``us-east-1a`` to specify the Availability Zone. For more information about One Zone file systems, see [EFS file system types](https://docs.aws.amazon.com/efs/latest/ug/storage-classes.html) in the *Amazon EFS User Guide*.
171
+ One Zone file system type is not available in all Availability Zones in AWS-Regions where Amazon EFS is available.
172
+ */
80
173
  AvailabilityZoneName?: string;
174
+ /**
175
+ * The ID of the destination Amazon EFS file system.
176
+ */
81
177
  FileSystemId?: string;
178
+ /**
179
+ * The ID of an kms-key-long used to protect the encrypted file system.
180
+ */
82
181
  KmsKeyId?: string;
182
+ /**
183
+ * The AWS-Region in which the destination file system is located.
184
+ For One Zone file systems, the replication configuration must specify the AWS-Region in which the destination file system is located.
185
+ */
83
186
  Region?: string;
84
187
  };
85
188
  /**
86
- * Resource Type definition for AWS::EFS::FileSystem
189
+ * The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
87
190
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html}
88
191
  */
89
192
  export declare class EFSFileSystem extends $Resource<"AWS::EFS::FileSystem", EFSFileSystemProperties, EFSFileSystemAttributes> {
@@ -1,6 +1,6 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::EFS::FileSystem
3
+ * The ``AWS::EFS::FileSystem`` resource creates a new, empty file system in EFSlong (EFS). You must create a mount target ([AWS::EFS::MountTarget](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-mounttarget.html)) to mount your EFS file system on an EC2 or other AWS cloud compute resource.
4
4
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-efs-filesystem.html}
5
5
  */
6
6
  export class EFSFileSystem extends $Resource {
@@ -5,24 +5,18 @@ import type { ResourceOptions as $ResourceOptions } from "@awboost/cfn-template-
5
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html}
6
6
  */
7
7
  export type GuardDutyMemberProperties = {
8
- DetectorId: string;
8
+ DetectorId?: string;
9
9
  DisableEmailNotification?: boolean;
10
10
  Email: string;
11
+ MemberId?: string;
11
12
  Message?: string;
12
13
  Status?: string;
13
14
  };
14
- /**
15
- * Attribute type definition for `AWS::GuardDuty::Member`.
16
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html#aws-resource-guardduty-member-return-values}
17
- */
18
- export type GuardDutyMemberAttributes = {
19
- MemberId: string;
20
- };
21
15
  /**
22
16
  * Resource Type definition for AWS::GuardDuty::Member
23
17
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-member.html}
24
18
  */
25
- export declare class GuardDutyMember extends $Resource<"AWS::GuardDuty::Member", GuardDutyMemberProperties, GuardDutyMemberAttributes> {
19
+ export declare class GuardDutyMember extends $Resource<"AWS::GuardDuty::Member", GuardDutyMemberProperties, Record<string, never>> {
26
20
  static readonly Type = "AWS::GuardDuty::Member";
27
21
  constructor(logicalId: string, properties: GuardDutyMemberProperties, options?: $ResourceOptions);
28
22
  }
@@ -73,33 +73,6 @@ export type Condition = {
73
73
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-loggingconfiguration-fieldtomatch.html}
74
74
  */
75
75
  export type FieldToMatch = {
76
- /**
77
- * Inspect the request body as JSON. The request body immediately follows the request headers. This is the part of a request that contains any additional data that you want to send to your web server as the HTTP request body, such as data from a form.
78
- */
79
- JsonBody?: {
80
- /**
81
- * What AWS WAF should do if it fails to completely parse the JSON body.
82
- */
83
- InvalidFallbackBehavior?: "MATCH" | "NO_MATCH" | "EVALUATE_AS_STRING";
84
- /**
85
- * The patterns to look for in the JSON body. AWS WAF inspects the results of these pattern matches against the rule inspection criteria.
86
- */
87
- MatchPattern: {
88
- /**
89
- * Match all of the elements. See also MatchScope in JsonBody. You must specify either this setting or the IncludedPaths setting, but not both.
90
- */
91
- All?: Record<string, any>;
92
- /**
93
- * Match only the specified include paths. See also MatchScope in JsonBody.
94
- * @minLength `1`
95
- */
96
- IncludedPaths?: string[];
97
- };
98
- /**
99
- * The parts of the JSON to match against using the MatchPattern. If you specify All, AWS WAF matches against keys and values.
100
- */
101
- MatchScope: "ALL" | "KEY" | "VALUE";
102
- };
103
76
  /**
104
77
  * Inspect the HTTP method. The method indicates the type of operation that the request is asking the origin to perform.
105
78
  */
@@ -568,7 +568,7 @@ export type PositionalConstraint = "EXACTLY" | "STARTS_WITH" | "ENDS_WITH" | "CO
568
568
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-wafv2-rulegroup-ratebasedstatement.html}
569
569
  */
570
570
  export type RateBasedStatement = {
571
- AggregateKeyType: "CONSTANT" | "IP" | "FORWARDED_IP" | "CUSTOM_KEYS";
571
+ AggregateKeyType: "IP" | "FORWARDED_IP" | "CONSTANT" | "CUSTOM_KEYS";
572
572
  /**
573
573
  * Specifies the aggregate keys to use in a rate-base rule.
574
574
  * @maxLength `5`
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@awboost/cfn-resource-types",
3
- "version": "0.1.23",
3
+ "version": "0.1.25",
4
4
  "publishConfig": {
5
5
  "access": "public"
6
6
  },