{"id":16453413,"url":"https://github.com/blimmer/cdk-circleci-oidc","last_synced_at":"2026-02-24T04:05:18.550Z","repository":{"id":75924397,"uuid":"605318900","full_name":"blimmer/cdk-circleci-oidc","owner":"blimmer","description":"AWS CDK construct to create OIDC roles for CircleCI jobs","archived":false,"fork":false,"pushed_at":"2025-01-20T19:37:24.000Z","size":583,"stargazers_count":0,"open_issues_count":3,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-03-18T19:41:56.275Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/blimmer.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-02-22T22:54:03.000Z","updated_at":"2025-01-20T19:34:03.000Z","dependencies_parsed_at":null,"dependency_job_id":"a0c64fd5-2b95-4a11-8c51-c3466dc34f5a","html_url":"https://github.com/blimmer/cdk-circleci-oidc","commit_stats":null,"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimmer%2Fcdk-circleci-oidc","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimmer%2Fcdk-circleci-oidc/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimmer%2Fcdk-circleci-oidc/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/blimmer%2Fcdk-circleci-oidc/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/blimmer","download_url":"https://codeload.github.com/blimmer/cdk-circleci-oidc/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245090740,"owners_count":20559296,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-10-11T10:15:32.614Z","updated_at":"2026-02-24T04:05:13.523Z","avatar_url":"https://github.com/blimmer.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# CircleCI OIDC\n\nThis repository contains constructs to communicate between CircleCI and AWS via an Open ID Connect (OIDC) provider. The\nprocess is described in [this CircleCI blog post](https://circleci.com/blog/openid-connect-identity-tokens/).\n\n## Security Benefits\n\nBy using the OpenID Connect provider, you can communicate with AWS from CircleCI without saving static credentials\n(e.g., `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`) in your CircleCI project settings or a context. Removing static\ncredentials, especially in light of the early 2023 [breach](https://circleci.com/blog/jan-4-2023-incident-report/), is a\nbest practice for security.\n\n## Quick Start\n\nInstall the package:\n\n```bash\nnpm install @blimmer/cdk-circleci-oidc\n\nor\n\nyarn add @blimmer/cdk-circleci-oidc\n```\n\nThen, create the provider and role(s).\n\n```typescript\nimport { Stack, StackProps } from \"aws-cdk-lib\";\nimport { CircleCiOidcProvider, CircleCiOidcRole } from \"@blimmer/cdk-circleci-oidc\";\nimport { Construct } from \"constructs\";\nimport { ManagedPolicy, PolicyStatement } from \"aws-cdk-lib/aws-iam\";\nimport { Bucket } from \"aws-cdk-lib/aws-s3\";\n\nexport class CircleCiStack extends Stack {\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n\n    // The provider is only created _once per AWS account_. It might make sense to define this in a separate stack\n    // that defines more global resources. See below for how to use import the provider in stacks that don't define it.\n    const provider = new CircleCiOidcProvider(this, \"OidcProvider\", {\n      // Find your organization ID in the CircleCI dashboard under \"Organization Settings\"\n      organizationId: \"11111111-2222-3333-4444-555555555555\",\n    });\n\n    const myCircleCiRole = new CircleCiOidcRole(this, \"MyCircleCiRole\", {\n      provider,\n      roleName: \"MyCircleCiRole\",\n\n      // Pass some managed policies to the role\n      managedPolicies: [ManagedPolicy.fromAwsManagedPolicyName(\"AmazonS3ReadOnlyAccess\")],\n    });\n\n    // You can work with the CircleCI role like any other role\n    myCircleCiRole.addToPolicy(\n      new PolicyStatement({\n        actions: [\"s3:ListAllMyBuckets\"],\n        resources: [\"*\"],\n      }),\n    );\n\n    // Including using `.grant` convenience methods\n    const bucket = new Bucket(this, \"MyBucket\");\n    bucket.grantRead(myCircleCiRole);\n  }\n}\n```\n\nNow, in your `.circleci/config.yml` file, you can use the\n[AWS CLI Orb](https://circleci.com/developer/orbs/orb/circleci/aws-cli) to assume your new role.\n\n```yaml\nversion: 2.1\n\norbs:\n  aws-cli: circleci/aws-cli@4.1.0 # https://circleci.com/developer/orbs/orb/circleci/aws-cli\n\nworkflows:\n  version: 2\n  build:\n    jobs:\n      - oidc-job:\n          context: oidc-assumption # You _must_ use a context, even if it doesn't contain any secrets (see https://circleci.com/docs/openid-connect-tokens/#openid-connect-id-token-availability)\n\njobs:\n  oidc-job:\n    docker:\n      - image: cimg/base:stable\n    steps:\n      - checkout\n      # https://circleci.com/developer/orbs/orb/circleci/aws-cli#commands-setup\n      - aws-cli/setup:\n          role_arn: \"arn:aws:iam::123456789101:role/MyCircleCiRole\"\n      - run:\n          name: List S3 Buckets\n          command: aws s3 ls\n```\n\n## Usage in Stacks that Don't Define the Provider\n\nThe `CircleCiOidcProvider` is only created **once per account**. You can use the\n`CircleCiOidcProvider.fromOrganizationId` method to import a previously created provider into any stack.\n\n```typescript\nimport { Stack, StackProps } from \"aws-cdk-lib\";\nimport { CircleCiOidcRole, CircleCiOidcProvider } from \"@blimmer/cdk-circleci-oidc\";\nimport { Construct } from \"constructs\";\n\nexport class MyStack extends Stack {\n  constructor(scope: Construct, id: string, props?: StackProps) {\n    super(scope, id, props);\n\n    const myCircleCiRole = new CircleCiOidcRole(this, \"MyCircleCiRole\", {\n      provider: CircleCiOidcProvider.fromOrganizationId(this, \"11111111-2222-3333-4444-555555555555\"),\n      roleName: \"MyCircleCiRole\",\n    });\n  }\n}\n```\n\n## Usage\n\nFor detailed API docs, see [API.md](/API.md).\n\n## Python\n\nThis package is available for Python as `cdk-circleci-oidc`.\n\n```bash\npip install cdk-circleci-oidc\n```\n\n## Upgrading Between Major Versions\n\nThe API can be expected to change between major versions. Please consult the [UPGRADING docs](/UPGRADING.md) for for\ninformation.\n\n## Contributing\n\nContributions, issues, and feedback are welcome!\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimmer%2Fcdk-circleci-oidc","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fblimmer%2Fcdk-circleci-oidc","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fblimmer%2Fcdk-circleci-oidc/lists"}