Show / Hide Table of Contents

Namespace Amazon.CDK.AWS.CodeBuild

Classes

Artifacts

Artifacts definition for a CodeBuild Project.

ArtifactsConfig

The type returned from IArtifacts#bind.

ArtifactsProps

Properties common to all Artifacts classes.

BatchBuildConfig

The type returned from IProject#enableBatchBuilds.

BindToCodePipelineOptions

The extra options passed to the IProject.bindToCodePipeline method.

BitBucketSourceCredentials

The source credentials used when contacting the BitBucket API.

BitBucketSourceCredentialsProps

Construction properties of BitBucketSourceCredentials.

BitBucketSourceProps

Construction properties for BitBucketSource.

BucketCacheOptions
BuildEnvironment
BuildEnvironmentCertificate

Location of a PEM certificate on S3.

BuildEnvironmentVariable
BuildImageBindOptions

Optional arguments to IBuildImage.binder - currently empty.

BuildImageConfig

The return type from IBuildImage.binder - currently empty.

BuildSpec

BuildSpec for CodeBuild projects.

Cache

Cache options for CodeBuild Project.

CfnFleet

The AWS::CodeBuild::Fleet resource configures a compute fleet, a set of dedicated instances for your build environment.

CfnFleet.ComputeConfigurationProperty

Contains compute attributes.

CfnFleet.FleetProxyRuleProperty

Information about the proxy rule for your reserved capacity instances.

CfnFleet.ProxyConfigurationProperty

Information about the proxy configurations that apply network access control to your reserved capacity instances.

CfnFleet.ScalingConfigurationInputProperty

The scaling configuration input of a compute fleet.

CfnFleet.TargetTrackingScalingConfigurationProperty

Defines when a new instance is auto-scaled into the compute fleet.

CfnFleet.VpcConfigProperty

Information about the VPC configuration that AWS CodeBuild accesses.

CfnFleetProps

Properties for defining a CfnFleet.

CfnProject

The AWS::CodeBuild::Project resource configures how AWS CodeBuild builds your source code.

CfnProject.ArtifactsProperty

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

CfnProject.BatchRestrictionsProperty

Specifies restrictions for the batch build.

CfnProject.BuildStatusConfigProperty

Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.

CfnProject.CloudWatchLogsConfigProperty

CloudWatchLogs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.

CfnProject.DockerServerProperty
CfnProject.EnvironmentProperty

Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.

CfnProject.EnvironmentVariableProperty

EnvironmentVariable is a property of the AWS CodeBuild Project Environment property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. EnvironmentVariable contains a list of EnvironmentVariable property types.

CfnProject.GitSubmodulesConfigProperty

GitSubmodulesConfig is a property of the AWS CodeBuild Project Source property type that specifies information about the Git submodules configuration for the build project.

CfnProject.LogsConfigProperty

LogsConfig is a property of the AWS CodeBuild Project resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.

CfnProject.ProjectBuildBatchConfigProperty

Contains configuration information about a batch build project.

CfnProject.ProjectCacheProperty

ProjectCache is a property of the AWS CodeBuild Project resource that specifies information about the cache for the build project. If ProjectCache is not specified, then both of its properties default to NO_CACHE .

CfnProject.ProjectFileSystemLocationProperty

Information about a file system created by Amazon Elastic File System (EFS).

CfnProject.ProjectFleetProperty

Information about the compute fleet of the build project.

CfnProject.ProjectSourceVersionProperty

A source identifier and its corresponding version.

CfnProject.ProjectTriggersProperty

ProjectTriggers is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.

CfnProject.RegistryCredentialProperty

RegistryCredential is a property of the AWS CodeBuild Project Environment property type that specifies information about credentials that provide access to a private Docker registry. When this is set:.

CfnProject.S3LogsConfigProperty

S3Logs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.

CfnProject.ScopeConfigurationProperty

Contains configuration information about the scope for a webhook.

CfnProject.SourceAuthProperty

SourceAuth is a property of the AWS CodeBuild Project Source property type that specifies authorization settings for AWS CodeBuild to access the source code to be built.

CfnProject.SourceProperty

Source is a property of the AWS::CodeBuild::Project resource that specifies the source code settings for the project, such as the source code's repository type and location.

