@awboost/cfn-resource-types 0.1.22 → 0.1.24

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.
Files changed (35) hide show
  1. package/lib/AWS-ACMPCA-Certificate.d.ts +106 -18
  2. package/lib/AWS-AppSync-ApiCache.d.ts +1 -0
  3. package/lib/AWS-AppSync-DataSource.d.ts +1 -0
  4. package/lib/AWS-AppSync-GraphQLApi.d.ts +10 -0
  5. package/lib/AWS-AppSync-Resolver.d.ts +1 -0
  6. package/lib/AWS-Batch-JobDefinition.d.ts +8 -0
  7. package/lib/AWS-ControlTower-EnabledBaseline.d.ts +80 -0
  8. package/lib/AWS-ControlTower-EnabledBaseline.js +12 -0
  9. package/lib/AWS-DMS-DataProvider.d.ts +1 -1
  10. package/lib/AWS-DynamoDB-Table.d.ts +9 -0
  11. package/lib/AWS-EC2-InstanceConnectEndpoint.d.ts +1 -1
  12. package/lib/AWS-EC2-NatGateway.d.ts +46 -4
  13. package/lib/AWS-EC2-NatGateway.js +5 -1
  14. package/lib/AWS-EC2-VPC.d.ts +30 -31
  15. package/lib/AWS-EC2-VPC.js +4 -1
  16. package/lib/AWS-ECS-TaskDefinition.d.ts +641 -25
  17. package/lib/AWS-ECS-TaskDefinition.js +3 -1
  18. package/lib/AWS-EFS-FileSystem.d.ts +106 -3
  19. package/lib/AWS-EFS-FileSystem.js +1 -1
  20. package/lib/AWS-EMR-Cluster.d.ts +1 -0
  21. package/lib/AWS-GuardDuty-Master.d.ts +14 -9
  22. package/lib/AWS-GuardDuty-Master.js +2 -1
  23. package/lib/AWS-IAM-User.d.ts +43 -25
  24. package/lib/AWS-IAM-User.js +3 -1
  25. package/lib/AWS-IoTWireless-WirelessDevice.d.ts +34 -0
  26. package/lib/AWS-KMS-Alias.d.ts +25 -11
  27. package/lib/AWS-KMS-Alias.js +3 -1
  28. package/lib/AWS-KMS-Key.d.ts +62 -28
  29. package/lib/AWS-KMS-Key.js +3 -1
  30. package/lib/AWS-S3-Bucket.d.ts +381 -139
  31. package/lib/AWS-S3-Bucket.js +3 -1
  32. package/lib/AWS-SageMaker-AppImageConfig.d.ts +1 -1
  33. package/lib/AWS-WAFv2-LoggingConfiguration.d.ts +0 -27
  34. package/lib/AWS-WAFv2-RuleGroup.d.ts +1 -1
  35. package/package.json +1 -1
@@ -1,7 +1,9 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
3
  * Resource type definition for `AWS::ECS::TaskDefinition`.
4
- * Resource Schema describing various properties for ECS TaskDefinition
4
+ * Registers a new task definition from the supplied ``family`` and ``containerDefinitions``. Optionally, you can add data volumes to your containers with the ``volumes`` parameter. For more information about task definition parameters and defaults, see [Amazon ECS Task Definitions](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task_defintions.html) in the *Amazon Elastic Container Service Developer Guide*.
5
+ You can specify a role for your task with the ``taskRoleArn`` parameter. When you specify a role for a task, its containers can then use the latest versions of the CLI or SDKs to make API requests to the AWS services that are specified in the policy that's associated with the role. For more information, see [IAM Roles for Tasks](https://docs.aws.amazon.com/AmazonECS/latest/developerguide/task-iam-roles.html) in the *Amazon Elastic Container Service Developer Guide*.
6
+ You can specify a Docker networking mode for the containers in your task definition with the ``networkMod
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-ecs-taskdefinition.html}
6
8
  */
