codebuild function

AWS CodeBuild

AWS CodeBuild

CodeBuild

CodeBuild is a fully managed build service in the cloud. CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. CodeBuild eliminates the need to provision, manage, and scale your own build servers. It provides prepackaged build environments for the most popular programming languages and build tools, such as Apache Maven, Gradle, and more. You can also fully customize build environments in CodeBuild to use your own build tools. CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about CodeBuild, see the CodeBuildUser Guide.

codebuild( config = list(), credentials = list(), endpoint = NULL, region = NULL )

Arguments

  • config: Optional configuration of credentials, endpoint, and/or region.

    • credentials :

      • creds :

        • access_key_id : AWS access key ID
        • secret_access_key : AWS secret access key
        • session_token : AWS temporary session token
      • profile : The name of a profile to use. If not given, then the default profile is used.

      • anonymous : Set anonymous credentials.

    • endpoint : The complete URL to use for the constructed client.

    • region : The AWS Region used in instantiating the client.

    • close_connection : Immediately close all HTTP connections.

    • timeout : The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.

    • s3_force_path_style : Set this to true to force the request to use path-style addressing, i.e. http://s3.amazonaws.com/BUCKET/KEY.

    • sts_regional_endpoint : Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

  • credentials: Optional credentials shorthand for the config parameter

    • creds :

      • access_key_id : AWS access key ID
      • secret_access_key : AWS secret access key
      • session_token : AWS temporary session token
    • profile : The name of a profile to use. If not given, then the default profile is used.

    • anonymous : Set anonymous credentials.

  • endpoint: Optional shorthand for complete URL to use for the constructed client.

  • region: Optional shorthand for AWS Region used in instantiating the client.

Returns

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax

svc <- codebuild(
  config = list(
    credentials = list(
 creds = list(
   access_key_id = "string",
   secret_access_key = "string",
   session_token = "string"
 ),
 profile = "string",
 anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
 access_key_id = "string",
 secret_access_key = "string",
 session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations

batch_delete_buildsDeletes one or more builds
batch_get_build_batchesRetrieves information about one or more batch builds
batch_get_buildsGets information about one or more builds
batch_get_fleetsGets information about one or more compute fleets
batch_get_projectsGets information about one or more build projects
batch_get_report_groupsReturns an array of report groups
batch_get_reportsReturns an array of reports
create_fleetCreates a compute fleet
create_projectCreates a build project
create_report_groupCreates a report group
create_webhookFor an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables CodeBuild to start rebuilding the source code every time a code change is pushed to the repository
delete_build_batchDeletes a batch build
delete_fleetDeletes a compute fleet
delete_projectDeletes a build project
delete_reportDeletes a report
delete_report_groupDeletes a report group
delete_resource_policyDeletes a resource policy that is identified by its resource ARN
delete_source_credentialsDeletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials
delete_webhookFor an existing CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops CodeBuild from rebuilding the source code every time a code change is pushed to the repository
describe_code_coveragesRetrieves one or more code coverage reports
describe_test_casesReturns a list of details about test cases for a report
get_report_group_trendAnalyzes and accumulates test report values for the specified test reports
get_resource_policyGets a resource policy that is identified by its resource ARN
import_source_credentialsImports the source repository credentials for an CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, GitLab, GitLab Self Managed, or Bitbucket repository
invalidate_project_cacheResets the cache for a project
list_build_batchesRetrieves the identifiers of your build batches in the current region
list_build_batches_for_projectRetrieves the identifiers of the build batches for a specific project
list_buildsGets a list of build IDs, with each build ID representing a single build
list_builds_for_projectGets a list of build identifiers for the specified build project, with each build identifier representing a single build
list_curated_environment_imagesGets information about Docker images that are managed by CodeBuild
list_fleetsGets a list of compute fleet names with each compute fleet name representing a single compute fleet
list_projectsGets a list of build project names, with each build project name representing a single build project
list_report_groupsGets a list ARNs for the report groups in the current Amazon Web Services account
list_reportsReturns a list of ARNs for the reports in the current Amazon Web Services account
list_reports_for_report_groupReturns a list of ARNs for the reports that belong to a ReportGroup
list_shared_projectsGets a list of projects that are shared with other Amazon Web Services accounts or users
list_shared_report_groupsGets a list of report groups that are shared with other Amazon Web Services accounts or users
list_source_credentialsReturns a list of SourceCredentialsInfo objects
put_resource_policyStores a resource policy for the ARN of a Project or ReportGroup object
retry_buildRestarts a build
retry_build_batchRestarts a failed batch build
start_buildStarts running a build with the settings defined in the project
start_build_batchStarts a batch build for a project
stop_buildAttempts to stop running a build
stop_build_batchStops a running batch build
update_fleetUpdates a compute fleet
update_projectChanges the settings of a build project
update_project_visibilityChanges the public visibility for a project
update_report_groupUpdates a report group
update_webhookUpdates the webhook associated with an CodeBuild build project

Examples

## Not run: svc <- codebuild() # The following example gets information about builds with the specified # build IDs. svc$batch_get_builds( ids = list( "codebuild-demo-project:9b0ac37f-d19e-4254-9079-f47e9a389eEX", "codebuild-demo-project:b79a46f7-1473-4636-a23f-da9c45c208EX" ) ) ## End(Not run)
  • Maintainer: Dyfan Jones
  • License: Apache License (>= 2.0)
  • Last published: 2025-03-17