CfnProject.VpcConfigProperty

VpcConfig is a property of the AWS::CodeBuild::Project resource that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .

CfnProject.WebhookFilterProperty

WebhookFilter is a structure of the FilterGroups property on the AWS CodeBuild Project ProjectTriggers property type that specifies which webhooks trigger an AWS CodeBuild build.

CfnProjectProps

Properties for defining a CfnProject.

CfnReportGroup

Represents a report group.

CfnReportGroup.ReportExportConfigProperty

Information about the location where the run of a report is exported.

CfnReportGroup.S3ReportExportConfigProperty

Information about the S3 bucket where the raw data of a report are exported.

CfnReportGroupProps

Properties for defining a CfnReportGroup.

CfnSourceCredential

Information about the credentials for a GitHub, GitHub Enterprise, or Bitbucket repository.

CfnSourceCredentialProps

Properties for defining a CfnSourceCredential.

CloudWatchLoggingOptions

Information about logs built to a CloudWatch Log Group for a build project.

CodeCommitSourceProps

Construction properties for CodeCommitSource.

CommonProjectProps
ComputeConfiguration

The compute configuration for the fleet.

DockerImageOptions

The options when creating a CodeBuild Docker build image using LinuxBuildImage.fromDockerRegistry, WindowsBuildImage.fromDockerRegistry, or MacBuildImage.fromDockerRegistry.

EfsFileSystemLocationProps

Construction properties for EfsFileSystemLocation.

FileSystemConfig

The type returned from IFileSystemLocation#bind.

FileSystemLocation

FileSystemLocation provider definition for a CodeBuild Project.

FilterGroup

An object that represents a group of filter conditions for a webhook.

Fleet

Fleet for a reserved capacity CodeBuild project.

FleetProps

Construction properties of a CodeBuild {@link Fleet}.

GitHubEnterpriseSourceCredentials

The source credentials used when contacting the GitHub Enterprise API.

GitHubEnterpriseSourceCredentialsProps

Creation properties for GitHubEnterpriseSourceCredentials.

GitHubEnterpriseSourceProps

Construction properties for GitHubEnterpriseSource.

GitHubSourceCredentials

The source credentials used when contacting the GitHub API.

GitHubSourceCredentialsProps

Creation properties for GitHubSourceCredentials.

GitHubSourceProps

Construction properties for GitHubSource and GitHubEnterpriseSource.

LinuxArmBuildImage

A CodeBuild image running aarch64 Linux.

LinuxArmLambdaBuildImage

A CodeBuild image running aarch64 Lambda.

LinuxBuildImage

A CodeBuild image running x86-64 Linux.

LinuxGpuBuildImage

A CodeBuild GPU image running Linux.

LinuxLambdaBuildImage

A CodeBuild image running x86-64 Lambda.

LoggingOptions

Information about logs for the build project.

MacBuildImage

A CodeBuild image running ARM MacOS.

PhaseChangeEvent

Event fields for the CodeBuild "phase change" event.

PipelineProject

A convenience class for CodeBuild Projects that are used in CodePipeline.

PipelineProjectProps
Project

A representation of a CodeBuild Project.

ProjectNotifyOnOptions

Additional options to pass to the notification rule.

ProjectProps
ReportGroup

The ReportGroup resource class.

ReportGroupProps

Construction properties for ReportGroup.

S3ArtifactsProps

Construction properties for S3Artifacts.

S3LoggingOptions

Information about logs built to an S3 bucket for a build project.

S3SourceProps

Construction properties for S3Source.

Source

Source provider definition for a CodeBuild Project.

SourceConfig

The type returned from ISource#bind.

SourceProps

Properties common to all Source classes.

StateChangeEvent

Event fields for the CodeBuild "state change" event.

UntrustedCodeBoundaryPolicy

Permissions Boundary for a CodeBuild Project running untrusted code.

UntrustedCodeBoundaryPolicyProps

Construction properties for UntrustedCodeBoundaryPolicy.

WindowsBuildImage

A CodeBuild image running Windows.

Interfaces

CfnFleet.IComputeConfigurationProperty

Contains compute attributes.

