aws-cdk-github-oidc 4.2.0 → 4.2.2

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/.jsii CHANGED
@@ -8522,7 +8522,7 @@
8522
8522
  },
8523
8523
  "name": "aws-cdk-github-oidc",
8524
8524
  "readme": {
8525
- "markdown": "# AWS CDK Github OpenID Connect\n\n![cdk-support](https://img.shields.io/badge/cdk-%20typescript%20|%20python%20-informational \"TypeScript | Python\")\n[![release](https://github.com/aripalo/aws-cdk-github-oidc/actions/workflows/release.yml/badge.svg)](https://github.com/aripalo/aws-cdk-github-oidc/actions/workflows/release.yml)\n[![codecov](https://codecov.io/gh/aripalo/aws-cdk-github-oidc/branch/main/graph/badge.svg?token=5X44RM6J17)](https://codecov.io/gh/aripalo/aws-cdk-github-oidc)\n\n---\n\nAWS [CDK](https://aws.amazon.com/cdk/) constructs that define:\n\n- Github Actions as OpenID Connect Identity Provider into AWS IAM\n- IAM Roles that can be assumed by Github Actions workflows\n\nThese constructs allows you to harden your AWS deployment security by removing the need to create long-term access keys for Github Actions and instead use OpenID Connect to Authenticate your Github Action workflow with AWS IAM.\n\n## Background information\n\n![github-aws-oidc](/assets/github-aws-oidc.svg \"Github OIDC with AWS\")\n\n- [GitHub Actions: Secure cloud deployments with OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/) on Github Changelog Blog.\n- [Security hardening your deployments](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments) on Github Docs.\n- [Assuming a role with `aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role).\n- Shout-out to [Richard H. Boyd](https://twitter.com/rchrdbyd) for helping me to debug Github OIDC setup with AWS IAM and his [Deploying to AWS with Github Actions](https://www.githubuniverse.com/2021/session/692586/deploying-to-aws-with-github-actions)-talk.\n- Shout-out to [Aidan W Steele](https://twitter.com/__steele) and his blog post [AWS federation comes to GitHub Actions](https://awsteele.com/blog/2021/09/15/aws-federation-comes-to-github-actions.html) for being the original inspiration for this.\n\n<br/>\n\n## Getting started\n\n```shell\nnpm i -D aws-cdk-github-oidc\n```\n\n<br/>\n\n### OpenID Connect Identity Provider trust for AWS IAM\n\nTo create a new Github OIDC provider configuration into AWS IAM:\n\n```ts\nimport { GithubActionsIdentityProvider } from \"aws-cdk-github-oidc\";\n\nconst provider = new GithubActionsIdentityProvider(scope, \"GithubProvider\");\n```\n\nIn the background this creates an OIDC provider trust configuration into AWS IAM with an [issuer URL of `https://token.actions.githubusercontent.com`](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws) and audiences (client IDs) configured as `['sts.amazonaws.com']` (which matches the [`aws-actions/configure-aws-credentials`](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws) implementation).\n\n<br/>\n\n### Retrieving a reference to an existing Github OIDC provider configuration\n\nRemember, **there can be only one (Github OIDC provider per AWS Account)**, so to retrieve a reference to existing Github OIDC provider use `fromAccount` static method:\n\n```ts\nimport { GithubActionsIdentityProvider } from \"aws-cdk-github-oidc\";\n\nconst provider = GithubActionsIdentityProvider.fromAccount(\n scope,\n \"GithubProvider\"\n);\n```\n\n<br/>\n\n### Defining a role for Github Actions workflow to assume\n\n```ts\nimport { GithubActionsRole } from \"aws-cdk-github-oidc\";\n\nconst uploadRole = new GithubActionsRole(scope, \"UploadRole\", {\n provider: provider, // reference into the OIDC provider\n owner: \"octo-org\", // your repository owner (organization or user) name\n repo: \"octo-repo\", // your repository name (without the owner name)\n filter: \"ref:refs/tags/v*\", // JWT sub suffix filter, defaults to '*'\n});\n\n// use it like any other role, for example grant S3 bucket write access:\nmyBucket.grantWrite(uploadRole);\n```\n\nYou may pass in any `iam.RoleProps` into the construct's props, except `assumedBy` which will be defined by this construct (CDK will fail if you do):\n\n```ts\nconst deployRole = new GithubActionsRole(scope, \"DeployRole\", {\n provider: provider,\n owner: \"octo-org\",\n repo: \"octo-repo\",\n roleName: \"MyDeployRole\",\n description: \"This role deploys stuff to AWS\",\n maxSessionDuration: cdk.Duration.hours(2),\n});\n\n// You may also use various \"add*\" policy methods!\n// \"AdministratorAccess\" not really a good idea, just for an example here:\ndeployRole.addManagedPolicy(\n iam.ManagedPolicy.fromAwsManagedPolicyName(\"AdministratorAccess\")\n);\n```\n\n<br/>\n\n#### Subject Filter\n\nBy default the value of `filter` property will be `'*'` which means any workflow (from given repository) from any branch, tag, environment or pull request can assume this role. To further stricten the OIDC trust policy on the role, you may adjust the subject filter as seen on the [examples in Github Docs](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud); For example:\n\n| `filter` value | Descrition |\n| :----------------------------- | :--------------------------------------- |\n| `'ref:refs/tags/v*'` | Allow only tags with prefix of `v` |\n| `'ref:refs/heads/demo-branch'` | Allow only from branch `demo-branch` |\n| `'pull_request'` | Allow only from pull request |\n| `'environment:Production'` | Allow only from `Production` environment |\n\n<br/>\n\n### Github Actions Workflow\n\nTo actually utilize this in your Github Actions workflow, use [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) to [assume a role](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role).\n\nAt the moment you must use the `master` version (until AWS releases a new tag):\n\n```yaml\njobs:\n deploy:\n name: Upload to Amazon S3\n runs-on: ubuntu-latest\n permissions:\n id-token: write # needed to interact with GitHub's OIDC Token endpoint.\n contents: read\n steps:\n - name: Checkout\n uses: actions/checkout@v2\n\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@master\n with:\n role-to-assume: arn:aws:iam::123456789012:role/MyUploadRole\n #role-session-name: MySessionName # Optional\n aws-region: us-east-1\n\n - name: Sync files to S3\n run: |\n aws s3 sync . s3://my-example-bucket\n```\n\n<br/>\n"
8525
+ "markdown": "> [!IMPORTANT]\n> Migrating **to `v4`**? See [Migration Guide](#migration-guide) at the end of this README.\n\n\n# AWS CDK Github OpenID Connect\n\n![cdk-support](https://img.shields.io/badge/cdk-%20typescript%20|%20python%20-informational \"TypeScript | Python\")\n[![release](https://github.com/aripalo/aws-cdk-github-oidc/actions/workflows/release.yml/badge.svg)](https://github.com/aripalo/aws-cdk-github-oidc/actions/workflows/release.yml)\n[![codecov](https://codecov.io/gh/aripalo/aws-cdk-github-oidc/branch/main/graph/badge.svg?token=5X44RM6J17)](https://codecov.io/gh/aripalo/aws-cdk-github-oidc)\n\n---\n\nAWS [CDK](https://aws.amazon.com/cdk/) constructs that define:\n\n- Github Actions as OpenID Connect Identity Provider into AWS IAM\n- IAM Roles that can be assumed by Github Actions workflows\n\nThese constructs allows you to harden your AWS deployment security by removing the need to create long-term access keys for Github Actions and instead use OpenID Connect to Authenticate your Github Action workflow with AWS IAM.\n\n## Background information\n\n![github-aws-oidc](/assets/github-aws-oidc.svg \"Github OIDC with AWS\")\n\n- [GitHub Actions: Secure cloud deployments with OpenID Connect](https://github.blog/changelog/2021-10-27-github-actions-secure-cloud-deployments-with-openid-connect/) on Github Changelog Blog.\n- [Security hardening your deployments](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments) on Github Docs.\n- [Assuming a role with `aws-actions/configure-aws-credentials`](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role).\n- Shout-out to [Richard H. Boyd](https://twitter.com/rchrdbyd) for helping me to debug Github OIDC setup with AWS IAM and his [Deploying to AWS with Github Actions](https://www.githubuniverse.com/2021/session/692586/deploying-to-aws-with-github-actions)-talk.\n- Shout-out to [Aidan W Steele](https://twitter.com/__steele) and his blog post [AWS federation comes to GitHub Actions](https://awsteele.com/blog/2021/09/15/aws-federation-comes-to-github-actions.html) for being the original inspiration for this.\n\n<br/>\n\n## Getting started\n\n```shell\npnpm add -D aws-cdk-github-oidc\n```\n\n<br/>\n\n### OpenID Connect Identity Provider trust for AWS IAM\n\nTo create a new Github OIDC provider configuration into AWS IAM:\n\n```ts\nimport { GithubActionsIdentityProvider } from \"aws-cdk-github-oidc\";\n\nconst provider = new GithubActionsIdentityProvider(scope, \"GithubProvider\");\n```\n\nIn the background this creates an OIDC provider trust configuration into AWS IAM with an [issuer URL of `https://token.actions.githubusercontent.com`](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws) and audiences (client IDs) configured as `['sts.amazonaws.com']` (which matches the [`aws-actions/configure-aws-credentials`](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws) implementation).\n\n<br/>\n\n### Retrieving a reference to an existing Github OIDC provider configuration\n\nRemember, **there can be only one (Github OIDC provider per AWS Account)**, so to retrieve a reference to existing Github OIDC provider use `fromAccount` static method:\n\n```ts\nimport { GithubActionsIdentityProvider } from \"aws-cdk-github-oidc\";\n\nconst provider = GithubActionsIdentityProvider.fromAccount(\n scope,\n \"GithubProvider\"\n);\n```\n\n<br/>\n\n### Defining a role for Github Actions workflow to assume\n\n```ts\nimport { GithubActionsRole } from \"aws-cdk-github-oidc\";\n\nconst uploadRole = new GithubActionsRole(scope, \"UploadRole\", {\n provider: provider, // reference into the OIDC provider\n owner: \"octo-org\", // your repository owner (organization or user) name\n repo: \"octo-repo\", // your repository name (without the owner name)\n filter: \"ref:refs/tags/v*\", // JWT sub suffix filter, defaults to '*'\n});\n\n// use it like any other role, for example grant S3 bucket write access:\nmyBucket.grantWrite(uploadRole);\n```\n\nYou may pass in any `iam.RoleProps` into the construct's props, except `assumedBy` which will be defined by this construct (CDK will fail if you do):\n\n```ts\nconst deployRole = new GithubActionsRole(scope, \"DeployRole\", {\n provider: provider,\n owner: \"octo-org\",\n repo: \"octo-repo\",\n roleName: \"MyDeployRole\",\n description: \"This role deploys stuff to AWS\",\n maxSessionDuration: cdk.Duration.hours(2),\n});\n\n// You may also use various \"add*\" policy methods!\n// \"AdministratorAccess\" not really a good idea, just for an example here:\ndeployRole.addManagedPolicy(\n iam.ManagedPolicy.fromAwsManagedPolicyName(\"AdministratorAccess\")\n);\n```\n\n<br/>\n\n#### Subject Filter\n\nBy default the value of `filter` property will be `'*'` which means any workflow (from given repository) from any branch, tag, environment or pull request can assume this role. To further stricten the OIDC trust policy on the role, you may adjust the subject filter as seen on the [examples in Github Docs](https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#configuring-the-oidc-trust-with-the-cloud); For example:\n\n| `filter` value | Descrition |\n| :----------------------------- | :--------------------------------------- |\n| `'ref:refs/tags/v*'` | Allow only tags with prefix of `v` |\n| `'ref:refs/heads/demo-branch'` | Allow only from branch `demo-branch` |\n| `'pull_request'` | Allow only from pull request |\n| `'environment:Production'` | Allow only from `Production` environment |\n\n<br/>\n\n### Github Actions Workflow\n\nTo actually utilize this in your Github Actions workflow, use [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) to [assume a role](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role).\n\n```yaml\njobs:\n whoami:\n name: Who Am I\n runs-on: ubuntu-latest\n permissions:\n id-token: write # needed to interact with GitHub's OIDC Token endpoint.\n steps:\n - name: Configure AWS credentials\n uses: aws-actions/configure-aws-credentials@d979d5b3a71173a29b74b5b88418bfda9437d885 # v6.1.1\n with:\n role-to-assume: arn:aws:iam::123456789012:role/MyUploadRole\n #role-session-name: MySessionName # Optional\n aws-region: us-east-1\n - name: Get Caller Identity\n run: |\n aws sts get-caller-identity\n```\n\n<br/>\n\n\n## Migration Guide\n\n- [v2→v3](#v2v3)\n- [v3→v4](#v3v4)\n\n### v2→v3\n\n1. Install AWS CDK version [`v2.237.0`](https://github.com/aws/aws-cdk/releases/tag/v2.237.0) or newer required (due to support of [OIDC provider removal policy support](https://github.com/aws/aws-cdk/commit/09383cbad28336441f0fb405c9d8a190135620dc)):\n\n ```sh\n pnpm add -D aws-cdk-lib@^2.237.0\n ```\n\n2. Install `v3.1.0` (or newer v3 release) of this library:\n\n ```sh\n pnpm add -D aws-cdk-github-oidc@^3.1\n ```\n\n3. No additional steps required, as the v3 major version does not introduce any breaking changes (just a lot of internal tooling changes).\n\n### v3→v4\n\n> [!CAUTION]\n> The following steps describe a _**no-downtime** migration path_.\n> It is the recommended approach, but somewhat _involved_: Hence some users may decide to use \"destroy + redeploy\" strategy instead, which causes downtime to authenticating from GitHub Actions to AWS using OIDC.\n\n1. Ensure you are running `v3.1.0` (or newer v3 release) of this library, see [v2→v3](#v2v3).\n\n2. Configure `RETAIN` removal policy for the provider:\n\n ```diff\n const provider = new GithubActionsIdentityProvider(this, \"GithubProvider\", {\n + removalPolicy: cdk.RemovalPolicy.RETAIN,\n });\n ```\n\n3. Run `pnpm exec cdk diff`, which will show an output similar to:\n\n ```sh\n Resources\n [~] Custom::AWSCDKOpenIdConnectProvider GithubProvider/Resource GithubProvider1CDE27EB\n ├─ [~] DeletionPolicy\n │ ├─ [-] Delete\n │ └─ [+] Retain\n └─ [~] UpdateReplacePolicy\n ├─ [-] Delete\n └─ [+] Retain\n ```\n\n\n4. Deploy the changes `pnpm exec cdk deploy`\n\n5. Once the `RETAIN` removal policy has been successfully deployed, upgrade this library to `v4.2` (or newer v4 release):\n\n ```sh\n pnpm add -D aws-cdk-github-oidc@^4.2\n ```\n\n6. Temporarily change from provider initializion to provider lookup:\n\n ```diff\n - const provider = new GithubActionsIdentityProvider(this, \"GithubProvider\", {\n - removalPolicy: cdk.RemovalPolicy.RETAIN,\n - });\n + const provider = GithubActionsIdentityProvider.fromAccount(this, \"GithubProviderReference\");\n ```\n\n > [!IMPORTANT]\n > Notice the different construct ID (in the example `GithubProviderReference` instead of ~~`GithubProvider`~~). This is required so that the CDK treats the GitHub OIDC provider lookup as a different \"thing\" and does not try to change the type of existing construct.\n\n7. Check `pnpm exec cdk diff` which should look similar to:\n ```sh\n Resources\n [-] Custom::AWSCDKOpenIdConnectProvider GithubProvider/Resource GithubProvider1CDE27EB orphan\n [-] AWS::IAM::Role Custom::AWSCDKOpenIdConnectProviderCustomResourceProvider/Role CustomAWSCDKOpenIdConnectProviderCustomResourceProviderRole517FED65 destroy\n [-] AWS::Lambda::Function Custom::AWSCDKOpenIdConnectProviderCustomResourceProvider/Handler CustomAWSCDKOpenIdConnectProviderCustomResourceProviderHandlerF2C543E0 destroy\n ```\n\n8. Deploy the changes with `pnpm exec cdk deploy`\n\n9. Once the deployment has succeeded, remove the provider lookup and replace it with the original provider initialization:\n\n ```diff\n - const provider = GithubActionsIdentityProvider.fromAccount(this, \"GithubProviderReference\");\n + const provider = new GithubActionsIdentityProvider(this, \"GithubProvider\", {\n + removalPolicy: cdk.RemovalPolicy.RETAIN,\n + });\n ```\n\n10. Copy the ARN of the existing OIDC provider, it will be in the format of:\n\n ```\n arn:aws:iam::123456789012:oidc-provider/token.actions.githubusercontent.com # REPLACE with your account ID\n ```\n\n11. Use [cdk import](https://docs.aws.amazon.com/cdk/v2/guide/ref-cli-cmd-import.html):\n\n ```sh\n pnpm exec cdk import <YOUR_STACK_NAME>\n ```\n\n ... and when asked, input the provider ARN you copied in step 10:\n ```sh\n <YOUR_STACK_NAME>/GithubProvider/Resource (AWS::IAM::OIDCProvider): enter Arn (empty to skip)\n ```\n\n12. You should be done now, but you may want to **perform manual verification** in addition to [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/detect-drift-stack.html) and/or `cdk diff``\u001b to verify.\n\n\n\n"
8526
8526
  },
