Package io.github.cdklabs.cdkpipelines.github

Class GitHubActionRole.Builder

java.lang.Object

io.github.cdklabs.cdkpipelines.github.GitHubActionRole.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubActionRole>

Enclosing class:

GitHubActionRole

@Stability(Stable)
public static final class GitHubActionRole.Builder
extends Object
implements software.amazon.jsii.Builder<GitHubActionRole>

A fluent builder for GitHubActionRole.

Method Summary

Modifier and Type	Method	Description
GitHubActionRole	build()
static GitHubActionRole.Builder	create(software.constructs.Construct scope, String id)
GitHubActionRole.Builder	provider(software.amazon.awscdk.services.iam.IOpenIdConnectProvider provider)	The GitHub OpenId Connect Provider.
GitHubActionRole.Builder	repos(List<String> repos)	A list of GitHub repositories you want to be able to access the IAM role.
GitHubActionRole.Builder	roleName(String roleName)	The name of the Oidc role.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

create

@Stability(Stable)
public static GitHubActionRole.Builder create(software.constructs.Construct scope,
                                              String id)

Parameters:

scope - This parameter is required.

id - This parameter is required.

Returns:

a new instance of GitHubActionRole.Builder.

repos

@Stability(Stable)
public GitHubActionRole.Builder repos(List<String> repos)

A list of GitHub repositories you want to be able to access the IAM role.

Each entry should be your GitHub username and repository passed in as a single string.

For example, `['owner/repo1', 'owner/repo2'].

Parameters:

repos - A list of GitHub repositories you want to be able to access the IAM role. This parameter is required.

Returns:

this

provider

@Stability(Stable)
public GitHubActionRole.Builder provider(software.amazon.awscdk.services.iam.IOpenIdConnectProvider provider)

The GitHub OpenId Connect Provider. Must have provider url `https://token.actions.githubusercontent.com`. The audience must be `sts:amazonaws.com`.

Only one such provider can be defined per account, so if you already have a provider with the same url, a new provider cannot be created for you.

Default: - a provider is created for you.

Parameters:

provider - The GitHub OpenId Connect Provider. Must have provider url `https://token.actions.githubusercontent.com`. The audience must be `sts:amazonaws.com`. This parameter is required.

Returns:

this

roleName

@Stability(Stable)
public GitHubActionRole.Builder roleName(String roleName)

The name of the Oidc role.

Default: 'GitHubActionRole'

Parameters:

roleName - The name of the Oidc role. This parameter is required.

Returns:

this

build

@Stability(Stable)
public GitHubActionRole build()

Specified by:

build in interface software.amazon.jsii.Builder<GitHubActionRole>