Package io.github.cdklabs.cdkpipelines.github

Class GitHubWorkflowProps.Jsii$Proxy

java.lang.Object

software.amazon.jsii.JsiiObject

io.github.cdklabs.cdkpipelines.github.GitHubWorkflowProps.Jsii$Proxy

All Implemented Interfaces:

GitHubWorkflowProps, software.amazon.awscdk.pipelines.PipelineBaseProps, software.amazon.jsii.JsiiSerializable

Enclosing interface:

GitHubWorkflowProps

@Stability(Stable)
@Internal
public static final class GitHubWorkflowProps.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements GitHubWorkflowProps

An implementation for GitHubWorkflowProps

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

Nested classes/interfaces inherited from interface io.github.cdklabs.cdkpipelines.github.GitHubWorkflowProps

GitHubWorkflowProps.Builder, GitHubWorkflowProps.Jsii$Proxy

Constructor Summary

Constructors

Modifier	Constructor	Description
protected	Jsii$Proxy(GitHubWorkflowProps.Builder builder)	Constructor that initializes the object based on literal property values passed by the GitHubWorkflowProps.Builder.
protected	Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)	Constructor that initializes the object based on values retrieved from the JsiiObject.

Method Summary

Modifier and Type	Method	Description
com.fasterxml.jackson.databind.JsonNode	$jsii$toJson()
boolean	equals(Object o)
AwsCredentialsSecrets	getAwsCredentials()	Names of GitHub repository secrets that include AWS credentials for deployment.
ContainerOptions	getBuildContainer()	Build container options.
String	getCdkCliVersion()	Version of the CDK CLI to use.
List<DockerCredential>	getDockerCredentials()	The Docker Credentials to use to login.
String	getGitHubActionRoleArn()	A role that utilizes the GitHub OIDC Identity Provider in your AWS account.
List<JobStep>	getPostBuildSteps()	GitHub workflow steps to execute after build.
List<JobStep>	getPreBuildSteps()	GitHub workflow steps to execute before build.
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`.
String	getPublishAssetsAuthRegion()	Will assume the GitHubActionRole in this region when publishing assets.
Runner	getRunner()	The type of runner to run the job on.
software.amazon.awscdk.pipelines.IFileSetProducer	getSynth()
String	getWorkflowName()	Name of the workflow.
String	getWorkflowPath()	File path for the GitHub workflow.
WorkflowTriggers	getWorkflowTriggers()	GitHub workflow triggers.
int	hashCode()

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Constructor Detail

Jsii$Proxy

protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)

Constructor that initializes the object based on values retrieved from the JsiiObject.

Parameters:

objRef - Reference to the JSII managed object.

Jsii$Proxy

protected Jsii$Proxy(GitHubWorkflowProps.Builder builder)

Constructor that initializes the object based on literal property values passed by the GitHubWorkflowProps.Builder.

Method Detail

getAwsCredentials

public final AwsCredentialsSecrets getAwsCredentials()

Description copied from interface: GitHubWorkflowProps

Names of GitHub repository secrets that include AWS credentials for deployment.

Default: - `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.

Specified by:

getAwsCredentials in interface GitHubWorkflowProps

getBuildContainer

public final ContainerOptions getBuildContainer()

Description copied from interface: GitHubWorkflowProps

Build container options.

Default: - GitHub defaults

Specified by:

getBuildContainer in interface GitHubWorkflowProps

getCdkCliVersion

public final String getCdkCliVersion()

Description copied from interface: GitHubWorkflowProps

Version of the CDK CLI to use.

Default: - automatic

Specified by:

getCdkCliVersion in interface GitHubWorkflowProps

getDockerCredentials

public final List<DockerCredential> getDockerCredentials()

Description copied from interface: GitHubWorkflowProps

The Docker Credentials to use to login.

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

Specified by:

getDockerCredentials in interface GitHubWorkflowProps

getGitHubActionRoleArn

public final String getGitHubActionRoleArn()

Description copied from interface: GitHubWorkflowProps

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.

Specified by:

getGitHubActionRoleArn in interface GitHubWorkflowProps

getPostBuildSteps

public final List<JobStep> getPostBuildSteps()

Description copied from interface: GitHubWorkflowProps

GitHub workflow steps to execute after build.

Default: []

Specified by:

getPostBuildSteps in interface GitHubWorkflowProps

getPreBuildSteps

public final List<JobStep> getPreBuildSteps()

Description copied from interface: GitHubWorkflowProps

GitHub workflow steps to execute before build.

Default: []

Specified by:

getPreBuildSteps in interface GitHubWorkflowProps

getPreSynthed

public final Boolean getPreSynthed()

Description copied from interface: GitHubWorkflowProps

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

Specified by:

getPreSynthed in interface GitHubWorkflowProps

getPublishAssetsAuthRegion

public final String getPublishAssetsAuthRegion()

Description copied from interface: GitHubWorkflowProps

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"

Specified by:

getPublishAssetsAuthRegion in interface GitHubWorkflowProps

getRunner

public final Runner getRunner()

Description copied from interface: GitHubWorkflowProps

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

Specified by:

getRunner in interface GitHubWorkflowProps

getWorkflowName

public final String getWorkflowName()

Description copied from interface: GitHubWorkflowProps

Name of the workflow.

Default: "deploy"

Specified by:

getWorkflowName in interface GitHubWorkflowProps

getWorkflowPath

public final String getWorkflowPath()

Description copied from interface: GitHubWorkflowProps

File path for the GitHub workflow.

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

Specified by:

getWorkflowPath in interface GitHubWorkflowProps

getWorkflowTriggers

public final WorkflowTriggers getWorkflowTriggers()

Description copied from interface: GitHubWorkflowProps

GitHub workflow triggers.

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

Specified by:

getWorkflowTriggers in interface GitHubWorkflowProps

getSynth

public final software.amazon.awscdk.pipelines.IFileSetProducer getSynth()

Specified by:

getSynth in interface software.amazon.awscdk.pipelines.PipelineBaseProps

$jsii$toJson

@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()

Specified by:

$jsii$toJson in interface software.amazon.jsii.JsiiSerializable

equals

public final boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public final int hashCode()

Overrides:

hashCode in class Object