Github Actions as OpenID Connect Identity Provider for AWS IAM. There can be only one (per AWS Account).
Use fromAccount to retrieve a reference to existing Github OIDC provider.
import { GithubActionsIdentityProvider } from 'aws-cdk-github-oidc'
new GithubActionsIdentityProvider(scope: Construct, id: string)- Type:
constructs.Construct
CDK Stack or Construct to which the provider is assigned to.
- Type:
string
CDK Construct ID given to the construct.
import { GithubActionsIdentityProvider } from 'aws-cdk-github-oidc'
GithubActionsIdentityProvider.fromAccount(scope: Construct, id: string)- Type:
constructs.Construct
CDK Stack or Construct to which the provider is assigned to.
- Type:
string
CDK Construct ID given to the construct.
- Type:
string
Define an IAM Role that can be assumed by Github Actions workflow via Github OpenID Connect Identity Provider.
Besides GithubConfiguration, you may pass in any iam.RoleProps except assumedBy
which will be defined by this construct (CDK will fail if you do).
import { GithubActionsRole } from 'aws-cdk-github-oidc'
new GithubActionsRole(scope: Construct, id: string, props: GithubActionsRoleProps)- Type:
constructs.Construct
- Type:
string
Props that define the IAM Role that can be assumed by Github Actions workflow via Github OpenID Connect Identity Provider.
Besides GithubConfiguration, you may pass in any iam.RoleProps except assumedBy
which will be defined by this construct (CDK will fail if you do).
import { GithubActionsRoleProps } from 'aws-cdk-github-oidc'
const githubActionsRoleProps: GithubActionsRoleProps = { ... }public readonly owner: string;- Type:
string
Repository owner (organization or username).
public readonly provider: IGithubActionsIdentityProvider;Reference to Github OpenID Connect Provider configured in AWS IAM.
Either pass an construct defined by new GithubActionsIdentityProvider
or a retrieved reference from GithubActionsIdentityProvider.fromAccount.
There can be only one (per AWS Account).
public readonly repo: string;- Type:
string
Repository name (slug) without the owner.
public readonly filter: string;- Type:
string - Default: '*'
You may use this value to only allow Github to assume the role on specific branches, tags, environments, pull requests etc.
Subject condition filter, appended after repo:${owner}/${repo}: string in IAM Role trust relationship.
public readonly description: string;- Type:
string - Default: No description.
A description of the role.
It can be up to 1000 characters long.
public readonly externalIds: string[];- Type:
string[] - Default: No external ID required
List of IDs that the role assumer needs to provide one of when assuming this role.
If the configured and provided external IDs do not match, the AssumeRole operation will fail.
public readonly inlinePolicies: {[ key: string ]: PolicyDocument};- Type: {[ key: string ]:
aws-cdk-lib.aws_iam.PolicyDocument} - Default: No policy is inlined in the Role resource.
A list of named policies to inline into this role.
These policies will be
created with the role, whereas those added by addToPolicy are added
using a separate CloudFormation resource (allowing a way around circular
dependencies that could otherwise be introduced).
public readonly managedPolicies: IManagedPolicy[];- Type:
aws-cdk-lib.aws_iam.IManagedPolicy[] - Default: No managed policies.
A list of managed policies associated with this role.
You can add managed policies later using
addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).
public readonly maxSessionDuration: Duration;- Type:
aws-cdk-lib.Duration - Default: Duration.hours(1)
The maximum session duration that you want to set for the specified role.
This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.
Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
public readonly path: string;- Type:
string - Default: /
The path associated with this role.
For information about IAM paths, see Friendly Names and Paths in IAM User Guide.
public readonly permissionsBoundary: IManagedPolicy;- Type:
aws-cdk-lib.aws_iam.IManagedPolicy - Default: No permissions boundary.
AWS supports permissions boundaries for IAM entities (users or roles).
A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html
public readonly roleName: string;- Type:
string - Default: AWS CloudFormation generates a unique physical ID and uses that ID for the role name.
A name for the IAM role.
For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.
IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
Github related configuration that forms the trust policy for this IAM Role.
import { GithubConfiguration } from 'aws-cdk-github-oidc'
const githubConfiguration: GithubConfiguration = { ... }public readonly owner: string;- Type:
string
Repository owner (organization or username).
public readonly provider: IGithubActionsIdentityProvider;Reference to Github OpenID Connect Provider configured in AWS IAM.
Either pass an construct defined by new GithubActionsIdentityProvider
or a retrieved reference from GithubActionsIdentityProvider.fromAccount.
There can be only one (per AWS Account).
public readonly repo: string;- Type:
string
Repository name (slug) without the owner.
public readonly filter: string;- Type:
string - Default: '*'
You may use this value to only allow Github to assume the role on specific branches, tags, environments, pull requests etc.
Subject condition filter, appended after repo:${owner}/${repo}: string in IAM Role trust relationship.
Properties for defining an IAM Role.
These are copied fron @aws-cdk/aws-iam, but since JSII does not support TypeScript <Partial<iam.RoleProps>> (or Omit), we have to do this stupid thing.
Basically exactly the same as source, but with assumedBy removed.
import { RoleProps } from 'aws-cdk-github-oidc'
const roleProps: RoleProps = { ... }public readonly description: string;- Type:
string - Default: No description.
A description of the role.
It can be up to 1000 characters long.
public readonly externalIds: string[];- Type:
string[] - Default: No external ID required
List of IDs that the role assumer needs to provide one of when assuming this role.
If the configured and provided external IDs do not match, the AssumeRole operation will fail.
public readonly inlinePolicies: {[ key: string ]: PolicyDocument};- Type: {[ key: string ]:
aws-cdk-lib.aws_iam.PolicyDocument} - Default: No policy is inlined in the Role resource.
A list of named policies to inline into this role.
These policies will be
created with the role, whereas those added by addToPolicy are added
using a separate CloudFormation resource (allowing a way around circular
dependencies that could otherwise be introduced).
public readonly managedPolicies: IManagedPolicy[];- Type:
aws-cdk-lib.aws_iam.IManagedPolicy[] - Default: No managed policies.
A list of managed policies associated with this role.
You can add managed policies later using
addManagedPolicy(ManagedPolicy.fromAwsManagedPolicyName(policyName)).
public readonly maxSessionDuration: Duration;- Type:
aws-cdk-lib.Duration - Default: Duration.hours(1)
The maximum session duration that you want to set for the specified role.
This setting can have a value from 1 hour (3600sec) to 12 (43200sec) hours.
Anyone who assumes the role from the AWS CLI or API can use the DurationSeconds API parameter or the duration-seconds CLI parameter to request a longer session. The MaxSessionDuration setting determines the maximum duration that can be requested using the DurationSeconds parameter.
If users don't specify a value for the DurationSeconds parameter, their security credentials are valid for one hour by default. This applies when you use the AssumeRole* API operations or the assume-role* CLI operations but does not apply when you use those operations to create a console URL.
https://docs.aws.amazon.com/IAM/latest/UserGuide/id_roles_use.html
public readonly path: string;- Type:
string - Default: /
The path associated with this role.
For information about IAM paths, see Friendly Names and Paths in IAM User Guide.
public readonly permissionsBoundary: IManagedPolicy;- Type:
aws-cdk-lib.aws_iam.IManagedPolicy - Default: No permissions boundary.
AWS supports permissions boundaries for IAM entities (users or roles).
A permissions boundary is an advanced feature for using a managed policy to set the maximum permissions that an identity-based policy can grant to an IAM entity. An entity's permissions boundary allows it to perform only the actions that are allowed by both its identity-based policies and its permissions boundaries.
https://docs.aws.amazon.com/IAM/latest/UserGuide/access_policies_boundaries.html
public readonly roleName: string;- Type:
string - Default: AWS CloudFormation generates a unique physical ID and uses that ID for the role name.
A name for the IAM role.
For valid values, see the RoleName parameter for the CreateRole action in the IAM API Reference.
IMPORTANT: If you specify a name, you cannot perform updates that require replacement of this resource. You can perform updates that require no or some interruption. If you must replace the resource, specify a new name.
If you specify a name, you must specify the CAPABILITY_NAMED_IAM value to acknowledge your template's capabilities. For more information, see Acknowledging IAM Resources in AWS CloudFormation Templates.
-
Implemented By:
aws-cdk-github-oidc.GithubActionsIdentityProvider,aws-cdk-github-oidc.IGithubActionsIdentityProvider
Describes a Github OpenID Connect Identity Provider for AWS IAM.
public readonly node: Node;- Type:
constructs.Node
The tree node.
public readonly env: ResourceEnvironment;The environment this resource belongs to.
For resources that are created and managed by the CDK (generally, those created by creating new class instances like Role, Bucket, etc.), this is always the same as the environment of the stack they belong to; however, for imported resources (those obtained from static methods like fromRoleArn, fromBucketName, etc.), that might be different than the stack they were imported into.
public readonly stack: Stack;- Type:
aws-cdk-lib.Stack
The stack in which this resource is defined.
public readonly openIdConnectProviderArn: string;- Type:
string
The Amazon Resource Name (ARN) of the IAM OpenID Connect provider.
public readonly openIdConnectProviderIssuer: string;- Type:
string
The issuer for OIDC Provider.