@aws-cdk/asset-awscli-v2 0.0.0

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.
package/API.md ADDED
@@ -0,0 +1,301 @@
1
+ # API Reference <a name="API Reference" id="api-reference"></a>
2
+
3
+ ## Constructs <a name="Constructs" id="Constructs"></a>
4
+
5
+ ### AwsCliAsset <a name="AwsCliAsset" id="@aws-cdk/asset-awscli-v2.AwsCliAsset"></a>
6
+
7
+ A CDK Asset construct that contains the AWS CLI.
8
+
9
+ #### Initializers <a name="Initializers" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer"></a>
10
+
11
+ ```typescript
12
+ import { AwsCliAsset } from '@aws-cdk/asset-awscli-v2'
13
+
14
+ new AwsCliAsset(scope: Construct, id: string, options?: AssetOptions)
15
+ ```
16
+
17
+ | **Name** | **Type** | **Description** |
18
+ | --- | --- | --- |
19
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.scope">scope</a></code> | <code>constructs.Construct</code> | *No description.* |
20
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |
21
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.options">options</a></code> | <code>aws-cdk-lib.aws_s3_assets.AssetOptions</code> | *No description.* |
22
+
23
+ ---
24
+
25
+ ##### `scope`<sup>Required</sup> <a name="scope" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.scope"></a>
26
+
27
+ - *Type:* constructs.Construct
28
+
29
+ ---
30
+
31
+ ##### `id`<sup>Required</sup> <a name="id" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.id"></a>
32
+
33
+ - *Type:* string
34
+
35
+ ---
36
+
37
+ ##### `options`<sup>Optional</sup> <a name="options" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.Initializer.parameter.options"></a>
38
+
39
+ - *Type:* aws-cdk-lib.aws_s3_assets.AssetOptions
40
+
41
+ ---
42
+
43
+ #### Methods <a name="Methods" id="Methods"></a>
44
+
45
+ | **Name** | **Description** |
46
+ | --- | --- |
47
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.toString">toString</a></code> | Returns a string representation of this construct. |
48
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.addResourceMetadata">addResourceMetadata</a></code> | Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset. |
49
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.grantRead">grantRead</a></code> | Grants read permissions to the principal on the assets bucket. |
50
+
51
+ ---
52
+
53
+ ##### `toString` <a name="toString" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.toString"></a>
54
+
55
+ ```typescript
56
+ public toString(): string
57
+ ```
58
+
59
+ Returns a string representation of this construct.
60
+
61
+ ##### `addResourceMetadata` <a name="addResourceMetadata" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.addResourceMetadata"></a>
62
+
63
+ ```typescript
64
+ public addResourceMetadata(resource: CfnResource, resourceProperty: string): void
65
+ ```
66
+
67
+ Adds CloudFormation template metadata to the specified resource with information that indicates which resource property is mapped to this local asset.
68
+
69
+ This can be used by tools such as SAM CLI to provide local
70
+ experience such as local invocation and debugging of Lambda functions.
71
+
72
+ Asset metadata will only be included if the stack is synthesized with the
73
+ "aws:cdk:enable-asset-metadata" context key defined, which is the default
74
+ behavior when synthesizing via the CDK Toolkit.
75
+
76
+ > [https://github.com/aws/aws-cdk/issues/1432](https://github.com/aws/aws-cdk/issues/1432)
77
+
78
+ ###### `resource`<sup>Required</sup> <a name="resource" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.addResourceMetadata.parameter.resource"></a>
79
+
80
+ - *Type:* aws-cdk-lib.CfnResource
81
+
82
+ The CloudFormation resource which is using this asset [disable-awslint:ref-via-interface].
83
+
84
+ ---
85
+
86
+ ###### `resourceProperty`<sup>Required</sup> <a name="resourceProperty" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.addResourceMetadata.parameter.resourceProperty"></a>
87
+
88
+ - *Type:* string
89
+
90
+ The property name where this asset is referenced (e.g. "Code" for AWS::Lambda::Function).
91
+
92
+ ---
93
+
94
+ ##### `grantRead` <a name="grantRead" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.grantRead"></a>
95
+
96
+ ```typescript
97
+ public grantRead(grantee: IGrantable): void
98
+ ```
99
+
100
+ Grants read permissions to the principal on the assets bucket.
101
+
102
+ ###### `grantee`<sup>Required</sup> <a name="grantee" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.grantRead.parameter.grantee"></a>
103
+
104
+ - *Type:* aws-cdk-lib.aws_iam.IGrantable
105
+
106
+ ---
107
+
108
+ #### Static Functions <a name="Static Functions" id="Static Functions"></a>
109
+
110
+ | **Name** | **Description** |
111
+ | --- | --- |
112
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.isConstruct">isConstruct</a></code> | Checks if `x` is a construct. |
113
+
114
+ ---
115
+
116
+ ##### ~~`isConstruct`~~ <a name="isConstruct" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.isConstruct"></a>
117
+
118
+ ```typescript
119
+ import { AwsCliAsset } from '@aws-cdk/asset-awscli-v2'
120
+
121
+ AwsCliAsset.isConstruct(x: any)
122
+ ```
123
+
124
+ Checks if `x` is a construct.
125
+
126
+ ###### `x`<sup>Required</sup> <a name="x" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.isConstruct.parameter.x"></a>
127
+
128
+ - *Type:* any
129
+
130
+ Any object.
131
+
132
+ ---
133
+
134
+ #### Properties <a name="Properties" id="Properties"></a>
135
+
136
+ | **Name** | **Type** | **Description** |
137
+ | --- | --- | --- |
138
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.node">node</a></code> | <code>constructs.Node</code> | The tree node. |
139
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.assetHash">assetHash</a></code> | <code>string</code> | A hash of this asset, which is available at construction time. |
140
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.assetPath">assetPath</a></code> | <code>string</code> | The path to the asset, relative to the current Cloud Assembly. |
141
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.bucket">bucket</a></code> | <code>aws-cdk-lib.aws_s3.IBucket</code> | The S3 bucket in which this asset resides. |
142
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.httpUrl">httpUrl</a></code> | <code>string</code> | Attribute which represents the S3 HTTP URL of this asset. |
143
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.isFile">isFile</a></code> | <code>boolean</code> | Indicates if this asset is a single file. |
144
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.isZipArchive">isZipArchive</a></code> | <code>boolean</code> | Indicates if this asset is a zip archive. |
145
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3BucketName">s3BucketName</a></code> | <code>string</code> | Attribute that represents the name of the bucket this asset exists in. |
146
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3ObjectKey">s3ObjectKey</a></code> | <code>string</code> | Attribute which represents the S3 object key of this asset. |
147
+ | <code><a href="#@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3ObjectUrl">s3ObjectUrl</a></code> | <code>string</code> | Attribute which represents the S3 URL of this asset. |
148
+
149
+ ---
150
+
151
+ ##### `node`<sup>Required</sup> <a name="node" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.node"></a>
152
+
153
+ ```typescript
154
+ public readonly node: Node;
155
+ ```
156
+
157
+ - *Type:* constructs.Node
158
+
159
+ The tree node.
160
+
161
+ ---
162
+
163
+ ##### `assetHash`<sup>Required</sup> <a name="assetHash" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.assetHash"></a>
164
+
165
+ ```typescript
166
+ public readonly assetHash: string;
167
+ ```
168
+
169
+ - *Type:* string
170
+
171
+ A hash of this asset, which is available at construction time.
172
+
173
+ As this is a plain string, it
174
+ can be used in construct IDs in order to enforce creation of a new resource when the content
175
+ hash has changed.
176
+
177
+ ---
178
+
179
+ ##### `assetPath`<sup>Required</sup> <a name="assetPath" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.assetPath"></a>
180
+
181
+ ```typescript
182
+ public readonly assetPath: string;
183
+ ```
184
+
185
+ - *Type:* string
186
+
187
+ The path to the asset, relative to the current Cloud Assembly.
188
+
189
+ If asset staging is disabled, this will just be the original path.
190
+ If asset staging is enabled it will be the staged path.
191
+
192
+ ---
193
+
194
+ ##### `bucket`<sup>Required</sup> <a name="bucket" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.bucket"></a>
195
+
196
+ ```typescript
197
+ public readonly bucket: IBucket;
198
+ ```
199
+
200
+ - *Type:* aws-cdk-lib.aws_s3.IBucket
201
+
202
+ The S3 bucket in which this asset resides.
203
+
204
+ ---
205
+
206
+ ##### `httpUrl`<sup>Required</sup> <a name="httpUrl" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.httpUrl"></a>
207
+
208
+ ```typescript
209
+ public readonly httpUrl: string;
210
+ ```
211
+
212
+ - *Type:* string
213
+
214
+ Attribute which represents the S3 HTTP URL of this asset.
215
+
216
+ ---
217
+
218
+ *Example*
219
+
220
+ ```typescript
221
+ https://s3.us-west-1.amazonaws.com/bucket/key
222
+ ```
223
+
224
+
225
+ ##### `isFile`<sup>Required</sup> <a name="isFile" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.isFile"></a>
226
+
227
+ ```typescript
228
+ public readonly isFile: boolean;
229
+ ```
230
+
231
+ - *Type:* boolean
232
+
233
+ Indicates if this asset is a single file.
234
+
235
+ Allows constructs to ensure that the
236
+ correct file type was used.
237
+
238
+ ---
239
+
240
+ ##### `isZipArchive`<sup>Required</sup> <a name="isZipArchive" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.isZipArchive"></a>
241
+
242
+ ```typescript
243
+ public readonly isZipArchive: boolean;
244
+ ```
245
+
246
+ - *Type:* boolean
247
+
248
+ Indicates if this asset is a zip archive.
249
+
250
+ Allows constructs to ensure that the
251
+ correct file type was used.
252
+
253
+ ---
254
+
255
+ ##### `s3BucketName`<sup>Required</sup> <a name="s3BucketName" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3BucketName"></a>
256
+
257
+ ```typescript
258
+ public readonly s3BucketName: string;
259
+ ```
260
+
261
+ - *Type:* string
262
+
263
+ Attribute that represents the name of the bucket this asset exists in.
264
+
265
+ ---
266
+
267
+ ##### `s3ObjectKey`<sup>Required</sup> <a name="s3ObjectKey" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3ObjectKey"></a>
268
+
269
+ ```typescript
270
+ public readonly s3ObjectKey: string;
271
+ ```
272
+
273
+ - *Type:* string
274
+
275
+ Attribute which represents the S3 object key of this asset.
276
+
277
+ ---
278
+
279
+ ##### `s3ObjectUrl`<sup>Required</sup> <a name="s3ObjectUrl" id="@aws-cdk/asset-awscli-v2.AwsCliAsset.property.s3ObjectUrl"></a>
280
+
281
+ ```typescript
282
+ public readonly s3ObjectUrl: string;
283
+ ```
284
+
285
+ - *Type:* string
286
+
287
+ Attribute which represents the S3 URL of this asset.
288
+
289
+ ---
290
+
291
+ *Example*
292
+
293
+ ```typescript
294
+ s3://bucket/key
295
+ ```
296
+
297
+
298
+
299
+
300
+
301
+
@@ -0,0 +1,4 @@
1
+ ## Code of Conduct
2
+ This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
3
+ For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
4
+ opensource-codeofconduct@amazon.com with any additional questions or comments.
@@ -0,0 +1,59 @@
1
+ # Contributing Guidelines
2
+
3
+ Thank you for your interest in contributing to our project. Whether it's a bug report, new feature, correction, or additional
4
+ documentation, we greatly value feedback and contributions from our community.
5
+
6
+ Please read through this document before submitting any issues or pull requests to ensure we have all the necessary
7
+ information to effectively respond to your bug report or contribution.
8
+
9
+
10
+ ## Reporting Bugs/Feature Requests
11
+
12
+ We welcome you to use the GitHub issue tracker to report bugs or suggest features.
13
+
14
+ When filing an issue, please check existing open, or recently closed, issues to make sure somebody else hasn't already
15
+ reported the issue. Please try to include as much information as you can. Details like these are incredibly useful:
16
+
17
+ * A reproducible test case or series of steps
18
+ * The version of our code being used
19
+ * Any modifications you've made relevant to the bug
20
+ * Anything unusual about your environment or deployment
21
+
22
+
23
+ ## Contributing via Pull Requests
24
+ Contributions via pull requests are much appreciated. Before sending us a pull request, please ensure that:
25
+
26
+ 1. You are working against the latest source on the *awscli-v2/main* branch.
27
+ 2. You check existing open, and recently merged, pull requests to make sure someone else hasn't addressed the problem already.
28
+ 3. You open an issue to discuss any significant work - we would hate for your time to be wasted.
29
+
30
+ To send us a pull request, please:
31
+
32
+ 1. Fork the repository.
33
+ 2. Modify the source; please focus on the specific change you are contributing. If you also reformat all the code, it will be hard for us to focus on your change.
34
+ 3. Ensure local tests pass.
35
+ 4. Commit to your fork using clear commit messages.
36
+ 5. Send us a pull request, answering any default questions in the pull request interface.
37
+ 6. Pay attention to any automated CI failures reported in the pull request, and stay involved in the conversation.
38
+
39
+ GitHub provides additional document on [forking a repository](https://help.github.com/articles/fork-a-repo/) and
40
+ [creating a pull request](https://help.github.com/articles/creating-a-pull-request/).
41
+
42
+
43
+ ## Finding contributions to work on
44
+ Looking at the existing issues is a great way to find something to contribute on. As our projects, by default, use the default GitHub issue labels (enhancement/bug/duplicate/help wanted/invalid/question/wontfix), looking at any 'help wanted' issues is a great place to start.
45
+
46
+
47
+ ## Code of Conduct
48
+ This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct).
49
+ For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact
50
+ opensource-codeofconduct@amazon.com with any additional questions or comments.
51
+
52
+
53
+ ## Security issue notifications
54
+ If you discover a potential security issue in this project we ask that you notify AWS/Amazon Security via our [vulnerability reporting page](http://aws.amazon.com/security/vulnerability-reporting/). Please do **not** create a public github issue.
55
+
56
+
57
+ ## Licensing
58
+
59
+ See the [LICENSE](LICENSE) file for our project's licensing. We will ask you to confirm the licensing of your contribution.
package/LICENSE ADDED
@@ -0,0 +1,202 @@
1
+
2
+ Apache License
3
+ Version 2.0, January 2004
4
+ http://www.apache.org/licenses/
5
+
6
+ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
7
+
8
+ 1. Definitions.
9
+
10
+ "License" shall mean the terms and conditions for use, reproduction,
11
+ and distribution as defined by Sections 1 through 9 of this document.
12
+
13
+ "Licensor" shall mean the copyright owner or entity authorized by
14
+ the copyright owner that is granting the License.
15
+
16
+ "Legal Entity" shall mean the union of the acting entity and all
17
+ other entities that control, are controlled by, or are under common
18
+ control with that entity. For the purposes of this definition,
19
+ "control" means (i) the power, direct or indirect, to cause the
20
+ direction or management of such entity, whether by contract or
21
+ otherwise, or (ii) ownership of fifty percent (50%) or more of the
22
+ outstanding shares, or (iii) beneficial ownership of such entity.
23
+
24
+ "You" (or "Your") shall mean an individual or Legal Entity
25
+ exercising permissions granted by this License.
26
+
27
+ "Source" form shall mean the preferred form for making modifications,
28
+ including but not limited to software source code, documentation
29
+ source, and configuration files.
30
+
31
+ "Object" form shall mean any form resulting from mechanical
32
+ transformation or translation of a Source form, including but
33
+ not limited to compiled object code, generated documentation,
34
+ and conversions to other media types.
35
+
36
+ "Work" shall mean the work of authorship, whether in Source or
37
+ Object form, made available under the License, as indicated by a
38
+ copyright notice that is included in or attached to the work
39
+ (an example is provided in the Appendix below).
40
+
41
+ "Derivative Works" shall mean any work, whether in Source or Object
42
+ form, that is based on (or derived from) the Work and for which the
43
+ editorial revisions, annotations, elaborations, or other modifications
44
+ represent, as a whole, an original work of authorship. For the purposes
45
+ of this License, Derivative Works shall not include works that remain
46
+ separable from, or merely link (or bind by name) to the interfaces of,
47
+ the Work and Derivative Works thereof.
48
+
49
+ "Contribution" shall mean any work of authorship, including
50
+ the original version of the Work and any modifications or additions
51
+ to that Work or Derivative Works thereof, that is intentionally
52
+ submitted to Licensor for inclusion in the Work by the copyright owner
53
+ or by an individual or Legal Entity authorized to submit on behalf of
54
+ the copyright owner. For the purposes of this definition, "submitted"
55
+ means any form of electronic, verbal, or written communication sent
56
+ to the Licensor or its representatives, including but not limited to
57
+ communication on electronic mailing lists, source code control systems,
58
+ and issue tracking systems that are managed by, or on behalf of, the
59
+ Licensor for the purpose of discussing and improving the Work, but
60
+ excluding communication that is conspicuously marked or otherwise
61
+ designated in writing by the copyright owner as "Not a Contribution."
62
+
63
+ "Contributor" shall mean Licensor and any individual or Legal Entity
64
+ on behalf of whom a Contribution has been received by Licensor and
65
+ subsequently incorporated within the Work.
66
+
67
+ 2. Grant of Copyright License. Subject to the terms and conditions of
68
+ this License, each Contributor hereby grants to You a perpetual,
69
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
70
+ copyright license to reproduce, prepare Derivative Works of,
71
+ publicly display, publicly perform, sublicense, and distribute the
72
+ Work and such Derivative Works in Source or Object form.
73
+
74
+ 3. Grant of Patent License. Subject to the terms and conditions of
75
+ this License, each Contributor hereby grants to You a perpetual,
76
+ worldwide, non-exclusive, no-charge, royalty-free, irrevocable
77
+ (except as stated in this section) patent license to make, have made,
78
+ use, offer to sell, sell, import, and otherwise transfer the Work,
79
+ where such license applies only to those patent claims licensable
80
+ by such Contributor that are necessarily infringed by their
81
+ Contribution(s) alone or by combination of their Contribution(s)
82
+ with the Work to which such Contribution(s) was submitted. If You
83
+ institute patent litigation against any entity (including a
84
+ cross-claim or counterclaim in a lawsuit) alleging that the Work
85
+ or a Contribution incorporated within the Work constitutes direct
86
+ or contributory patent infringement, then any patent licenses
87
+ granted to You under this License for that Work shall terminate
88
+ as of the date such litigation is filed.
89
+
90
+ 4. Redistribution. You may reproduce and distribute copies of the
91
+ Work or Derivative Works thereof in any medium, with or without
92
+ modifications, and in Source or Object form, provided that You
93
+ meet the following conditions:
94
+
95
+ (a) You must give any other recipients of the Work or
96
+ Derivative Works a copy of this License; and
97
+
98
+ (b) You must cause any modified files to carry prominent notices
99
+ stating that You changed the files; and
100
+
101
+ (c) You must retain, in the Source form of any Derivative Works
102
+ that You distribute, all copyright, patent, trademark, and
103
+ attribution notices from the Source form of the Work,
104
+ excluding those notices that do not pertain to any part of
105
+ the Derivative Works; and
106
+
107
+ (d) If the Work includes a "NOTICE" text file as part of its
108
+ distribution, then any Derivative Works that You distribute must
109
+ include a readable copy of the attribution notices contained
110
+ within such NOTICE file, excluding those notices that do not
111
+ pertain to any part of the Derivative Works, in at least one
112
+ of the following places: within a NOTICE text file distributed
113
+ as part of the Derivative Works; within the Source form or
114
+ documentation, if provided along with the Derivative Works; or,
115
+ within a display generated by the Derivative Works, if and
116
+ wherever such third-party notices normally appear. The contents
117
+ of the NOTICE file are for informational purposes only and
118
+ do not modify the License. You may add Your own attribution
119
+ notices within Derivative Works that You distribute, alongside
120
+ or as an addendum to the NOTICE text from the Work, provided
121
+ that such additional attribution notices cannot be construed
122
+ as modifying the License.
123
+
124
+ You may add Your own copyright statement to Your modifications and
125
+ may provide additional or different license terms and conditions
126
+ for use, reproduction, or distribution of Your modifications, or
127
+ for any such Derivative Works as a whole, provided Your use,
128
+ reproduction, and distribution of the Work otherwise complies with
129
+ the conditions stated in this License.
130
+
131
+ 5. Submission of Contributions. Unless You explicitly state otherwise,
132
+ any Contribution intentionally submitted for inclusion in the Work
133
+ by You to the Licensor shall be under the terms and conditions of
134
+ this License, without any additional terms or conditions.
135
+ Notwithstanding the above, nothing herein shall supersede or modify
136
+ the terms of any separate license agreement you may have executed
137
+ with Licensor regarding such Contributions.
138
+
139
+ 6. Trademarks. This License does not grant permission to use the trade
140
+ names, trademarks, service marks, or product names of the Licensor,
141
+ except as required for reasonable and customary use in describing the
142
+ origin of the Work and reproducing the content of the NOTICE file.
143
+
144
+ 7. Disclaimer of Warranty. Unless required by applicable law or
145
+ agreed to in writing, Licensor provides the Work (and each
146
+ Contributor provides its Contributions) on an "AS IS" BASIS,
147
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
148
+ implied, including, without limitation, any warranties or conditions
149
+ of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
150
+ PARTICULAR PURPOSE. You are solely responsible for determining the
151
+ appropriateness of using or redistributing the Work and assume any
152
+ risks associated with Your exercise of permissions under this License.
153
+
154
+ 8. Limitation of Liability. In no event and under no legal theory,
155
+ whether in tort (including negligence), contract, or otherwise,
156
+ unless required by applicable law (such as deliberate and grossly
157
+ negligent acts) or agreed to in writing, shall any Contributor be
158
+ liable to You for damages, including any direct, indirect, special,
159
+ incidental, or consequential damages of any character arising as a
160
+ result of this License or out of the use or inability to use the
161
+ Work (including but not limited to damages for loss of goodwill,
162
+ work stoppage, computer failure or malfunction, or any and all
163
+ other commercial damages or losses), even if such Contributor
164
+ has been advised of the possibility of such damages.
165
+
166
+ 9. Accepting Warranty or Additional Liability. While redistributing
167
+ the Work or Derivative Works thereof, You may choose to offer,
168
+ and charge a fee for, acceptance of support, warranty, indemnity,
169
+ or other liability obligations and/or rights consistent with this
170
+ License. However, in accepting such obligations, You may act only
171
+ on Your own behalf and on Your sole responsibility, not on behalf
172
+ of any other Contributor, and only if You agree to indemnify,
173
+ defend, and hold each Contributor harmless for any liability
174
+ incurred by, or claims asserted against, such Contributor by reason
175
+ of your accepting any such warranty or additional liability.
176
+
177
+ END OF TERMS AND CONDITIONS
178
+
179
+ APPENDIX: How to apply the Apache License to your work.
180
+
181
+ To apply the Apache License to your work, attach the following
182
+ boilerplate notice, with the fields enclosed by brackets "[]"
183
+ replaced with your own identifying information. (Don't include
184
+ the brackets!) The text should be enclosed in the appropriate
185
+ comment syntax for the file format. We also recommend that a
186
+ file or class name and description of purpose be included on the
187
+ same "printed page" as the copyright notice for easier
188
+ identification within third-party archives.
189
+
190
+ Copyright [yyyy] [name of copyright owner]
191
+
192
+ Licensed under the Apache License, Version 2.0 (the "License");
193
+ you may not use this file except in compliance with the License.
194
+ You may obtain a copy of the License at
195
+
196
+ http://www.apache.org/licenses/LICENSE-2.0
197
+
198
+ Unless required by applicable law or agreed to in writing, software
199
+ distributed under the License is distributed on an "AS IS" BASIS,
200
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
201
+ See the License for the specific language governing permissions and
202
+ limitations under the License.
package/NOTICE ADDED
@@ -0,0 +1 @@
1
+ Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved.
package/README.md ADDED
@@ -0,0 +1,30 @@
1
+ # Asset with AWS CLI v2
2
+ <!--BEGIN STABILITY BANNER-->
3
+
4
+ ---
5
+
6
+ ![cdk-constructs: Experimental](https://img.shields.io/badge/cdk--constructs-experimental-important.svg?style=for-the-badge)
7
+
8
+ ---
9
+
10
+ > This library is currently under development. Do not use!
11
+
12
+ <!--END STABILITY BANNER-->
13
+
14
+
15
+ This module exports a single class called `AwsCliAsset` which is an `s3_assets.Asset` that bundles the AWS CLI v2.
16
+
17
+ Usage:
18
+
19
+ ```ts
20
+ // AwsCliLayer bundles the AWS CLI in a lambda layer
21
+ import { AwsCliAsset } from '@aws-cdk/asset-awscli-v2';
22
+
23
+ declare const fn: lambda.Function;
24
+ const awscli = new AwsCliAsset(this, 'AwsCliCode');
25
+ fn.addLayers(new lambda.LayerVersion(this, 'AwsCliLayer', {
26
+ code: lambda.Code.fromBucket(awscli.bucket, awscli.s3ObjectKey),
27
+ }));
28
+ ```
29
+
30
+ The CLI will be installed under `/opt/awscli/aws`.
@@ -0,0 +1 @@
1
+ build.sh
@@ -0,0 +1,45 @@
1
+ # Download the official aws cli Docker image
2
+ # see https://hub.docker.com/r/amazon/aws-cli
3
+ FROM amazon/aws-cli:2.7.35
4
+
5
+ RUN mkdir -p /opt
6
+ WORKDIR /tmp
7
+
8
+ #
9
+ # tools
10
+ #
11
+
12
+ RUN yum update -y \
13
+ && yum install -y zip unzip wget tar gzip
14
+
15
+ #
16
+ # organize for self-contained usage
17
+ #
18
+
19
+ RUN mv /usr/local/aws-cli /opt/awscli
20
+ RUN ln -s /opt/awscli/v2/2.*/bin/aws /opt/awscli
21
+
22
+ #
23
+ # cleanup
24
+ #
25
+
26
+ RUN cd /opt/awscli/v2/2.*/dist/awscli/examples \
27
+ && ls | grep -v "global_options.rst" | xargs rm -rf
28
+
29
+ #
30
+ # Test that the CLI works
31
+ #
32
+
33
+ RUN /opt/awscli/aws help
34
+
35
+ #
36
+ # create the bundle
37
+ #
38
+
39
+ RUN cd /opt \
40
+ && zip --symlinks -r ../layer.zip * \
41
+ && echo "/layer.zip is ready" \
42
+ && ls -alh /layer.zip;
43
+
44
+ WORKDIR /
45
+ ENTRYPOINT [ "/bin/bash" ]
package/layer/build.sh ADDED
@@ -0,0 +1,20 @@
1
+ #!/bin/bash
2
+ set -euo pipefail
3
+
4
+ cd $(dirname $0)
5
+
6
+ mkdir -p ../lib
7
+
8
+ echo ">> Building AWS Lambda layer inside a docker image..."
9
+
10
+ TAG='aws-lambda-layer'
11
+
12
+ docker build -t ${TAG} .
13
+
14
+ echo ">> Extracting layer.zip from the build container..."
15
+ CONTAINER=$(docker run -d ${TAG} false)
16
+ docker cp ${CONTAINER}:/layer.zip ../lib/layer.zip
17
+
18
+ echo ">> Stopping container..."
19
+ docker rm -f ${CONTAINER}
20
+ echo ">> lib/layer.zip is ready"
@@ -0,0 +1,8 @@
1
+ import * as s3_assets from 'aws-cdk-lib/aws-s3-assets';
2
+ import { Construct } from 'constructs';
3
+ /**
4
+ * A CDK Asset construct that contains the AWS CLI.
5
+ */
6
+ export declare class AwsCliAsset extends s3_assets.Asset {
7
+ constructor(scope: Construct, id: string, options?: s3_assets.AssetOptions);
8
+ }