Docs4dev
Docs
ansible / latest / collections / community / aws / aws_codebuild_module.html

community.aws.aws_codebuild – Create or delete an AWS CodeBuild project

Note

This plugin is part of the community.aws collection (version 1.5.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install community.aws.

To use it in a playbook, specify: community.aws.aws_codebuild.

New in version 1.0.0: of community.aws

Synopsis

  • Create or delete a CodeBuild projects on AWS, used for building code artifacts from source code.

Requirements

The below requirements are needed on the host that executes this module.

  • boto
  • boto3
  • botocore
  • python >= 2.6

Parameters

Parameter Choices/Defaults Comments
artifacts
dictionary / required
Information about the build output artifacts for the build project.
location
string
Information about the build output artifact location. When choosing type S3, set the bucket name here.
name
string
Along with path and namespace_type, the pattern that AWS CodeBuild will use to name and store the output artifact.
namespace_type
string
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
string
The type of build output artifact to create on S3, can be NONE for creating a folder or ZIP for a ZIP file.
path
string
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
string / 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.
Only used for boto3 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.
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
string / required
Caching location on S3.
type
string / required
Cache type. Can be NO_CACHE or S3.
debug_botocore_endpoint_logs
boolean
    Choices:
  • no ←
  • yes
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
string / 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
string
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
string / required
The ID of the Docker image to use for this build project.
privileged_mode
string
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
string / required
The type of build environment to use for the project. Usually LINUX_CONTAINER.
name
string / required
Name of the CodeBuild project.
profile
string
Uses a boto profile. Only works with boto >= 2.24.0.
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
    Choices:
  • no
  • yes
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
    Choices:
  • present ←
  • absent
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
    Choices:
  • no
  • yes ←
When set to "no", SSL certificates will not be validated for boto versions >= 2.6.0.
vpc_config
dictionary
The VPC config enables AWS CodeBuild to access resources in an Amazon VPC.

Notes

Note

  • For details of the parameters and returns see http://boto3.readthedocs.io/en/latest/reference/services/codebuild.html.
  • If parameters are not set within the module, the following environment variables can be used in decreasing order of precedence AWS_URL or EC2_URL, AWS_PROFILE or AWS_DEFAULT_PROFILE, AWS_ACCESS_KEY_ID or AWS_ACCESS_KEY or EC2_ACCESS_KEY, AWS_SECRET_ACCESS_KEY or AWS_SECRET_KEY or EC2_SECRET_KEY, AWS_SECURITY_TOKEN or EC2_SECURITY_TOKEN, AWS_REGION or EC2_REGION, AWS_CA_BUNDLE
  • Ansible uses the boto configuration file (typically ~/.boto) if no credentials are provided. See https://boto.readthedocs.io/en/latest/boto_config_tut.html
  • AWS_REGION or EC2_REGION can be typically be used to specify the AWS region, when required, but this can also be configured in the boto config file

Examples

# Note: These examples do not set authentication details, see the AWS Guide for details.

- community.aws.aws_codebuild:
    name: my_project
    description: My nice little project
    service_role: "arn:aws:iam::123123:role/service-role/code-build-service-role"
    source:
        # Possible values: BITBUCKET, CODECOMMIT, CODEPIPELINE, GITHUB, S3
        type: CODEPIPELINE
        buildspec: ''
    artifacts:
        namespaceType: NONE
        packaging: NONE
        type: CODEPIPELINE
        name: my_project
    environment:
        computeType: BUILD_GENERAL1_SMALL
        privilegedMode: "true"
        image: "aws/codebuild/docker:17.09.0"
        type: LINUX_CONTAINER
        environmentVariables:
            - { name: 'PROFILE', value: 'staging' }
    encryption_key: "arn:aws:kms:us-east-1:123123:alias/aws/s3"
    region: us-east-1
    state: present

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
project
complex
success
Returns the dictionary describing the code project configuration.

arn
string
always
ARN of the CodeBuild project

Sample:
arn:aws:codebuild:us-east-1:123123123:project/vod-api-app-builder
artifacts
complex
always
Information about the output of build artifacts

location
string
when configured
Output location for build artifacts

type
string
always
The type of build artifact.

Sample:
CODEPIPELINE
cache
dictionary
when configured
Cache settings for the build project.

created
string
always
Timestamp of the create time of the project

Sample:
2018-04-17T16:56:03.245000+02:00
description
string
always
A description of the build project

Sample:
My nice little project
environment
dictionary
always
Environment settings for the build

name
string
always
Name of the CodeBuild project

Sample:
my_project
service_role
string
always
IAM role to be used during build to access other AWS services.

Sample:
arn:aws:iam::123123123:role/codebuild-service-role
source
complex
always
Information about the build input source code.

auth
complex
when configured
Information about the authorization settings for AWS CodeBuild to access the source code to be built.

build_spec
string
always
The build spec declaration to use for the builds in this build project.

git_clone_depth
integer
when configured
The git clone depth

insecure_ssl
boolean
when configured
True if set to ignore SSL warnings.

location
string
when configured
Location identifier, depending on the source type.

type
string
always
The type of the repository

Sample:
CODEPIPELINE
tags
list / elements=string
when configured
Tags added to the project

timeout_in_minutes
integer
always
The timeout of a build in minutes

Sample:
60


Authors

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/aws/aws_codebuild_module.html