CfnFleet.IFleetProxyRuleProperty

Information about the proxy rule for your reserved capacity instances.

CfnFleet.IProxyConfigurationProperty

Information about the proxy configurations that apply network access control to your reserved capacity instances.

CfnFleet.IScalingConfigurationInputProperty

The scaling configuration input of a compute fleet.

CfnFleet.ITargetTrackingScalingConfigurationProperty

Defines when a new instance is auto-scaled into the compute fleet.

CfnFleet.IVpcConfigProperty

Information about the VPC configuration that AWS CodeBuild accesses.

CfnProject.IArtifactsProperty

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

CfnProject.IBatchRestrictionsProperty

Specifies restrictions for the batch build.

CfnProject.IBuildStatusConfigProperty

Contains information that defines how the AWS CodeBuild build project reports the build status to the source provider.

CfnProject.ICloudWatchLogsConfigProperty

CloudWatchLogs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for CloudWatch logs generated by an AWS CodeBuild build.

CfnProject.IDockerServerProperty
CfnProject.IEnvironmentProperty

Environment is a property of the AWS::CodeBuild::Project resource that specifies the environment for an AWS CodeBuild project.

CfnProject.IEnvironmentVariableProperty

EnvironmentVariable is a property of the AWS CodeBuild Project Environment property type that specifies the name and value of an environment variable for an AWS CodeBuild project environment. When you use the environment to run a build, these variables are available for your builds to use. EnvironmentVariable contains a list of EnvironmentVariable property types.

CfnProject.IGitSubmodulesConfigProperty

GitSubmodulesConfig is a property of the AWS CodeBuild Project Source property type that specifies information about the Git submodules configuration for the build project.

CfnProject.ILogsConfigProperty

LogsConfig is a property of the AWS CodeBuild Project resource that specifies information about logs for a build project. These can be logs in Amazon CloudWatch Logs, built in a specified S3 bucket, or both.

CfnProject.IProjectBuildBatchConfigProperty

Contains configuration information about a batch build project.

CfnProject.IProjectCacheProperty

ProjectCache is a property of the AWS CodeBuild Project resource that specifies information about the cache for the build project. If ProjectCache is not specified, then both of its properties default to NO_CACHE .

CfnProject.IProjectFileSystemLocationProperty

Information about a file system created by Amazon Elastic File System (EFS).

CfnProject.IProjectFleetProperty

Information about the compute fleet of the build project.

CfnProject.IProjectSourceVersionProperty

A source identifier and its corresponding version.

CfnProject.IProjectTriggersProperty

ProjectTriggers is a property of the AWS CodeBuild Project resource that specifies webhooks that trigger an AWS CodeBuild build.

CfnProject.IRegistryCredentialProperty

RegistryCredential is a property of the AWS CodeBuild Project Environment property type that specifies information about credentials that provide access to a private Docker registry. When this is set:.

CfnProject.IS3LogsConfigProperty

S3Logs is a property of the AWS CodeBuild Project LogsConfig property type that specifies settings for logs generated by an AWS CodeBuild build in an S3 bucket.

CfnProject.IScopeConfigurationProperty

Contains configuration information about the scope for a webhook.

CfnProject.ISourceAuthProperty

SourceAuth is a property of the AWS CodeBuild Project Source property type that specifies authorization settings for AWS CodeBuild to access the source code to be built.

CfnProject.ISourceProperty

Source is a property of the AWS::CodeBuild::Project resource that specifies the source code settings for the project, such as the source code's repository type and location.

CfnProject.IVpcConfigProperty

VpcConfig is a property of the AWS::CodeBuild::Project resource that enable AWS CodeBuild to access resources in an Amazon VPC. For more information, see Use AWS CodeBuild with Amazon Virtual Private Cloud in the AWS CodeBuild User Guide .

CfnProject.IWebhookFilterProperty

WebhookFilter is a structure of the FilterGroups property on the AWS CodeBuild Project ProjectTriggers property type that specifies which webhooks trigger an AWS CodeBuild build.

CfnReportGroup.IReportExportConfigProperty

Information about the location where the run of a report is exported.

CfnReportGroup.IS3ReportExportConfigProperty

Information about the S3 bucket where the raw data of a report are exported.

