5.8 KiB
5.8 KiB
layout | page_title | sidebar_current | description |
---|---|---|---|
aws | AWS: aws_codebuild_project | docs-aws-resource-codebuild-project | Provides a CodeBuild Project resource. |
aws_codebuild_project
Provides a CodeBuild Project resource.
Example Usage
resource "aws_iam_role" "codebuild_role" {
name = "codebuild-role-"
assume_role_policy = <<EOF
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Principal": {
"Service": "codebuild.amazonaws.com"
},
"Action": "sts:AssumeRole"
}
]
}
EOF
}
resource "aws_iam_policy" "codebuild_policy" {
name = "codebuild-policy"
path = "/service-role/"
description = "Policy used in trust relationship with CodeBuild"
policy = <<POLICY
{
"Version": "2012-10-17",
"Statement": [
{
"Effect": "Allow",
"Resource": [
"*"
],
"Action": [
"logs:CreateLogGroup",
"logs:CreateLogStream",
"logs:PutLogEvents"
]
}
]
}
POLICY
}
resource "aws_iam_policy_attachment" "codebuild_policy_attachment" {
name = "codebuild-policy-attachment"
policy_arn = "${aws_iam_policy.codebuild_policy.arn}"
roles = ["${aws_iam_role.codebuild_role.id}"]
}
resource "aws_codebuild_project" "foo" {
name = "test-project"
description = "test_codebuild_project"
timeout = "5"
service_role = "${aws_iam_role.codebuild_role.arn}"
artifacts {
type = "NO_ARTIFACTS"
}
environment {
compute_type = "BUILD_GENERAL1_SMALL"
image = "2"
type = "LINUX_CONTAINER"
environment_variable {
"name" = "SOME_KEY"
"value" = "SOME_VALUE"
}
}
source {
type = "GITHUB"
location = "https://github.com/mitchellh/packer.git"
}
tags {
"Environment" = "Test"
}
}
Argument Reference
The following arguments are supported:
name
- (Required) The projects name.description
- (Optional) A short description of the project.encryption_key
- (Optional) The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's build output artifacts.service_role
- (Optional) 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.timeout
- (Optional) 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.tags
- (Optional) A mapping of tags to assign to the resource.artifacts
- (Optional) Information about the project's build output artifacts. Artifact blocks are documented below.environment
- (Optional) Information about the project's build environment. Environment blocks are documented below.source
- (Optional) Information about the project's input source code. Source blocks are documented below.
artifacts
supports the following:
type
- (Required) The build output artifact's type. Valid values for this parameter are:CODEPIPELINE
,NO_ARTIFACTS
orS3
.location
- (Optional) Information about the build output artifact location. Iftype
is set toCODEPIPELINE
orNO_ARTIFACTS
then this value will be ignored. Iftype
is set toS3
, this is the name of the output bucket. Ifpath
is not also specified, thenlocation
can also specify the path of the output artifact in the output bucket.name
- (Optional) The name of the project. Iftype
is set toS3
, this is the name of the output artifact objectnamespace_type
- (Optional) The namespace to use in storing build artifacts. Iftype
is set toS3
, then valid values for this parameter are:BUILD_ID
orNONE
.packaging
- (Optional) The type of build output artifact to create. Iftype
is set toS3
, valid values for this parameter are:NONE
orZIP
path
- (Optional) Iftype
is set toS3
, this is the path to the output artifact
environment
supports the following:
compute_type
- (Required) Information about the compute resources the build project will use. Available values for this parameter are:BUILD_GENERAL1_SMALL
,BUILD_GENERAL1_MEDIUM
orBUILD_GENERAL1_LARGE
image
- (Required) The ID of the Docker image to use for this build projecttype
- (Required) The type of build environment to use for related builds. The only valid value isLINUX_CONTAINER
.environment_variable
- (Optional) A set of environment variables to make available to builds for this build project.
environment_variable
supports the following:
name
- (Required) The environment variable's name or key.value
- (Required) The environment variable's value.
source
supports the following:
type
- (Required) The type of repository that contains the source code to be built. Valid values for this parameter are:CODECOMMIT
,CODEPIPELINE
,GITHUB
orS3
.auth
- (Optional) Information about the authorization settings for AWS CodeBuild to access the source code to be built. Auth blocks are documented below.buildspec
- (Optional) The build spec declaration to use for this build project's related builds.location
- (Optional) The location of the source code from git or s3.
auth
supports the following:
type
- (Required) The authorization type to use. The only valid value isOAUTH
resource
- (Required) The resource value that applies to the specified authorization type.
Attributes Reference
The following attributes are exported:
id
- The ARN of the CodeBuild project.description
- A short description of the project.encryption_key
- The AWS Key Management Service (AWS KMS) customer master key (CMK) that was used for encrypting the build project's build output artifacts.name
- The projects name.service_role
- The ARN of the IAM service role.