adding documentation for aws_codebuild_project resource
This commit is contained in:
liamjbennett
stack72
parent
281bbfc1cc
commit
5a84991872
|
|
@ -0,0 +1,158 @@
|
|||
---
|
||||
layout: "aws"
|
||||
page_title: "AWS: aws_codebuild_project"
|
||||
sidebar_current: "docs-aws-resource-codebuild-project"
|
||||
description: |-
|
||||
Provides n 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` or `S3`.
|
||||
* `location` - (Optional) Information about the build output artifact location. If `type` is set to `CODEPIPELINE` or `NO_ARTIFACTS` then this value will be ignored. If `type` is set to `S3`, this is the name of the output bucket. If `path` is not also specified, then `location` can also specify the path of the output artifact in the output bucket.
|
||||
* `name` - (Optional) The name of the project. If `type` is set to `S3`, this is the name of the output artifact object
|
||||
* `namespace_type` - (Optional) 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`.
|
||||
* `packaging` - (Optional) The type of build output artifact to create. If `type` is set to `S3`, valid values for this parameter are: `NONE` or `ZIP`
|
||||
* `path` - (Optional) If `type` is set to `S3`, 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` or `BUILD_GENERAL1_LARGE`
|
||||
* `image` - (Required) The ID of the Docker image to use for this build project
|
||||
* `type` - (Required) The type of build environment to use for related builds. The only valid value is `LINUX_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` or `S3`.
|
||||
* `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 is `OAUTH`
|
||||
* `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.
|
||||
|
||||
## Import
|
||||
|
||||
CodeBuild projects can be imported using the ARN, e.g
|
||||
|
||||
```
|
||||
$ terraform import aws_codebuild_project.test_project arn:aws:codebuild:us-east-1:123456789012:projects/test_project
|
||||
```
|
||||
|
|
@ -245,6 +245,17 @@
|
|||
</ul>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current(/^docs-aws-resource-codebuild/) %>>
|
||||
<a href="#">CodeBuild Resources</a>
|
||||
<ul class="nav nav-visible">
|
||||
|
||||
<li<%= sidebar_current("docs-aws-resource-codebuild-project") %>>
|
||||
<a href="/docs/providers/aws/r/code_build_project.html">aws_codebuild_project</a>
|
||||
</li>
|
||||
|
||||
</ul>
|
||||
</li>
|
||||
|
||||
<li<%= sidebar_current(/^docs-aws-resource-codecommit/) %>>
|
||||
<a href="#">CodeCommit Resources</a>
|
||||
<ul class="nav nav-visible">
|
||||
|
|
|
|||
Loading…
Reference in New Issue