IArtifacts

The abstract interface of a CodeBuild build output.

IArtifactsConfig

The type returned from IArtifacts#bind.

IArtifactsProps

Properties common to all Artifacts classes.

IBatchBuildConfig

The type returned from IProject#enableBatchBuilds.

IBindToCodePipelineOptions

The extra options passed to the IProject.bindToCodePipeline method.

IBindableBuildImage

A variant of IBuildImage that allows binding to the project.

IBitBucketSourceCredentialsProps

Construction properties of BitBucketSourceCredentials.

IBitBucketSourceProps

Construction properties for BitBucketSource.

IBucketCacheOptions
IBuildEnvironment
IBuildEnvironmentCertificate

Location of a PEM certificate on S3.

IBuildEnvironmentVariable
IBuildImage

Represents a Docker image used for the CodeBuild Project builds.

IBuildImageBindOptions

Optional arguments to IBuildImage.binder - currently empty.

IBuildImageConfig

The return type from IBuildImage.binder - currently empty.

ICfnFleetProps

Properties for defining a CfnFleet.

ICfnProjectProps

Properties for defining a CfnProject.

ICfnReportGroupProps

Properties for defining a CfnReportGroup.

ICfnSourceCredentialProps

Properties for defining a CfnSourceCredential.

ICloudWatchLoggingOptions

Information about logs built to a CloudWatch Log Group for a build project.

ICodeCommitSourceProps

Construction properties for CodeCommitSource.

ICommonProjectProps
IComputeConfiguration

The compute configuration for the fleet.

IDockerImageOptions

The options when creating a CodeBuild Docker build image using LinuxBuildImage.fromDockerRegistry, WindowsBuildImage.fromDockerRegistry, or MacBuildImage.fromDockerRegistry.

IEfsFileSystemLocationProps

Construction properties for EfsFileSystemLocation.

IFileSystemConfig

The type returned from IFileSystemLocation#bind.

IFileSystemLocation

The interface of a CodeBuild FileSystemLocation.

IFleet

Represents a {@link Fleet} for a reserved capacity CodeBuild project.

IFleetProps

Construction properties of a CodeBuild {@link Fleet}.

IGitHubEnterpriseSourceCredentialsProps

Creation properties for GitHubEnterpriseSourceCredentials.

IGitHubEnterpriseSourceProps

Construction properties for GitHubEnterpriseSource.

IGitHubSourceCredentialsProps

Creation properties for GitHubSourceCredentials.

IGitHubSourceProps

Construction properties for GitHubSource and GitHubEnterpriseSource.

ILoggingOptions

Information about logs for the build project.

IPipelineProjectProps
IProject
IProjectNotifyOnOptions

Additional options to pass to the notification rule.

IProjectProps
IReportGroup

The interface representing the ReportGroup resource - either an existing one, imported using the ReportGroup.fromReportGroupName method, or a new one, created with the ReportGroup class.

IReportGroupProps

Construction properties for ReportGroup.

IS3ArtifactsProps

Construction properties for S3Artifacts.

IS3LoggingOptions

Information about logs built to an S3 bucket for a build project.

IS3SourceProps

Construction properties for S3Source.

ISource

The abstract interface of a CodeBuild source.

ISourceConfig

The type returned from ISource#bind.

ISourceProps

Properties common to all Source classes.

IUntrustedCodeBoundaryPolicyProps

Construction properties for UntrustedCodeBoundaryPolicy.

Enums

BuildEnvironmentVariableType
ComputeType

Build machine compute type.

EnvironmentType

Build environment type.

EventAction

The types of webhook event actions.

FleetComputeType

Fleet build machine compute type. Subset of Fleet compatible {@link ComputeType} values.

ImagePullPrincipalType

The type of principal CodeBuild will use to pull your build Docker image.

LocalCacheMode

Local cache modes to enable for the CodeBuild Project.

MachineType

The compute type of the fleet.

ProjectNotificationEvents

The list of event types for AWS Codebuild.

ProjectVisibility

Specifies the visibility of the project's builds.

ReportGroupType

The type of reports in the report group.

WindowsImageType

Environment type for Windows Docker images.

Back to top Generated by DocFX