Request a Change

codebuild¶

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-aws repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-aws repo.

class pulumi_aws.codebuild.Project(resource_name, opts=None, artifacts=None, badge_enabled=None, build_timeout=None, cache=None, description=None, encryption_key=None, environment=None, logs_config=None, name=None, secondary_artifacts=None, secondary_sources=None, service_role=None, source=None, tags=None, vpc_config=None, __props__=None, __name__=None, __opts__=None)¶

Provides a CodeBuild Project resource. See also the ``codebuild.Webhook` resource <https://www.terraform.io/docs/providers/aws/r/codebuild_webhook.html>`_, which manages the webhook to the source (e.g. the “rebuild every time a code change is pushed” option in the CodeBuild web console).

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
artifacts (pulumi.Input[dict]) – Information about the project’s build output artifacts. Artifact blocks are documented below.
badge_enabled (pulumi.Input[bool]) – Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled.
build_timeout (pulumi.Input[float]) – How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
cache (pulumi.Input[dict]) – Information about the cache storage for the project. Cache blocks are documented below.
description (pulumi.Input[str]) – A short description of the project.
encryption_key (pulumi.Input[str]) – The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project’s build output artifacts.
environment (pulumi.Input[dict]) – Information about the project’s build environment. Environment blocks are documented below.
logs_config (pulumi.Input[dict]) – Configuration for the builds to store log data to CloudWatch or S3.
name (pulumi.Input[str]) – The name of the project. If type is set to S3, this is the name of the output artifact object
secondary_artifacts (pulumi.Input[list]) – A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below.
secondary_sources (pulumi.Input[list]) – A set of secondary sources to be used inside the build. Secondary sources blocks are documented below.
service_role (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
source (pulumi.Input[dict]) – Information about the project’s input source code. Source blocks are documented below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpc_config (pulumi.Input[dict]) – Configuration for the builds to run inside a VPC. VPC config blocks are documented below.

The artifacts object supports the following:

artifactIdentifier (pulumi.Input[str]) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (pulumi.Input[str]) - The location of the source code from git or s3.
name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (pulumi.Input[str]) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (pulumi.Input[bool]) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (pulumi.Input[str]) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (pulumi.Input[str]) - If type is set to S3, this is the path to the output artifact
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The cache object supports the following:

location (pulumi.Input[str]) - The location of the source code from git or s3.
modes (pulumi.Input[list]) - Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: LOCAL_SOURCE_CACHE, LOCAL_DOCKER_LAYER_CACHE, and LOCAL_CUSTOM_CACHE
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The environment object supports the following:

certificate (pulumi.Input[str]) - The ARN of the S3 bucket, path prefix and object key that contains the PEM-encoded certificate.
computeType (pulumi.Input[str]) - Information about the compute resources the build project will use. Available values for this parameter are: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM or BUILD_GENERAL1_LARGE. BUILD_GENERAL1_SMALL is only valid if type is set to LINUX_CONTAINER
environmentVariables (pulumi.Input[list]) - A set of environment variables to make available to builds for this build project.
- name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
- value (pulumi.Input[str]) - The environment variable’s value.
image (pulumi.Input[str]) - The Docker image to use for this build project. Valid values include Docker images provided by CodeBuild (e.g aws/codebuild/standard:2.0), Docker Hub images (e.g. nginx:latest), and full Docker repository URIs such as those for ECR (e.g. 137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest).
imagePullCredentialsType (pulumi.Input[str]) - The type of credentials AWS CodeBuild uses to pull images in your build. Available values for this parameter are CODEBUILD or SERVICE_ROLE. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. Default to CODEBUILD
privilegedMode (pulumi.Input[bool]) - If set to true, enables running the Docker daemon inside a Docker container. Defaults to false.
registryCredential (pulumi.Input[dict]) - Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below.
- credential (pulumi.Input[str]) - The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
- credentialProvider (pulumi.Input[str]) - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The logs_config object supports the following:

cloudwatchLogs (pulumi.Input[dict]) - Configuration for the builds to store logs to CloudWatch
- groupName (pulumi.Input[str]) - The group name of the logs in CloudWatch Logs.
- status (pulumi.Input[str]) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.
- streamName (pulumi.Input[str]) - The stream name of the logs in CloudWatch Logs.
s3Logs (pulumi.Input[dict]) - Configuration for the builds to store logs to S3.
- encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
- location (pulumi.Input[str]) - The location of the source code from git or s3.
- status (pulumi.Input[str]) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.

The secondary_artifacts object supports the following:

artifactIdentifier (pulumi.Input[str]) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (pulumi.Input[str]) - The location of the source code from git or s3.
name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (pulumi.Input[str]) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (pulumi.Input[bool]) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (pulumi.Input[str]) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (pulumi.Input[str]) - If type is set to S3, this is the path to the output artifact
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The secondary_sources object supports the following:

auths (pulumi.Input[list]) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (pulumi.Input[str]) - The resource value that applies to the specified authorization type.
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (pulumi.Input[str]) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (pulumi.Input[float]) - Truncate git history to this many commits.
insecureSsl (pulumi.Input[bool]) - Ignore SSL warnings when connecting to source control.
location (pulumi.Input[str]) - The location of the source code from git or s3.
reportBuildStatus (pulumi.Input[bool]) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
sourceIdentifier (pulumi.Input[str]) - The source identifier. Source data will be put inside a folder named as this parameter inside AWS CodeBuild source directory
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The source object supports the following:

auths (pulumi.Input[list]) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (pulumi.Input[str]) - The resource value that applies to the specified authorization type.
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (pulumi.Input[str]) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (pulumi.Input[float]) - Truncate git history to this many commits.
insecureSsl (pulumi.Input[bool]) - Ignore SSL warnings when connecting to source control.
location (pulumi.Input[str]) - The location of the source code from git or s3.
reportBuildStatus (pulumi.Input[bool]) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The vpc_config object supports the following:

securityGroupIds (pulumi.Input[list]) - The security group IDs to assign to running builds.
subnets (pulumi.Input[list]) - The subnet IDs within which to run builds.
vpc_id (pulumi.Input[str]) - The ID of the VPC within which to run builds.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_project.html.markdown.

arn = None¶: The ARN of the CodeBuild project.

artifacts = None¶

Information about the project’s build output artifacts. Artifact blocks are documented below.

artifactIdentifier (str) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (bool) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (str) - The location of the source code from git or s3.
name (str) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (str) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (bool) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (str) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (str) - If type is set to S3, this is the path to the output artifact
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

badge_enabled = None¶: Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled.

badge_url = None¶: The URL of the build badge when badge_enabled is enabled.

build_timeout = None¶: How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.

cache = None¶

Information about the cache storage for the project. Cache blocks are documented below.

location (str) - The location of the source code from git or s3.
modes (list) - Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: LOCAL_SOURCE_CACHE, LOCAL_DOCKER_LAYER_CACHE, and LOCAL_CUSTOM_CACHE
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

description = None¶: A short description of the project.

encryption_key = None¶: The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project’s build output artifacts.

environment = None¶

Information about the project’s build environment. Environment blocks are documented below.

certificate (str) - The ARN of the S3 bucket, path prefix and object key that contains the PEM-encoded certificate.
computeType (str) - Information about the compute resources the build project will use. Available values for this parameter are: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM or BUILD_GENERAL1_LARGE. BUILD_GENERAL1_SMALL is only valid if type is set to LINUX_CONTAINER
environmentVariables (list) - A set of environment variables to make available to builds for this build project.
- name (str) - The name of the project. If type is set to S3, this is the name of the output artifact object
- type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
- value (str) - The environment variable’s value.
image (str) - The Docker image to use for this build project. Valid values include Docker images provided by CodeBuild (e.g aws/codebuild/standard:2.0), Docker Hub images (e.g. nginx:latest), and full Docker repository URIs such as those for ECR (e.g. 137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest).
imagePullCredentialsType (str) - The type of credentials AWS CodeBuild uses to pull images in your build. Available values for this parameter are CODEBUILD or SERVICE_ROLE. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. Default to CODEBUILD
privilegedMode (bool) - If set to true, enables running the Docker daemon inside a Docker container. Defaults to false.
registryCredential (dict) - Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below.
- credential (str) - The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
- credentialProvider (str) - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

logs_config = None¶

Configuration for the builds to store log data to CloudWatch or S3.

cloudwatchLogs (dict) - Configuration for the builds to store logs to CloudWatch
- groupName (str) - The group name of the logs in CloudWatch Logs.
- status (str) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.
- streamName (str) - The stream name of the logs in CloudWatch Logs.
s3Logs (dict) - Configuration for the builds to store logs to S3.
- encryptionDisabled (bool) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
- location (str) - The location of the source code from git or s3.
- status (str) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.

name = None¶: The name of the project. If type is set to S3, this is the name of the output artifact object

secondary_artifacts = None¶

A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below.

artifactIdentifier (str) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (bool) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (str) - The location of the source code from git or s3.
name (str) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (str) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (bool) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (str) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (str) - If type is set to S3, this is the path to the output artifact
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

secondary_sources = None¶

A set of secondary sources to be used inside the build. Secondary sources blocks are documented below.

auths (list) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (str) - The resource value that applies to the specified authorization type.
- type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (str) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (float) - Truncate git history to this many commits.
insecureSsl (bool) - Ignore SSL warnings when connecting to source control.
location (str) - The location of the source code from git or s3.
reportBuildStatus (bool) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
sourceIdentifier (str) - The source identifier. Source data will be put inside a folder named as this parameter inside AWS CodeBuild source directory
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

service_role = None¶: The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

source = None¶

Information about the project’s input source code. Source blocks are documented below.

auths (list) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (str) - The resource value that applies to the specified authorization type.
- type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (str) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (float) - Truncate git history to this many commits.
insecureSsl (bool) - Ignore SSL warnings when connecting to source control.
location (str) - The location of the source code from git or s3.
reportBuildStatus (bool) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
type (str) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

tags = None¶: A mapping of tags to assign to the resource.

vpc_config = None¶

Configuration for the builds to run inside a VPC. VPC config blocks are documented below.

securityGroupIds (list) - The security group IDs to assign to running builds.
subnets (list) - The subnet IDs within which to run builds.
vpc_id (str) - The ID of the VPC within which to run builds.

static get(resource_name, id, opts=None, arn=None, artifacts=None, badge_enabled=None, badge_url=None, build_timeout=None, cache=None, description=None, encryption_key=None, environment=None, logs_config=None, name=None, secondary_artifacts=None, secondary_sources=None, service_role=None, source=None, tags=None, vpc_config=None)¶

Get an existing Project resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of the CodeBuild project.
artifacts (pulumi.Input[dict]) – Information about the project’s build output artifacts. Artifact blocks are documented below.
badge_enabled (pulumi.Input[bool]) – Generates a publicly-accessible URL for the projects build badge. Available as badge_url attribute when enabled.
badge_url (pulumi.Input[str]) – The URL of the build badge when badge_enabled is enabled.
build_timeout (pulumi.Input[float]) – How long in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait until timing out any related build that does not get marked as completed. The default is 60 minutes.
cache (pulumi.Input[dict]) – Information about the cache storage for the project. Cache blocks are documented below.
description (pulumi.Input[str]) – A short description of the project.
encryption_key (pulumi.Input[str]) – The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project’s build output artifacts.
environment (pulumi.Input[dict]) – Information about the project’s build environment. Environment blocks are documented below.
logs_config (pulumi.Input[dict]) – Configuration for the builds to store log data to CloudWatch or S3.
name (pulumi.Input[str]) – The name of the project. If type is set to S3, this is the name of the output artifact object
secondary_artifacts (pulumi.Input[list]) – A set of secondary artifacts to be used inside the build. Secondary artifacts blocks are documented below.
secondary_sources (pulumi.Input[list]) – A set of secondary sources to be used inside the build. Secondary sources blocks are documented below.
service_role (pulumi.Input[str]) – The Amazon Resource Name (ARN) of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
source (pulumi.Input[dict]) – Information about the project’s input source code. Source blocks are documented below.
tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.
vpc_config (pulumi.Input[dict]) – Configuration for the builds to run inside a VPC. VPC config blocks are documented below.

The artifacts object supports the following:

artifactIdentifier (pulumi.Input[str]) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (pulumi.Input[str]) - The location of the source code from git or s3.
name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (pulumi.Input[str]) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (pulumi.Input[bool]) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (pulumi.Input[str]) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (pulumi.Input[str]) - If type is set to S3, this is the path to the output artifact
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The cache object supports the following:

location (pulumi.Input[str]) - The location of the source code from git or s3.
modes (pulumi.Input[list]) - Specifies settings that AWS CodeBuild uses to store and reuse build dependencies. Valid values: LOCAL_SOURCE_CACHE, LOCAL_DOCKER_LAYER_CACHE, and LOCAL_CUSTOM_CACHE
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The environment object supports the following:

certificate (pulumi.Input[str]) - The ARN of the S3 bucket, path prefix and object key that contains the PEM-encoded certificate.
computeType (pulumi.Input[str]) - Information about the compute resources the build project will use. Available values for this parameter are: BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM or BUILD_GENERAL1_LARGE. BUILD_GENERAL1_SMALL is only valid if type is set to LINUX_CONTAINER
environmentVariables (pulumi.Input[list]) - A set of environment variables to make available to builds for this build project.
- name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
- value (pulumi.Input[str]) - The environment variable’s value.
image (pulumi.Input[str]) - The Docker image to use for this build project. Valid values include Docker images provided by CodeBuild (e.g aws/codebuild/standard:2.0), Docker Hub images (e.g. nginx:latest), and full Docker repository URIs such as those for ECR (e.g. 137112412989.dkr.ecr.us-west-2.amazonaws.com/amazonlinux:latest).
imagePullCredentialsType (pulumi.Input[str]) - The type of credentials AWS CodeBuild uses to pull images in your build. Available values for this parameter are CODEBUILD or SERVICE_ROLE. When you use a cross-account or private registry image, you must use SERVICE_ROLE credentials. When you use an AWS CodeBuild curated image, you must use CODEBUILD credentials. Default to CODEBUILD
privilegedMode (pulumi.Input[bool]) - If set to true, enables running the Docker daemon inside a Docker container. Defaults to false.
registryCredential (pulumi.Input[dict]) - Information about credentials for access to a private Docker registry. Registry Credential config blocks are documented below.
- credential (pulumi.Input[str]) - The Amazon Resource Name (ARN) or name of credentials created using AWS Secrets Manager.
- credentialProvider (pulumi.Input[str]) - The service that created the credentials to access a private Docker registry. The valid value, SECRETS_MANAGER, is for AWS Secrets Manager.
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The logs_config object supports the following:

cloudwatchLogs (pulumi.Input[dict]) - Configuration for the builds to store logs to CloudWatch
- groupName (pulumi.Input[str]) - The group name of the logs in CloudWatch Logs.
- status (pulumi.Input[str]) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.
- streamName (pulumi.Input[str]) - The stream name of the logs in CloudWatch Logs.
s3Logs (pulumi.Input[dict]) - Configuration for the builds to store logs to S3.
- encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
- location (pulumi.Input[str]) - The location of the source code from git or s3.
- status (pulumi.Input[str]) - Current status of logs in S3 for a build project. Valid values: ENABLED, DISABLED. Defaults to DISABLED.

The secondary_artifacts object supports the following:

artifactIdentifier (pulumi.Input[str]) - The artifact identifier. Must be the same specified inside AWS CodeBuild buildspec.
encryptionDisabled (pulumi.Input[bool]) - If set to true, output artifacts will not be encrypted. If type is set to NO_ARTIFACTS then this value will be ignored. Defaults to false.
location (pulumi.Input[str]) - The location of the source code from git or s3.
name (pulumi.Input[str]) - The name of the project. If type is set to S3, this is the name of the output artifact object
namespaceType (pulumi.Input[str]) - The namespace to use in storing build artifacts. If type is set to S3, then valid values for this parameter are: BUILD_ID or NONE.
overrideArtifactName (pulumi.Input[bool]) - If set to true, a name specified in the build spec file overrides the artifact name.
packaging (pulumi.Input[str]) - The type of build output artifact to create. If type is set to S3, valid values for this parameter are: NONE or ZIP
path (pulumi.Input[str]) - If type is set to S3, this is the path to the output artifact
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The secondary_sources object supports the following:

auths (pulumi.Input[list]) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (pulumi.Input[str]) - The resource value that applies to the specified authorization type.
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (pulumi.Input[str]) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (pulumi.Input[float]) - Truncate git history to this many commits.
insecureSsl (pulumi.Input[bool]) - Ignore SSL warnings when connecting to source control.
location (pulumi.Input[str]) - The location of the source code from git or s3.
reportBuildStatus (pulumi.Input[bool]) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
sourceIdentifier (pulumi.Input[str]) - The source identifier. Source data will be put inside a folder named as this parameter inside AWS CodeBuild source directory
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The source object supports the following:

auths (pulumi.Input[list]) - Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.
- resource (pulumi.Input[str]) - The resource value that applies to the specified authorization type.
- type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.
buildspec (pulumi.Input[str]) - The build spec declaration to use for this build project’s related builds.
gitCloneDepth (pulumi.Input[float]) - Truncate git history to this many commits.
insecureSsl (pulumi.Input[bool]) - Ignore SSL warnings when connecting to source control.
location (pulumi.Input[str]) - The location of the source code from git or s3.
reportBuildStatus (pulumi.Input[bool]) - Set to true to report the status of a build’s start and finish to your source provider. This option is only valid when your source provider is GITHUB, BITBUCKET, or GITHUB_ENTERPRISE.
type (pulumi.Input[str]) - The type of repository that contains the source code to be built. Valid values for this parameter are: CODECOMMIT, CODEPIPELINE, GITHUB, GITHUB_ENTERPRISE, BITBUCKET or S3.

The vpc_config object supports the following:

securityGroupIds (pulumi.Input[list]) - The security group IDs to assign to running builds.
subnets (pulumi.Input[list]) - The subnet IDs within which to run builds.
vpc_id (pulumi.Input[str]) - The ID of the VPC within which to run builds.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_project.html.markdown.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.codebuild.SourceCredential(resource_name, opts=None, auth_type=None, server_type=None, token=None, user_name=None, __props__=None, __name__=None, __opts__=None)¶

Provides a CodeBuild Source Credentials Resource.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
auth_type (pulumi.Input[str]) – The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.
server_type (pulumi.Input[str]) – The source provider used for this project.
token (pulumi.Input[str]) – For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
user_name (pulumi.Input[str]) – The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_source_credential.html.markdown.

arn = None¶: The ARN of Source Credential.

auth_type = None¶: The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.

server_type = None¶: The source provider used for this project.

token = None¶: For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.

user_name = None¶: The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

static get(resource_name, id, opts=None, arn=None, auth_type=None, server_type=None, token=None, user_name=None)¶

Get an existing SourceCredential resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
arn (pulumi.Input[str]) – The ARN of Source Credential.
auth_type (pulumi.Input[str]) – The type of authentication used to connect to a GitHub, GitHub Enterprise, or Bitbucket repository. An OAUTH connection is not supported by the API.
server_type (pulumi.Input[str]) – The source provider used for this project.
token (pulumi.Input[str]) – For GitHub or GitHub Enterprise, this is the personal access token. For Bitbucket, this is the app password.
user_name (pulumi.Input[str]) – The Bitbucket username when the authType is BASIC_AUTH. This parameter is not valid for other types of source providers or connections.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_source_credential.html.markdown.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

class pulumi_aws.codebuild.Webhook(resource_name, opts=None, branch_filter=None, filter_groups=None, project_name=None, __props__=None, __name__=None, __opts__=None)¶

Manages a CodeBuild webhook, which is an endpoint accepted by the CodeBuild service to trigger builds from source code repositories. Depending on the source type of the CodeBuild project, the CodeBuild service may also automatically create and delete the actual repository webhook as well.

Parameters

resource_name (str) – The name of the resource.
opts (pulumi.ResourceOptions) – Options for the resource.
branch_filter (pulumi.Input[str]) – A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use filter_group over branch_filter.
filter_groups (pulumi.Input[list]) – Information about the webhook’s trigger. Filter group blocks are documented below.
project_name (pulumi.Input[str]) – The name of the build project.

The filter_groups object supports the following:

filters (pulumi.Input[list]) - A webhook filter for the group. Filter blocks are documented below.
- excludeMatchedPattern (pulumi.Input[bool]) - If set to true, the specified filter does not trigger a build. Defaults to false.
- pattern (pulumi.Input[str]) - For a filter that uses EVENT type, a comma-separated string that specifies one event: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED. PULL_REQUEST_MERGED works with GitHub & GitHub Enterprise only. For a filter that uses any of the other filter types, a regular expression.
- type (pulumi.Input[str]) - The webhook filter group’s type. Valid values for this parameter are: EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH. At least one filter group must specify EVENT as its type.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_webhook.html.markdown.

branch_filter = None¶: A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use filter_group over branch_filter.

filter_groups = None¶

Information about the webhook’s trigger. Filter group blocks are documented below.

filters (list) - A webhook filter for the group. Filter blocks are documented below.
- excludeMatchedPattern (bool) - If set to true, the specified filter does not trigger a build. Defaults to false.
- pattern (str) - For a filter that uses EVENT type, a comma-separated string that specifies one event: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED. PULL_REQUEST_MERGED works with GitHub & GitHub Enterprise only. For a filter that uses any of the other filter types, a regular expression.
- type (str) - The webhook filter group’s type. Valid values for this parameter are: EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH. At least one filter group must specify EVENT as its type.

payload_url = None¶: The CodeBuild endpoint where webhook events are sent.

project_name = None¶: The name of the build project.

secret = None¶: The secret token of the associated repository. Not returned by the CodeBuild API for all source types.

url = None¶: The URL to the webhook.

static get(resource_name, id, opts=None, branch_filter=None, filter_groups=None, payload_url=None, project_name=None, secret=None, url=None)¶

Get an existing Webhook resource’s state with the given name, id, and optional extra properties used to qualify the lookup.

Parameters

resource_name (str) – The unique name of the resulting resource.
id (str) – The unique provider ID of the resource to lookup.
opts (pulumi.ResourceOptions) – Options for the resource.
branch_filter (pulumi.Input[str]) – A regular expression used to determine which branches get built. Default is all branches are built. It is recommended to use filter_group over branch_filter.
filter_groups (pulumi.Input[list]) – Information about the webhook’s trigger. Filter group blocks are documented below.
payload_url (pulumi.Input[str]) – The CodeBuild endpoint where webhook events are sent.
project_name (pulumi.Input[str]) – The name of the build project.
secret (pulumi.Input[str]) – The secret token of the associated repository. Not returned by the CodeBuild API for all source types.
url (pulumi.Input[str]) – The URL to the webhook.

The filter_groups object supports the following:

filters (pulumi.Input[list]) - A webhook filter for the group. Filter blocks are documented below.
- excludeMatchedPattern (pulumi.Input[bool]) - If set to true, the specified filter does not trigger a build. Defaults to false.
- pattern (pulumi.Input[str]) - For a filter that uses EVENT type, a comma-separated string that specifies one event: PUSH, PULL_REQUEST_CREATED, PULL_REQUEST_UPDATED, PULL_REQUEST_REOPENED. PULL_REQUEST_MERGED works with GitHub & GitHub Enterprise only. For a filter that uses any of the other filter types, a regular expression.
- type (pulumi.Input[str]) - The webhook filter group’s type. Valid values for this parameter are: EVENT, BASE_REF, HEAD_REF, ACTOR_ACCOUNT_ID, FILE_PATH. At least one filter group must specify EVENT as its type.

This content is derived from https://github.com/terraform-providers/terraform-provider-aws/blob/master/website/docs/r/codebuild_webhook.html.markdown.

translate_output_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

translate_input_property(prop)¶

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters: prop (str) – A property name.
Returns: A potentially transformed property name.
Return type: str

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

On This Page

codebuild¶