Optional assetsKey prefix to store any assets under.
Optional Readonly awsNames of GitHub repository secrets that include AWS credentials for deployment.
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.Use awsCreds.fromGitHubSecrets() instead.
Optional Readonly awsConfigure provider for AWS credentials used for deployment.
AWS_ACCESS_KEY_ID and AWS_SECRET_ACCESS_KEY.Optional Readonly buildBuild container options.
- GitHub defaults
Optional Readonly cdkVersion of the CDK CLI to use.
- automatic
Optional Readonly dockerThe Docker Credentials to use to login. If you set this variable, you will be logged in to docker when you upload Docker Assets.
Optional Readonly gitA 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.
- GitHub repository secrets are used instead of OpenId Connect role.
Use awsCreds.fromOpenIdConnect() instead.
Optional Readonly jobJob level settings that will be applied to all jobs in the workflow, including synth and asset deploy jobs. Currently the only valid setting is 'if'. You can use this to run jobs only in specific repositories.
Optional patchersAdditional workflow patchers to apply.
Optional Readonly postGitHub workflow steps to execute after build.
[]
Optional postSteps to execute post assets publish.
Optional Readonly preGitHub workflow steps to execute before build.
[]
Optional preSteps to execute prior to assets publish.
Optional Readonly preIndicates 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.
false
Optional Readonly publishWill 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.
"us-west-2"
Optional rootOptional Readonly runnerThe type of runner to run the job on. The runner can be either a GitHub-hosted runner or a self-hosted runner.
Runner.UBUNTU_LATEST
Readonly synthThe build step that produces the CDK Cloud Assembly
The primary output of this step needs to be the cdk.out directory
generated by the cdk synth command.
If you use a ShellStep here and you don't configure an output directory,
the output directory will automatically be assumed to be cdk.out.
Optional Readonly workflowName of the workflow.
"deploy"
Optional Readonly workflowFile path for the GitHub workflow.
".github/workflows/deploy.yml"
Optional Readonly workflowGitHub workflow triggers.
main branch
and can also be triggered manually (workflow_dispatch).Generated using TypeDoc
Bucket to use to store assets.