| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
artifacts
dictionary
/ required
|
Information about the build output artifacts for the build project.
|
||
|
location
-
|
Information about the build output artifact location. When choosing type S3, set the bucket name here.
|
||
|
name
-
|
Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact.
|
||
|
namespace_type
-
|
Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifacts.
Accepts
BUILD_ID and NONE. |
||
|
packaging
-
|
The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file.
|
||
|
path
-
|
Along with namespace_type and name, the pattern that AWS CodeBuild will use to name and store the output artifacts.
Used for path in S3 bucket when type is
S3. |
||
|
type
-
/ required
|
The type of build output for artifacts. Can be one of the following:
CODEPIPELINE, NO_ARTIFACTS, S3. |
||
|
aws_access_key
string
|
AWS access key. If not set then the value of the AWS_ACCESS_KEY_ID, AWS_ACCESS_KEY or EC2_ACCESS_KEY environment variable is used.If profile is set this parameter is ignored.
Passing the aws_access_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_access_key, access_key |
||
|
aws_ca_bundle
path
|
The location of a CA Bundle to use when validating SSL certificates.
Not used by boto 2 based modules.
Note: The CA Bundle is read 'module' side and may need to be explicitly copied from the controller if not run locally.
|
||
|
aws_config
dictionary
|
A dictionary to modify the botocore configuration.
Parameters can be found at https://botocore.amazonaws.com/v1/documentation/api/latest/reference/config.html#botocore.config.Config.
Only the 'user_agent' key is used for boto modules. See http://boto.cloudhackers.com/en/latest/boto_config_tut.html#boto for more boto configuration.
|
||
|
aws_secret_key
string
|
AWS secret key. If not set then the value of the AWS_SECRET_ACCESS_KEY, AWS_SECRET_KEY, or EC2_SECRET_KEY environment variable is used.If profile is set this parameter is ignored.
Passing the aws_secret_key and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: ec2_secret_key, secret_key |
||
|
cache
dictionary
|
Caching params to speed up following builds.
|
||
|
location
-
/ required
|
Caching location on S3.
|
||
|
type
-
/ required
|
Cache type. Can be
NO_CACHE or S3. |
||
|
debug_botocore_endpoint_logs
boolean
|
|
Use a botocore.endpoint logger to parse the unique (rather than total) "resource:action" API calls made during a task, outputing the set to the resource_actions key in the task results. Use the aws_resource_action callback to output to total list made during a playbook. The ANSIBLE_DEBUG_BOTOCORE_LOGS environment variable may also be used.
|
|
|
description
string
|
Descriptive text of the CodeBuild project.
|
||
|
ec2_url
string
|
URL to use to connect to EC2 or your Eucalyptus cloud (by default the module will use EC2 endpoints). Ignored for modules where region is required. Must be specified for all other modules if region is not used. If not set then the value of the EC2_URL environment variable, if any, is used.
aliases: aws_endpoint_url, endpoint_url |
||
|
encryption_key
string
|
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts.
|
||
|
environment
dictionary
|
Information about the build environment for the build project.
|
||
|
compute_type
-
/ required
|
Information about the compute resources the build project will use.
Available values include:
BUILD_GENERAL1_SMALL, BUILD_GENERAL1_MEDIUM, BUILD_GENERAL1_LARGE. |
||
|
environment_variables
-
|
A set of environment variables to make available to builds for the build project. List of dictionaries with name and value fields.
Example: { name: 'MY_ENV_VARIABLE', value: 'test' }
|
||
|
image
-
/ required
|
The ID of the Docker image to use for this build project.
|
||
|
privileged_mode
-
|
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images.
|
||
|
type
-
/ required
|
The type of build environment to use for the project. Usually
LINUX_CONTAINER. |
||
|
name
string
/ required
|
Name of the CodeBuild project.
|
||
|
profile
string
|
Using profile will override aws_access_key, aws_secret_key and security_token and support for passing them at the same time as profile has been deprecated.
aws_access_key, aws_secret_key and security_token will be made mutually exclusive with profile after 2022-06-01.
aliases: aws_profile |
||
|
region
string
|
The AWS region to use. If not specified then the value of the AWS_REGION or EC2_REGION environment variable, if any, is used. See http://docs.aws.amazon.com/general/latest/gr/rande.html#ec2_region
aliases: aws_region, ec2_region |
||
|
security_token
string
|
AWS STS security token. If not set then the value of the AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN environment variable is used.If profile is set this parameter is ignored.
Passing the security_token and profile options at the same time has been deprecated and the options will be made mutually exclusive after 2022-06-01.
aliases: aws_security_token, access_token |
||
|
service_role
string
|
The ARN of the AWS IAM role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.
|
||
|
source
dictionary
/ required
|
Configure service and location for the build input source.
|
||
|
buildspec
string
|
The build spec declaration to use for the builds in this build project. Leave empty if part of the code project.
|
||
|
git_clone_depth
integer
|
When using git you can specify the clone depth as an integer here.
|
||
|
insecure_ssl
boolean
|
|
Enable this flag to ignore SSL warnings while connecting to the project source code.
|
|
|
location
string
|
Information about the location of the source code to be built. For type CODEPIPELINE location should not be specified.
|
||
|
type
string
/ required
|
The type of the source. Allows one of these:
CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE. |
||
|
state
string
|
|
Create or remove code build project.
|
|
|
tags
list
/ elements=dictionary
|
A set of tags for the build project.
|
||
|
key
string
|
The name of the Tag.
|
||
|
value
string
|
The value of the Tag.
|
||
|
timeout_in_minutes
integer
|
Default: 60
|
How long CodeBuild should wait until timing out any build that has not been marked as completed.
|
|
|
validate_certs
boolean
|
|
When set to "no", SSL certificates will not be validated for communication with the AWS APIs.
|
|
|
vpc_config
dictionary
|
The VPC config enables AWS CodeBuild to access resources in an Amazon VPC.
|
||