7
9
  export class ECSTaskDefinition extends $Resource {
@@ -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 {
@@ -205,6 +205,7 @@ export type JobFlowInstancesConfig = {
205
205
  TaskInstanceFleets?: InstanceFleetConfig[];
206
206
  TaskInstanceGroups?: InstanceGroupConfig[];
207
207
  TerminationProtected?: boolean;
208
+ UnhealthyNodeReplacement?: boolean;
208
209
  };
209
210
  /**
210
211
  * Type definition for `AWS::EMR::Cluster.KerberosAttributes`.
@@ -1,25 +1,30 @@
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::GuardDuty::Master
4
+ * Resource type definition for `AWS::GuardDuty::Master`.
5
+ * GuardDuty Master resource schema
5
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html}
6
7
  */
7
8
  export type GuardDutyMasterProperties = {
9
+ /**
10
+ * Unique ID of the detector of the GuardDuty member account.
11
+ */
8
12
  DetectorId: string;
13
+ /**
14
+ * Value used to validate the master account to the member account.
15
+ */
9
16
  InvitationId?: string;
10
- };
11
- /**
12
- * Attribute type definition for `AWS::GuardDuty::Master`.
13
- * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html#aws-resource-guardduty-master-return-values}
14
- */
15
- export type GuardDutyMasterAttributes = {
17
+ /**
18
+ * ID of the account used as the master account.
19
+ */
16
20
  MasterId: string;
17
21
  };
18
22
  /**
19
- * Resource Type definition for AWS::GuardDuty::Master
23
+ * Resource type definition for `AWS::GuardDuty::Master`.
24
+ * GuardDuty Master resource schema
20
25
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html}
21
26
  */
22
- export declare class GuardDutyMaster extends $Resource<"AWS::GuardDuty::Master", GuardDutyMasterProperties, GuardDutyMasterAttributes> {
27
+ export declare class GuardDutyMaster extends $Resource<"AWS::GuardDuty::Master", GuardDutyMasterProperties, Record<string, never>> {
23
28
  static readonly Type = "AWS::GuardDuty::Master";
24
29
  constructor(logicalId: string, properties: GuardDutyMasterProperties, options?: $ResourceOptions);
25
30
  }
@@ -1,6 +1,7 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::GuardDuty::Master
3
+ * Resource type definition for `AWS::GuardDuty::Master`.
4
+ * GuardDuty Master resource schema
4
5
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-guardduty-master.html}
5
6
  */
6
7
  export class GuardDutyMaster extends $Resource {
@@ -1,7 +1,9 @@
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::IAM::User
4
+ * Resource type definition for `AWS::IAM::User`.
5
+ * Creates a new IAM user for your AWS-account.
6
+ For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html}
6
8
  */
7
9
  export type IAMUserProperties = {
@@ -10,32 +12,46 @@ export type IAMUserProperties = {
10
12
  */
11
13
  Groups?: string[];
12
14
  /**
13
- * Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the AWS Management Console.
14
- */
15
+ * Creates a password for the specified IAM user. A password allows an IAM user to access AWS services through the console.
16
+ You can use the CLI, the AWS API, or the *Users* page in the IAM console to create a password for any IAM user. Use [ChangePassword](https://docs.aws.amazon.com/IAM/latest/APIReference/API_ChangePassword.html) to update your own existing password in the *My Security Credentials* page in the console.
17
+ For more information about managing passwords, see [Managing passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
18
+ */
15
19
  LoginProfile?: LoginProfile;
16
20
  /**
17
- * A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the role.
18
- */
21
+ * A list of Amazon Resource Names (ARNs) of the IAM managed policies that you want to attach to the user.
22
+ For more information about ARNs, see [Amazon Resource Names (ARNs) and Service Namespaces](https://docs.aws.amazon.com/general/latest/gr/aws-arns-and-namespaces.html) in the *General Reference*.
23
+ */
19
24
  ManagedPolicyArns?: string[];
20
25
  /**
21
- * The path to the user. For more information about paths, see IAM identifiers in the IAM User Guide. The ARN of the policy used to set the permissions boundary for the user.
22
- */
26
+ * The path for the user name. For more information about paths, see [IAM identifiers](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_Identifiers.html) in the *IAM User Guide*.
27
+ This parameter is optional. If it is not included, it defaults to a slash (/).
28
+ This parameter allows (through its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of either a forward slash (/) by itself or a string that must begin and end with forward slashes. In addition, it can contain any ASCII character from the ! (``\u0021``) through the DEL character (``\u007F``), including most punctuation characters, digits, and upper and lowercased letters.
29
+ */
23
30
  Path?: string;
24
31
  /**
25
- * The ARN of the policy that is used to set the permissions boundary for the user.
26
- */
32
+ * The ARN of the managed policy that is used to set the permissions boundary for the user.
33
+ A permissions boundary policy defines the maximum permissions that identity-based policies can grant to an entity, but does not grant permissions. Permissions boundaries do not define the maximum permissions that a resource-based policy can grant to an entity. To learn more, see [Permissions boundaries for IAM entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html) in the *IAM User Guide*.
34
+ For more information about policy types, see [Policy types](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policy-types) in the *IAM User Guide*.
35
+ */
27
36
  PermissionsBoundary?: string;
28
37
  /**
29
- * Adds or updates an inline policy document that is embedded in the specified IAM role.
30
- */
38
+ * Adds or updates an inline policy document that is embedded in the specified IAM user. To view AWS::IAM::User snippets, see [Declaring an User Resource](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/quickref-iam.html#scenario-iam-user).
39
+ The name of each policy for a role, user, or group must be unique. If you don't choose unique names, updates to the IAM identity will fail.
40
+ For information about limits on the number of inline policies that you can embed in a user, see [Limitations on Entities](https://docs.aws.amazon.com/IAM/latest/UserGuide/LimitationsOnEntities.html) in the *User Guide*.
41
+ */
31
42
  Policies?: Policy[];
32
43
  /**
33
- * A list of tags that are associated with the user. For more information about tagging, see Tagging IAM resources in the IAM User Guide.
34
- */
44
+ * A list of tags that you want to attach to the new user. Each tag consists of a key name and an associated value. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
45
+ If any one of the tags is invalid or if you exceed the allowed maximum number of tags, then the entire request fails and the resource is not created.
46
+ */
35
47
  Tags?: Tag[];
36
48
  /**
37
- * The friendly name identifying the user.
38
- */
49
+ * The name of the user to create. Do not include the path in this value.
50
+ This parameter allows (per its [regex pattern](https://docs.aws.amazon.com/http://wikipedia.org/wiki/regex)) a string of characters consisting of upper and lowercase alphanumeric characters with no spaces. You can also include any of the following characters: _+=,.@-. The user name must be unique within the account. User names are not distinguished by case. For example, you cannot create users named both "John" and "john".
51
+ If you don't specify a name, CFN generates a unique physical ID and uses that ID for the user name.
52
+ If you specify a name, you must specify the ``CAPABILITY_NAMED_IAM`` value to acknowledge your template's capabilities. For more information, see [Acknowledging Resources in Templates](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-iam-template.html#using-iam-capabilities).
53
+ Naming an IAM resource can cause an unrecoverable error if you reuse the same template in multiple Regions. To prevent this, we recommend using ``Fn::Join`` and ``AWS::Region`` to create a Region-specific name, as in the following example: ``{"Fn::Join": ["", [{"Ref": "AWS::Region"}, {"Ref": "MyResourceName"}]]}``.
54
+ */
39
55
  UserName?: string;
40
56
  };
41
57
  /**
@@ -43,14 +59,11 @@ export type IAMUserProperties = {
43
59
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html#aws-resource-iam-user-return-values}
44
60
  */
45
61
  export type IAMUserAttributes = {
46
- /**
47
- * The Amazon Resource Name (ARN) that identifies the user. For more information about ARNs and how to use ARNs in policies, see IAM Identifiers in the IAM User Guide.
48
- */
49
62
  Arn: string;
50
63
  };
51
64
  /**
52
65
  * Type definition for `AWS::IAM::User.LoginProfile`.
53
- * Contains the user name and password create date for a user.
66
+ * Creates a password for the specified user, giving the user the ability to access AWS services through the console. For more information about managing passwords, see [Managing Passwords](https://docs.aws.amazon.com/IAM/latest/UserGuide/Using_ManagingLogins.html) in the *User Guide*.
54
67
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-loginprofile.html}
55
68
  */
56
69
  export type LoginProfile = {
@@ -66,11 +79,13 @@ export type LoginProfile = {
66
79
  /**
67
80
  * Type definition for `AWS::IAM::User.Policy`.
68
81
  * Contains information about an attached policy.
82
+ An attached policy is a managed policy that has been attached to a user, group, or role.
83
+ For more information about managed policies, refer to [Managed Policies and Inline Policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/policies-managed-vs-inline.html) in the *User Guide*.
69
84
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-policy.html}
70
85
  */
71
86
  export type Policy = {
72
87
  /**
73
- * The policy document.
88
+ * The entire contents of the policy that defines permissions. For more information, see [Overview of JSON policies](https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies.html#access_policies-json).
74
89
  */
75
90
  PolicyDocument: Record<string, any> | string;
76
91
  /**
@@ -80,21 +95,24 @@ export type Policy = {
80
95
  };
81
96
  /**
82
97
  * Type definition for `AWS::IAM::User.Tag`.
83
- * A key-value pair to associate with a resource.
98
+ * A structure that represents user-provided metadata that can be associated with an IAM resource. For more information about tagging, see [Tagging IAM resources](https://docs.aws.amazon.com/IAM/latest/UserGuide/id_tags.html) in the *IAM User Guide*.
84
99
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iam-user-tag.html}
85
100
  */
86
101
  export type Tag = {
87
102
  /**
88
- * The key name of the tag. You can specify a value that is 1 to 128 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
103
+ * The key name that can be used to look up or retrieve the associated value. For example, ``Department`` or ``Cost Center`` are common choices.
89
104
  */
90
105
  Key: string;
91
106
  /**
92
- * The value for the tag. You can specify a value that is 0 to 256 Unicode characters in length and cannot be prefixed with aws:. You can use any of the following characters: the set of Unicode letters, digits, whitespace, _, ., /, =, +, and -.
93
- */
107
+ * The value associated with this tag. For example, tags with a key name of ``Department`` could have values such as ``Human Resources``, ``Accounting``, and ``Support``. Tags with a key name of ``Cost Center`` might have values that consist of the number associated with the different cost centers in your company. Typically, many resources have tags with the same key name but with different values.
108
+ AWS always interprets the tag ``Value`` as a single string. If you need to store an array, you can store comma-separated values in the string. However, you must interpret the value in your code.
109
+ */
94
110
  Value: string;
95
111
  };
96
112
  /**
97
- * Resource Type definition for AWS::IAM::User
113
+ * Resource type definition for `AWS::IAM::User`.
114
+ * Creates a new IAM user for your AWS-account.
115
+ For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
98
116
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html}
99
117
  */
100
118
  export declare class IAMUser extends $Resource<"AWS::IAM::User", IAMUserProperties, IAMUserAttributes> {
@@ -1,6 +1,8 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * Resource Type definition for AWS::IAM::User
3
+ * Resource type definition for `AWS::IAM::User`.
4
+ * Creates a new IAM user for your AWS-account.
5
+ For information about quotas for the number of IAM users you can create, see [IAM and quotas](https://docs.aws.amazon.com/IAM/latest/UserGuide/reference_iam-quotas.html) in the *IAM User Guide*.
4
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-iam-user.html}
5
7
  */
6
8
  export class IAMUser extends $Resource {
@@ -84,6 +84,39 @@ export type AbpV11 = {
84
84
  DevAddr: string;
85
85
  SessionKeys: SessionKeysAbpV11;
86
86
  };
87
+ /**
88
+ * Type definition for `AWS::IoTWireless::WirelessDevice.Application`.
89
+ * LoRaWAN application configuration, which can be used to perform geolocation.
90
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-application.html}
91
+ */
92
+ export type Application = {
93
+ /**
94
+ * The name of the position data destination that describes the AWS IoT rule that processes the device's position data for use by AWS IoT Core for LoRaWAN.
95
+ * @maxLength `128`
96
+ * @pattern `[a-zA-Z0-9-_]+`
97
+ */
98
+ DestinationName?: string;
99
+ /**
100
+ * The Fport value.
101
+ * @min `1`
102
+ * @max `223`
103
+ */
104
+ FPort?: number;
105
+ /**
106
+ * Application type, which can be specified to obtain real-time position information of your LoRaWAN device.
107
+ */
108
+ Type?: "SemtechGeolocation";
109
+ };
110
+ /**
111
+ * Type definition for `AWS::IoTWireless::WirelessDevice.FPorts`.
112
+ * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-fports.html}
113
+ */
114
+ export type FPorts = {
115
+ /**
116
+ * A list of optional LoRaWAN application information, which can be used for geolocation.
117
+ */
118
+ Applications?: Application[];
119
+ };
87
120
  /**
88
121
  * Type definition for `AWS::IoTWireless::WirelessDevice.LoRaWANDevice`.
89
122
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-iotwireless-wirelessdevice-lorawandevice.html}
@@ -99,6 +132,7 @@ export type LoRaWANDevice = {
99
132
  * @maxLength `256`
100
133
  */
101
134
  DeviceProfileId?: string;
135
+ FPorts?: FPorts;
102
136
  OtaaV10x?: OtaaV10x;
103
137
  OtaaV11?: OtaaV11;
104
138
  /**
@@ -1,26 +1,40 @@
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::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.
4
+ * The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).
5
+ Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
6
+ Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i
5
7
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html}
6
8
  */
7
9
  export type KMSAliasProperties = {
8
10
  /**
9
- * Specifies the alias name. This value must begin with alias/ followed by a name, such as alias/ExampleAlias. The alias name cannot begin with alias/aws/. The alias/aws/ prefix is reserved for AWS managed keys.
10
- * @minLength `1`
11
- * @maxLength `256`
12
- * @pattern `^(alias/)[a-zA-Z0-9:/_-]+$`
13
- */
11
+ * Specifies the alias name. This value must begin with ``alias/`` followed by a name, such as ``alias/ExampleAlias``.
12
+ If you change the value of the ``AliasName`` property, the existing alias is deleted and a new alias is created for the specified KMS key. This change can disrupt applications that use the alias. It can also allow or deny access to a KMS key affected by attribute-based access control (ABAC).
13
+ The alias must be string of 1-256 characters. It can contain only alphanumeric characters, forward slashes (/), underscores (_), and dashes (-). The alias name cannot begin with ``alias/aws/``. The ``alias/aws/`` prefix is reserved for [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#aws-managed-cmk).
14
+ * @minLength `1`
15
+ * @maxLength `256`
16
+ * @pattern `^(alias/)[a-zA-Z0-9:/_-]+$`
17
+ */
14
18
  AliasName: string;
15
19
  /**
16
- * Identifies the AWS KMS key to which the alias refers. Specify the key ID or the Amazon Resource Name (ARN) of the AWS KMS key. You cannot specify another alias. For help finding the key ID and ARN, see Finding the Key ID and ARN in the AWS Key Management Service Developer Guide.
17
- * @minLength `1`
18
- * @maxLength `256`
19
- */
20
+ * Associates the alias with the specified [](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#customer-cmk). The KMS key must be in the same AWS-account and Region.
21
+ A valid key ID is required. If you supply a null or empty string value, this operation returns an error.
22
+ For help finding the key ID and ARN, see [Finding the key ID and ARN](https://docs.aws.amazon.com/kms/latest/developerguide/viewing-keys.html#find-cmk-id-arn) in the *Developer Guide*.
23
+ Specify the key ID or the key ARN of the KMS key.
24
+ For example:
25
+ + Key ID: ``1234abcd-12ab-34cd-56ef-1234567890ab``
26
+ + Key ARN: ``arn:aws:kms:us-east-2:111122223333:key/1234abcd-12ab-34cd-56ef-1234567890ab``
27
+
28
+ To get the key ID and key ARN for a KMS key, use [ListKeys](https://docs.aws.amazon.com/kms/latest/APIReference/API_ListKeys.html) or [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html).
29
+ * @minLength `1`
30
+ * @maxLength `256`
31
+ */
20
32
  TargetKeyId: string;
21
33
  };
22
34
  /**
23
- * The AWS::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.
35
+ * The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).
36
+ Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
37
+ Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i
24
38
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html}
25
39
  */
26
40
  export declare class KMSAlias extends $Resource<"AWS::KMS::Alias", KMSAliasProperties, Record<string, never>> {
@@ -1,6 +1,8 @@
1
1
  import { Resource as $Resource } from "@awboost/cfn-template-builder/template/resource";
2
2
  /**
3
- * The AWS::KMS::Alias resource specifies a display name for an AWS KMS key in AWS Key Management Service (AWS KMS). You can use an alias to identify an AWS KMS key in cryptographic operations.
3
+ * The ``AWS::KMS::Alias`` resource specifies a display name for a [KMS key](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#kms_keys). You can use an alias to identify a KMS key in the KMS console, in the [DescribeKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_DescribeKey.html) operation, and in [cryptographic operations](https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#cryptographic-operations), such as [Decrypt](https://docs.aws.amazon.com/kms/latest/APIReference/API_Decrypt.html) and [GenerateDataKey](https://docs.aws.amazon.com/kms/latest/APIReference/API_GenerateDataKey.html).
4
+ Adding, deleting, or updating an alias can allow or deny permission to the KMS key. For details, see [ABAC for](https://docs.aws.amazon.com/kms/latest/developerguide/abac.html) in the *Developer Guide*.
5
+ Using an alias to refer to a KMS key can help you simplify key management. For example, an alias in your code can be associated with different KMS keys i
4
6
  * @see {@link https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-kms-alias.html}
5
7
  */
6
8
  export class KMSAlias extends $Resource {