Package io.github.cdklabs.cdkpipelines.github

Class GitHubActionRoleProps.Builder

java.lang.Object

io.github.cdklabs.cdkpipelines.github.GitHubActionRoleProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<GitHubActionRoleProps>

Enclosing interface:

GitHubActionRoleProps

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

A builder for GitHubActionRoleProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
GitHubActionRoleProps	build()	Builds the configured instance.
GitHubActionRoleProps.Builder	provider(software.amazon.awscdk.services.iam.IOpenIdConnectProvider provider)	Sets the value of GitHubActionRoleProps.getProvider()
GitHubActionRoleProps.Builder	repos(List<String> repos)	Sets the value of GitHubActionRoleProps.getRepos()
GitHubActionRoleProps.Builder	roleName(String roleName)	Sets the value of GitHubActionRoleProps.getRoleName()

Methods inherited from class java.lang.Object

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

Constructor Detail

Builder

public Builder()

Method Detail

repos

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

Sets the value of GitHubActionRoleProps.getRepos()

Parameters:

repos - A list of GitHub repositories you want to be able to access the IAM role. This parameter is required. Each entry should be your GitHub username and repository passed in as a single string.

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

Returns:

this

provider

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

Sets the value of GitHubActionRoleProps.getProvider()

Parameters:

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.

Returns:

this

roleName

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

Sets the value of GitHubActionRoleProps.getRoleName()

Parameters:

roleName - The name of the Oidc role.

Returns:

this

build

@Stability(Stable)
public GitHubActionRoleProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of GitHubActionRoleProps

Throws:

NullPointerException - if any required attribute was not provided