Package io.github.cdklabs.cdkpipelines.github

Interface GitHubWorkflowProps

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.pipelines.PipelineBaseProps
    All Known Implementing Classes:
    GitHubWorkflowProps.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.62.0 (build 293ac17)",
           date="2022-07-16T00:20:23.458Z")
@Stability(Stable)
public interface GitHubWorkflowProps
extends software.amazon.jsii.JsiiSerializable, software.amazon.awscdk.pipelines.PipelineBaseProps
    Props for `GitHubWorkflow`.

    • Method Detail

      • getAwsCredentials

        @Stability(Stable)
@Nullable
default AwsCredentialsSecrets getAwsCredentials()
        Names of GitHub repository secrets that include AWS credentials for deployment.

        Default: - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.

      • getBuildContainer

        @Stability(Stable)
@Nullable
default ContainerOptions getBuildContainer()
        Build container options.

        Default: - GitHub defaults

      • getCdkCliVersion

        @Stability(Stable)
@Nullable
default String getCdkCliVersion()
        Version of the CDK CLI to use.

        Default: - automatic

      • getDockerCredentials

        @Stability(Stable)
@Nullable
default List<DockerCredential> getDockerCredentials()
        The Docker Credentials to use to login.

        If you set this variable, you will be logged in to docker when you upload Docker Assets.

      • getGitHubActionRoleArn

        @Stability(Stable)
@Nullable
default String getGitHubActionRoleArn()
        A role that utilizes the GitHub OIDC Identity Provider in your AWS account.

        If supplied, this will be used instead of awsCredentials.

        You can create your own role in the console with the necessary trust policy to allow gitHub actions from your gitHub repository to assume the role, or you can utilize the GitHubActionRole construct to create a role for you.

        Default: - GitHub repository secrets are used instead of OpenId Connect role.

      • getPostBuildSteps

        @Stability(Stable)
@Nullable
default List<JobStep> getPostBuildSteps()
        GitHub workflow steps to execute after build.

        Default: []

      • getPreBuildSteps

        @Stability(Stable)
@Nullable
default List<JobStep> getPreBuildSteps()
        GitHub workflow steps to execute before build.

        Default: []

      • getPreSynthed

        @Stability(Stable)
@Nullable
default Boolean getPreSynthed()
        Indicates if the repository already contains a synthesized `cdk.out` directory, in which case we will simply checkout the repo in jobs that require `cdk.out`.

        Default: false

      • getPublishAssetsAuthRegion

        @Stability(Stable)
@Nullable
default String getPublishAssetsAuthRegion()
        Will assume the GitHubActionRole in this region when publishing assets.

        This is NOT the region in which the assets are published.

        In most cases, you do not have to worry about this property, and can safely ignore it.

        Default: "us-west-2"

      • getRunner

        @Stability(Stable)
@Nullable
default Runner getRunner()
        The type of runner to run the job on.

        The runner can be either a GitHub-hosted runner or a self-hosted runner.

        Default: Runner.UBUNTU_LATEST

      • getWorkflowName

        @Stability(Stable)
@Nullable
default String getWorkflowName()
        Name of the workflow.

        Default: "deploy"

      • getWorkflowPath

        @Stability(Stable)
@Nullable
default String getWorkflowPath()
        File path for the GitHub workflow.

        Default: ".github/workflows/deploy.yml"

      • getWorkflowTriggers

        @Stability(Stable)
@Nullable
default WorkflowTriggers getWorkflowTriggers()
        GitHub workflow triggers.

        Default: - By default, workflow is triggered on push to the `main` branch and can also be triggered manually (`workflow_dispatch`).