Package io.github.cdklabs.cdkpipelines.github

Interface GitHubActionRoleProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

GitHubActionRoleProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-16T00:20:23.454Z")
@Stability(Stable)
public interface GitHubActionRoleProps
extends software.amazon.jsii.JsiiSerializable

Properties for the GitHubActionRole construct.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static class	GitHubActionRoleProps.Builder	A builder for GitHubActionRoleProps
static class	GitHubActionRoleProps.Jsii$Proxy	An implementation for GitHubActionRoleProps

Method Summary

Modifier and Type	Method	Description
static GitHubActionRoleProps.Builder	builder()
default software.amazon.awscdk.services.iam.IOpenIdConnectProvider	getProvider()	The GitHub OpenId Connect Provider.
List<String>	getRepos()	A list of GitHub repositories you want to be able to access the IAM role.
default String	getRoleName()	The name of the Oidc role.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getRepos

@Stability(Stable)
@NotNull
List<String> getRepos()

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'].

getProvider

@Stability(Stable)
@Nullable
default software.amazon.awscdk.services.iam.IOpenIdConnectProvider getProvider()

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.

getRoleName

@Stability(Stable)
@Nullable
default String getRoleName()

The name of the Oidc role.

Default: 'GitHubActionRole'

builder

@Stability(Stable)
static GitHubActionRoleProps.Builder builder()

Returns:

a GitHubActionRoleProps.Builder of GitHubActionRoleProps