8527
8527
  "repository": {
8528
8528
  "type": "git",
@@ -9075,6 +9075,6 @@
9075
9075
  "symbolId": "src/iam-role-props:RoleProps"
9076
9076
  }
9077
9077
  },
9078
- "version": "4.2.0",
9079
- "fingerprint": "cgAdv0k/PI21/QKE0izvgO8Uoijc/VzJgS1V6qz3Lis="
9078
+ "version": "4.2.2",
9079
+ "fingerprint": "IiuoO3Ho8RrzPh4GWJ2CDWkMJ1gk1H9274ofKe/UuFQ="
9080
9080
  }
package/README.md CHANGED
@@ -1,3 +1,7 @@
1
+ > [!IMPORTANT]
2
+ > Migrating **to `v4`**? See [Migration Guide](#migration-guide) at the end of this README.
3
+
4
+
1
5
  # AWS CDK Github OpenID Connect
2
6
 
3
7
  ![cdk-support](https://img.shields.io/badge/cdk-%20typescript%20|%20python%20-informational "TypeScript | Python")
@@ -28,7 +32,7 @@ These constructs allows you to harden your AWS deployment security by removing t
28
32
  ## Getting started
29
33
 
30
34
  ```shell
31
- npm i -D aws-cdk-github-oidc
35
+ pnpm add -D aws-cdk-github-oidc
32
36
  ```
33
37
 
34
38
  <br/>
@@ -116,30 +120,136 @@ By default the value of `filter` property will be `'*'` which means any workflow
116
120
 
117
121
  To actually utilize this in your Github Actions workflow, use [aws-actions/configure-aws-credentials](https://github.com/aws-actions/configure-aws-credentials) to [assume a role](https://github.com/aws-actions/configure-aws-credentials#assuming-a-role).
118
122
 
119
- At the moment you must use the `master` version (until AWS releases a new tag):
120
-
121
123
  ```yaml
122
124
  jobs:
123
- deploy:
124
- name: Upload to Amazon S3
125
+ whoami:
126
+ name: Who Am I
125
127
  runs-on: ubuntu-latest
126
128
  permissions:
127
129
  id-token: write # needed to interact with GitHub's OIDC Token endpoint.
128
- contents: read
129
130
  steps:
130
- - name: Checkout
131
- uses: actions/checkout@v2
132
-
133
131
  - name: Configure AWS credentials
134
- uses: aws-actions/configure-aws-credentials@master
132
+ uses: aws-actions/configure-aws-credentials@d979d5b3a71173a29b74b5b88418bfda9437d885 # v6.1.1
135
133
  with:
136
134
  role-to-assume: arn:aws:iam::123456789012:role/MyUploadRole
137
135
  #role-session-name: MySessionName # Optional
138
136
  aws-region: us-east-1
139
-
140
- - name: Sync files to S3
137
+ - name: Get Caller Identity
141
138
  run: |
142
- aws s3 sync . s3://my-example-bucket
139
+ aws sts get-caller-identity
143
140
  ```
144
141
 
145
142
  <br/>
143
+
144
+
145
+ ## Migration Guide
146
+
147
+ - [v2→v3](#v2v3)
148
+ - [v3→v4](#v3v4)
149
+
150
+ ### v2→v3
151
+
152
+ 1. Install AWS CDK version [`v2.237.0`](https://github.com/aws/aws-cdk/releases/tag/v2.237.0) or newer required (due to support of [OIDC provider removal policy support](https://github.com/aws/aws-cdk/commit/09383cbad28336441f0fb405c9d8a190135620dc)):
153
+
154
+ ```sh
155
+ pnpm add -D aws-cdk-lib@^2.237.0
156
+ ```
157
+
158
+ 2. Install `v3.1.0` (or newer v3 release) of this library:
159
+
160
+ ```sh
161
+ pnpm add -D aws-cdk-github-oidc@^3.1
162
+ ```
163
+
164
+ 3. No additional steps required, as the v3 major version does not introduce any breaking changes (just a lot of internal tooling changes).
165
+
166
+ ### v3→v4
167
+
168
+ > [!CAUTION]
169
+ > The following steps describe a _**no-downtime** migration path_.
170
+ > It is the recommended approach, but somewhat _involved_: Hence some users may decide to use "destroy + redeploy" strategy instead, which causes downtime to authenticating from GitHub Actions to AWS using OIDC.
171
+
172
+ 1. Ensure you are running `v3.1.0` (or newer v3 release) of this library, see [v2→v3](#v2v3).
173
+
174
+ 2. Configure `RETAIN` removal policy for the provider:
175
+
176
+ ```diff
177
+ const provider = new GithubActionsIdentityProvider(this, "GithubProvider", {
178
+ + removalPolicy: cdk.RemovalPolicy.RETAIN,
179
+ });
180
+ ```
181
+
182
+ 3. Run `pnpm exec cdk diff`, which will show an output similar to:
183
+
184
+ ```sh
185
+ Resources
186
+ [~] Custom::AWSCDKOpenIdConnectProvider GithubProvider/Resource GithubProvider1CDE27EB
187
+ ├─ [~] DeletionPolicy
188
+ │ ├─ [-] Delete
189
+ │ └─ [+] Retain
190
+ └─ [~] UpdateReplacePolicy
191
+ ├─ [-] Delete
192
+ └─ [+] Retain
193
+ ```
194
+
195
+
196
+ 4. Deploy the changes `pnpm exec cdk deploy`
197
+
198
+ 5. Once the `RETAIN` removal policy has been successfully deployed, upgrade this library to `v4.2` (or newer v4 release):
199
+
200
+ ```sh
201
+ pnpm add -D aws-cdk-github-oidc@^4.2
202
+ ```
203
+
204
+ 6. Temporarily change from provider initializion to provider lookup:
205
+
206
+ ```diff
207
+ - const provider = new GithubActionsIdentityProvider(this, "GithubProvider", {
208
+ - removalPolicy: cdk.RemovalPolicy.RETAIN,
209
+ - });
210
+ + const provider = GithubActionsIdentityProvider.fromAccount(this, "GithubProviderReference");
211
+ ```
212
+
213
+ > [!IMPORTANT]
214
+ > Notice the different construct ID (in the example `GithubProviderReference` instead of ~~`GithubProvider`~~). This is required so that the CDK treats the GitHub OIDC provider lookup as a different "thing" and does not try to change the type of existing construct.
215
+
216
+ 7. Check `pnpm exec cdk diff` which should look similar to:
217
+ ```sh
218
+ Resources
219
+ [-] Custom::AWSCDKOpenIdConnectProvider GithubProvider/Resource GithubProvider1CDE27EB orphan
220
+ [-] AWS::IAM::Role Custom::AWSCDKOpenIdConnectProviderCustomResourceProvider/Role CustomAWSCDKOpenIdConnectProviderCustomResourceProviderRole517FED65 destroy
221
+ [-] AWS::Lambda::Function Custom::AWSCDKOpenIdConnectProviderCustomResourceProvider/Handler CustomAWSCDKOpenIdConnectProviderCustomResourceProviderHandlerF2C543E0 destroy
222
+ ```
223
+
224
+ 8. Deploy the changes with `pnpm exec cdk deploy`
225
+
226
+ 9. Once the deployment has succeeded, remove the provider lookup and replace it with the original provider initialization:
227
+
228
+ ```diff
229
+ - const provider = GithubActionsIdentityProvider.fromAccount(this, "GithubProviderReference");
230
+ + const provider = new GithubActionsIdentityProvider(this, "GithubProvider", {
231
+ + removalPolicy: cdk.RemovalPolicy.RETAIN,
232
+ + });
233
+ ```
234
+
235
+ 10. Copy the ARN of the existing OIDC provider, it will be in the format of:
236
+
237
+ ```
238
+ arn:aws:iam::123456789012:oidc-provider/token.actions.githubusercontent.com # REPLACE with your account ID
239
+ ```
240
+
241
+ 11. Use [cdk import](https://docs.aws.amazon.com/cdk/v2/guide/ref-cli-cmd-import.html):
242
+
243
+ ```sh
244
+ pnpm exec cdk import <YOUR_STACK_NAME>
245
+ ```
246
+
247
+ ... and when asked, input the provider ARN you copied in step 10:
248
+ ```sh
249
+ <YOUR_STACK_NAME>/GithubProvider/Resource (AWS::IAM::OIDCProvider): enter Arn (empty to skip)
250
+ ```
251
+
252
+ 12. You should be done now, but you may want to **perform manual verification** in addition to [drift detection](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/detect-drift-stack.html) and/or `cdk diff`` to verify.
253
+
254
+
255
+
package/lib/provider.js CHANGED
@@ -55,6 +55,6 @@ class GithubActionsIdentityProvider extends iam.OidcProviderNative {
55
55
  }
56
56
  exports.GithubActionsIdentityProvider = GithubActionsIdentityProvider;
57
57
  _a = JSII_RTTI_SYMBOL_1;
58
- GithubActionsIdentityProvider[_a] = { fqn: "aws-cdk-github-oidc.GithubActionsIdentityProvider", version: "4.2.0" };
58
+ GithubActionsIdentityProvider[_a] = { fqn: "aws-cdk-github-oidc.GithubActionsIdentityProvider", version: "4.2.2" };
59
59
  GithubActionsIdentityProvider.issuer = "token.actions.githubusercontent.com";
60
60
  //# sourceMappingURL=data:application/json;base64,eyJ2ZXJzaW9uIjozLCJmaWxlIjoicHJvdmlkZXIuanMiLCJzb3VyY2VSb290IjoiIiwic291cmNlcyI6WyIuLi9zcmMvcHJvdmlkZXIudHMiXSwibmFtZXMiOltdLCJtYXBwaW5ncyI6Ijs7Ozs7QUFBQSxtQ0FBbUM7QUFDbkMsMkNBQTJDO0FBaUIzQzs7Ozs7Ozs7O0dBU0c7QUFDSCxNQUFhLDZCQUNYLFNBQVEsR0FBRyxDQUFDLGtCQUFrQjtJQUs5Qjs7Ozs7Ozs7Ozs7O09BWUc7SUFDSSxNQUFNLENBQUMsV0FBVyxDQUN2QixLQUFnQixFQUNoQixFQUFVO1FBRVYsTUFBTSxTQUFTLEdBQUcsR0FBRyxDQUFDLEtBQUssQ0FBQyxFQUFFLENBQUMsS0FBSyxDQUFDLENBQUMsT0FBTyxDQUFDO1FBQzlDLE1BQU0sV0FBVyxHQUFHLGdCQUFnQixTQUFTLGtCQUFrQiw2QkFBNkIsQ0FBQyxNQUFNLEVBQUUsQ0FBQztRQUN0RyxPQUFPLEdBQUcsQ0FBQyxrQkFBa0IsQ0FBQyxtQkFBbUIsQ0FBQyxLQUFLLEVBQUUsRUFBRSxFQUFFLFdBQVcsQ0FBQyxDQUFDO0lBQzVFLENBQUM7SUFFRDs7Ozs7Ozs7OztPQVVHO0lBQ0gsWUFDRSxLQUFnQixFQUNoQixFQUFVLEVBQ1YsS0FBMEM7UUFFMUMsS0FBSyxDQUFDLEtBQUssRUFBRSxFQUFFLEVBQUU7WUFDZixHQUFHLEtBQUs7WUFDUixHQUFHLEVBQUUsV0FBVyw2QkFBNkIsQ0FBQyxNQUFNLEVBQUU7WUFDdEQsU0FBUyxFQUFFLENBQUMsbUJBQW1CLENBQUM7U0FDakMsQ0FBQyxDQUFDO0lBQ0wsQ0FBQzs7QUFqREgsc0VBa0RDOzs7QUE5Q3dCLG9DQUFNLEdBQVcscUNBQXFDLENBQUMiLCJzb3VyY2VzQ29udGVudCI6WyJpbXBvcnQgKiBhcyBjZGsgZnJvbSBcImF3cy1jZGstbGliXCI7XG5pbXBvcnQgKiBhcyBpYW0gZnJvbSBcImF3cy1jZGstbGliL2F3cy1pYW1cIjtcbmltcG9ydCB7IENvbnN0cnVjdCB9IGZyb20gXCJjb25zdHJ1Y3RzXCI7XG5cbmV4cG9ydCBpbnRlcmZhY2UgR2l0aHViQWN0aW9uc0lkZW50aXR5UHJvdmlkZXJQcm9wcyB7XG4gIC8qKlxuICAgKiBUaGUgcmVtb3ZhbCBwb2xpY3kgZm9yIHRoZSBwcm92aWRlci5cbiAgICpcbiAgICogQGRlZmF1bHQgY2RrLlJlbW92YWxQb2xpY3kuREVTVFJPWVxuICAgKi9cbiAgcmVhZG9ubHkgcmVtb3ZhbFBvbGljeT86IGNkay5SZW1vdmFsUG9saWN5O1xufVxuXG4vKipcbiAqIERlc2NyaWJlcyBhIEdpdGh1YiBPcGVuSUQgQ29ubmVjdCBJZGVudGl0eSBQcm92aWRlciBmb3IgQVdTIElBTS5cbiAqL1xuZXhwb3J0IGludGVyZmFjZSBJR2l0aHViQWN0aW9uc0lkZW50aXR5UHJvdmlkZXIgZXh0ZW5kcyBpYW0uSU9pZGNQcm92aWRlciB7fVxuXG4vKipcbiAqIEdpdGh1YiBBY3Rpb25zIGFzIE9wZW5JRCBDb25uZWN0IElkZW50aXR5IFByb3ZpZGVyIGZvciBBV1MgSUFNLlxuICogVGhlcmUgY2FuIGJlIG9ubHkgb25lIChwZXIgQVdTIEFjY291bnQpLlxuICpcbiAqIFVzZSBgZnJvbUFjY291bnRgIHRvIHJldHJpZXZlIGEgcmVmZXJlbmNlIHRvIGV4aXN0aW5nIEdpdGh1YiBPSURDIHByb3ZpZGVyLlxuICpcbiAqIFVzZXMgdGhlIG5hdGl2ZSBDbG91ZEZvcm1hdGlvbiByZXNvdXJjZSBBV1M6OklBTTo6T0lEQ1Byb3ZpZGVyIChubyBMYW1iZGEgZnVuY3Rpb25zKS5cbiAqXG4gKiBAc2VlIGh0dHBzOi8vZG9jcy5naXRodWIuY29tL2VuL2FjdGlvbnMvZGVwbG95bWVudC9zZWN1cml0eS1oYXJkZW5pbmcteW91ci1kZXBsb3ltZW50cy9jb25maWd1cmluZy1vcGVuaWQtY29ubmVjdC1pbi1hbWF6b24td2ViLXNlcnZpY2VzXG4gKi9cbmV4cG9ydCBjbGFzcyBHaXRodWJBY3Rpb25zSWRlbnRpdHlQcm92aWRlclxuICBleHRlbmRzIGlhbS5PaWRjUHJvdmlkZXJOYXRpdmVcbiAgaW1wbGVtZW50cyBJR2l0aHViQWN0aW9uc0lkZW50aXR5UHJvdmlkZXJcbntcbiAgcHVibGljIHN0YXRpYyByZWFkb25seSBpc3N1ZXI6IHN0cmluZyA9IFwidG9rZW4uYWN0aW9ucy5naXRodWJ1c2VyY29udGVudC5jb21cIjtcblxuICAvKipcbiAgICogUmV0cmlldmUgYSByZWZlcmVuY2UgdG8gZXhpc3RpbmcgR2l0aHViIE9JREMgcHJvdmlkZXIgaW4geW91ciBBV1MgYWNjb3VudC5cbiAgICogQW4gQVdTIGFjY291bnQgY2FuIG9ubHkgaGF2ZSBzaW5nbGUgR2l0aHViIE9JREMgcHJvdmlkZXIgY29uZmlndXJlZCBpbnRvIGl0LFxuICAgKiBzbyBpbnRlcm5hbGx5IHRoZSByZWZlcmVuY2UgaXMgbWFkZSBieSBjb25zdHJ1Y3RpbmcgdGhlIEFSTiBmcm9tIEFXU1xuICAgKiBBY2NvdW50IElEICYgR2l0aHViIGlzc3VlciBVUkwuXG4gICAqXG4gICAqIEBwYXJhbSBzY29wZSBDREsgU3RhY2sgb3IgQ29uc3RydWN0IHRvIHdoaWNoIHRoZSBwcm92aWRlciBpcyBhc3NpZ25lZCB0b1xuICAgKiBAcGFyYW0gaWQgQ0RLIENvbnN0cnVjdCBJRCBnaXZlbiB0byB0aGUgY29uc3RydWN0XG4gICAqIEByZXR1cm5zIGEgQ0RLIENvbnN0cnVjdCByZXByZXNlbnRpbmcgdGhlIEdpdGh1YiBPSURDIHByb3ZpZGVyXG4gICAqXG4gICAqIEBleGFtcGxlXG4gICAqIEdpdGh1YkFjdGlvbnNJZGVudGl0eVByb3ZpZGVyLmZyb21BY2NvdW50KHNjb3BlLCBcIkdpdGh1YlByb3ZpZGVyXCIpO1xuICAgKi9cbiAgcHVibGljIHN0YXRpYyBmcm9tQWNjb3VudChcbiAgICBzY29wZTogQ29uc3RydWN0LFxuICAgIGlkOiBzdHJpbmcsXG4gICk6IElHaXRodWJBY3Rpb25zSWRlbnRpdHlQcm92aWRlciB7XG4gICAgY29uc3QgYWNjb3VudElkID0gY2RrLlN0YWNrLm9mKHNjb3BlKS5hY2NvdW50O1xuICAgIGNvbnN0IHByb3ZpZGVyQXJuID0gYGFybjphd3M6aWFtOjoke2FjY291bnRJZH06b2lkYy1wcm92aWRlci8ke0dpdGh1YkFjdGlvbnNJZGVudGl0eVByb3ZpZGVyLmlzc3Vlcn1gO1xuICAgIHJldHVybiBpYW0uT2lkY1Byb3ZpZGVyTmF0aXZlLmZyb21PaWRjUHJvdmlkZXJBcm4oc2NvcGUsIGlkLCBwcm92aWRlckFybik7XG4gIH1cblxuICAvKipcbiAgICogRGVmaW5lIGEgbmV3IEdpdGh1YiBPcGVuSUQgQ29ubmVjdCBJZGVudGl0eSBQcm92aWRlciBmb3IgQVdTIElBTS5cbiAgICogVGhlcmUgY2FuIGJlIG9ubHkgb25lIChwZXIgQVdTIEFjY291bnQpLlxuICAgKlxuICAgKiBAcGFyYW0gc2NvcGUgQ0RLIFN0YWNrIG9yIENvbnN0cnVjdCB0byB3aGljaCB0aGUgcHJvdmlkZXIgaXMgYXNzaWduZWQgdG9cbiAgICogQHBhcmFtIGlkIENESyBDb25zdHJ1Y3QgSUQgZ2l2ZW4gdG8gdGhlIGNvbnN0cnVjdFxuICAgKiBAcGFyYW0gcHJvcHMgb3B0aW9uYWwgcHJvcGVydGllcyBmb3IgdGhlIHByb3ZpZGVyXG4gICAqXG4gICAqIEBleGFtcGxlXG4gICAqIG5ldyBHaXRodWJBY3Rpb25zSWRlbnRpdHlQcm92aWRlcihzY29wZSwgXCJHaXRodWJQcm92aWRlclwiKTtcbiAgICovXG4gIGNvbnN0cnVjdG9yKFxuICAgIHNjb3BlOiBDb25zdHJ1Y3QsXG4gICAgaWQ6IHN0cmluZyxcbiAgICBwcm9wcz86IEdpdGh1YkFjdGlvbnNJZGVudGl0eVByb3ZpZGVyUHJvcHMsXG4gICkge1xuICAgIHN1cGVyKHNjb3BlLCBpZCwge1xuICAgICAgLi4ucHJvcHMsXG4gICAgICB1cmw6IGBodHRwczovLyR7R2l0aHViQWN0aW9uc0lkZW50aXR5UHJvdmlkZXIuaXNzdWVyfWAsXG4gICAgICBjbGllbnRJZHM6IFtcInN0cy5hbWF6b25hd3MuY29tXCJdLFxuICAgIH0pO1xuICB9XG59XG4iXX0=
package/lib/role.js CHANGED
@@ -101,5 +101,5 @@ class GithubActionsRole extends iam.Role {
101
101
  }
102
102
  exports.GithubActionsRole = GithubActionsRole;
103
103
  _a = JSII_RTTI_SYMBOL_1;
104
- GithubActionsRole[_a] = { fqn: "aws-cdk-github-oidc.GithubActionsRole", version: "4.2.0" };
104
+ GithubActionsRole[_a] = { fqn: "aws-cdk-github-oidc.GithubActionsRole", version: "4.2.2" };
105
105
  //# sourceMappingURL=data:application/json;base64,{"version":3,"file":"role.js","sourceRoot":"","sources":["../src/role.ts"],"names":[],"mappings":";;;;;AAAA,mCAAmC;AACnC,2CAA2C;AAG3C,iDAAiD;AACjD,yCAGoB;AAoEpB;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAa,iBAAkB,SAAQ,GAAG,CAAC,IAAI;IAC7C;;;;OAIG;IACK,MAAM,CAAC,gBAAgB,CAC7B,KAA6B;QAE7B,MAAM,YAAY,GAAQ,KAAK,CAAC;QAChC,OAAO,YAAY,CAAC,QAAQ,CAAC;QAC7B,OAAO,YAAY,CAAC,KAAK,CAAC;QAC1B,OAAO,YAAY,CAAC,IAAI,CAAC;QACzB,OAAO,YAAY,CAAC,MAAM,CAAC;QAC3B,OAAO,YAAY,CAAC;IACtB,CAAC;IAED,8DAA8D;IACtD,MAAM,CAAC,aAAa,CAAC,KAAgB,EAAE,KAAa;QAC1D,IAAI,sBAAmB,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,IAAI,EAAE,CAAC;YAC7C,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAChC,oCAAoC,KAAK,0KAA0K,CACpN,CAAC;QACJ,CAAC;IACH,CAAC;IAED,4DAA4D;IACpD,MAAM,CAAC,YAAY,CAAC,KAAgB,EAAE,IAAY;QACxD,IAAI,IAAI,KAAK,EAAE,EAAE,CAAC;YAChB,GAAG,CAAC,WAAW,CAAC,EAAE,CAAC,KAAK,CAAC,CAAC,QAAQ,CAChC,mCAAmC,IAAI,6BAA6B,CACrE,CAAC;QACJ,CAAC;IACH,CAAC;IAED,oDAAoD;IAC5C,MAAM,CAAC,aAAa,CAAC,KAA0B;QACrD,MAAM,EAAE,KAAK,EAAE,IAAI,EAAE,MAAM,GAAG,GAAG,EAAE,GAAG,KAAK,CAAC;QAC5C,OAAO,QAAQ,KAAK,IAAI,IAAI,IAAI,MAAM,EAAE,CAAC;IAC3C,CAAC;IAED;;;;;;;;;;;;;;;;;OAiBG;IACH,YAAY,KAAgB,EAAE,EAAU,EAAE,KAA6B;QACrE,MAAM,EAAE,QAAQ,EAAE,KAAK,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;QAExC,sBAAsB;QACtB,iBAAiB,CAAC,aAAa,CAAC,KAAK,EAAE,KAAK,CAAC,CAAC;QAC9C,iBAAiB,CAAC,YAAY,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC;QAE5C,iBAAiB;QACjB,MAAM,OAAO,GAAG,iBAAiB,CAAC,aAAa,CAAC,KAAK,CAAC,CAAC;QACvD,MAAM,SAAS,GAAG,iBAAiB,CAAC,gBAAgB,CAAC,KAAK,CAAC,CAAC;QAE5D,+BAA+B;QAC/B,KAAK,CAAC,KAAK,EAAE,EAAE,EAAE;YACf,GAAG,SAAS;YACZ,SAAS,EAAE,IAAI,GAAG,CAAC,oBAAoB,CAAC,QAAQ,CAAC,eAAe,EAAE;gBAChE,UAAU,EAAE;oBACV,oDAAoD;oBACpD,CAAC,GAAG,wCAA6B,CAAC,MAAM,MAAM,CAAC,EAAE,OAAO;iBACzD;gBACD,YAAY,EAAE;oBACZ,uEAAuE;oBACvE,0KAA0K;oBAC1K,CAAC,GAAG,wCAA6B,CAAC,MAAM,MAAM,CAAC,EAAE,mBAAmB;iBACrE;aACF,CAAC;SACH,CAAC,CAAC;IACL,CAAC;;AArFH,8CAsFC","sourcesContent":["import * as cdk from \"aws-cdk-lib\";\nimport * as iam from \"aws-cdk-lib/aws-iam\";\nimport { Construct } from \"constructs\";\nimport { RoleProps } from \"./iam-role-props\";\nimport githubUsernameRegex from \"./owner-regexp\";\nimport {\n  GithubActionsIdentityProvider,\n  IGithubActionsIdentityProvider,\n} from \"./provider\";\n\n/**\n * Github related configuration that forms the trust policy for this IAM Role.\n */\nexport interface GithubConfiguration {\n  /**\n   * Reference to Github OpenID Connect Provider configured in AWS IAM.\n   *\n   * Either pass an construct defined by `new GithubActionsIdentityProvider`\n   * or a retrieved reference from `GithubActionsIdentityProvider.fromAccount`.\n   * There can be only one (per AWS Account).\n   */\n  readonly provider: IGithubActionsIdentityProvider;\n\n  /**\n   * Repository owner (organization or username).\n   *\n   * @example\n   * 'octo-org'\n   */\n  readonly owner: string;\n\n  /**\n   * Repository name (slug) without the owner.\n   *\n   * @example\n   * 'octo-repo'\n   */\n  readonly repo: string;\n\n  /**\n   * Subject condition filter, appended after `repo:${owner}/${repo}:` string in IAM Role trust relationship.\n   *\n   * @default\n   * '*'\n   *\n   * You may use this value to only allow Github to assume the role on specific branches, tags, environments, pull requests etc.\n   * @example\n   * 'ref:refs/tags/v*'\n   * 'ref:refs/heads/demo-branch'\n   * 'pull_request'\n   * 'environment:Production'\n   *\n   * @see https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/about-security-hardening-with-openid-connect#examples\n   */\n  readonly filter?: string;\n}\n\n/**\n * Props that define the IAM Role that can be assumed by Github Actions workflow\n * via Github OpenID Connect Identity Provider.\n *\n * Besides `GithubConfiguration`, you may pass in any `iam.RoleProps` except `assumedBy`\n * which will be defined by this construct (CDK will fail if you do).\n *\n * @example\n * {\n *   provider: GithubActionsIdentityProvider.fromAccount(scope, \"GithubProvider\"),\n *   owner: 'octo-org',\n *   repo: 'octo-repo',\n *   filter: 'ref:refs/tags/v*',\n *   roleName: 'MyDeployRole',\n * }\n */\nexport interface GithubActionsRoleProps\n  extends GithubConfiguration, RoleProps {}\n\n/**\n * Define an IAM Role that can be assumed by Github Actions workflow\n * via Github OpenID Connect Identity Provider.\n *\n * Besides `GithubConfiguration`, you may pass in any `iam.RoleProps` except `assumedBy`\n * which will be defined by this construct (CDK will fail if you do).\n *\n * @example\n * const uploadRole = new GithubActionsRole(scope, \"UploadRole\", {\n *   provider: GithubActionsIdentityProvider.fromAccount(scope, \"GithubProvider\"),\n *   owner: 'octo-org',\n *   repo: 'octo-repo',\n *   filter: 'ref:refs/tags/v*',\n *   roleName: 'MyUploadRole',\n * });\n *\n * myBucket.grantWrite(uploadRole);\n */\nexport class GithubActionsRole extends iam.Role {\n  /**\n   * Extracts props given for the created IAM Role Construct.\n   * @param props for the GithubActionsRole\n   * @returns for the IAM Role\n   */\n  private static extractRoleProps(\n    props: GithubActionsRoleProps,\n  ): iam.RoleProps {\n    const extractProps = <any>props;\n    delete extractProps.provider;\n    delete extractProps.owner;\n    delete extractProps.repo;\n    delete extractProps.filter;\n    return extractProps;\n  }\n\n  /** Validates the Github owner (organization or user) name. */\n  private static validateOwner(scope: Construct, owner: string): void {\n    if (githubUsernameRegex.test(owner) !== true) {\n      cdk.Annotations.of(scope).addError(\n        `Invalid Github Repository Owner \"${owner}\". Must only contain alphanumeric characters or hyphens, cannot have multiple consecutive hyphens, cannot begin or end with a hypen and maximum lenght is 39 characters.`,\n      );\n    }\n  }\n\n  /** Validates the Github repository name (without owner). */\n  private static validateRepo(scope: Construct, repo: string): void {\n    if (repo === \"\") {\n      cdk.Annotations.of(scope).addError(\n        `Invalid Github Repository Name \"${repo}\". May not be empty string.`,\n      );\n    }\n  }\n\n  /** Formats the `sub` value used in trust policy. */\n  private static formatSubject(props: GithubConfiguration): string {\n    const { owner, repo, filter = \"*\" } = props;\n    return `repo:${owner}/${repo}:${filter}`;\n  }\n\n  /**\n   * Define an IAM Role that can be assumed by Github Actions workflow\n   * via Github OpenID Connect Identity Provider.\n   *\n   * Besides `GithubConfiguration`, you may pass in any `iam.RoleProps` except `assumedBy`\n   * which will be defined by this construct (CDK will fail if you do).\n   *\n   * @example\n   * const uploadRole = new GithubActionsRole(scope, \"UploadRole\", {\n   *   provider: GithubActionsIdentityProvider.fromAccount(scope, \"GithubProvider\"),\n   *   owner: 'octo-org',\n   *   repo: 'octo-repo',\n   *   filter: 'ref:refs/tags/v*',\n   *   roleName: 'MyUploadRole',\n   * });\n   *\n   * myBucket.grantWrite(uploadRole);\n   */\n  constructor(scope: Construct, id: string, props: GithubActionsRoleProps) {\n    const { provider, owner, repo } = props;\n\n    // Perform validations\n    GithubActionsRole.validateOwner(scope, owner);\n    GithubActionsRole.validateRepo(scope, repo);\n\n    // Prepare values\n    const subject = GithubActionsRole.formatSubject(props);\n    const roleProps = GithubActionsRole.extractRoleProps(props);\n\n    // The actual IAM Role creation\n    super(scope, id, {\n      ...roleProps,\n      assumedBy: new iam.WebIdentityPrincipal(provider.oidcProviderArn, {\n        StringLike: {\n          // Only allow specified subjects to assume this role\n          [`${GithubActionsIdentityProvider.issuer}:sub`]: subject,\n        },\n        StringEquals: {\n          // Audience is always sts.amazonaws.com with AWS official Github Action\n          // https://docs.github.com/en/actions/deployment/security-hardening-your-deployments/configuring-openid-connect-in-amazon-web-services#adding-the-identity-provider-to-aws\n          [`${GithubActionsIdentityProvider.issuer}:aud`]: \"sts.amazonaws.com\",\n        },\n      }),\n    });\n  }\n}\n"]}
package/package.json CHANGED
@@ -65,7 +65,7 @@
65
65
  "publishConfig": {
66
66
  "access": "public"
67
67
  },
68
- "version": "4.2.0",
68
+ "version": "4.2.2",
69
69
  "jest": {
70
70
  "coverageProvider": "v8",
71
71
  "testMatch": [