/ 
Paws-0.40
River stage two • 11 direct dependents • 13 total dependents
⭐ Starred 171 GitHub stars
/ Paws::CodeBuild

NAME

Paws::CodeBuild - Perl Interface to AWS AWS CodeBuild

SYNOPSIS

use Paws;

my $obj = Paws->service('CodeBuild');
my $res = $obj->Method(
  Arg1 => $val1,
  Arg2 => [ 'V1', 'V2' ],
  # if Arg3 is an object, the HashRef will be used as arguments to the constructor
  # of the arguments type
  Arg3 => { Att1 => 'Val1' },
  # if Arg4 is an array of objects, the HashRefs will be passed as arguments to
  # the constructor of the arguments type
  Arg4 => [ { Att1 => 'Val1'  }, { Att1 => 'Val2' } ],
);

DESCRIPTION

AWS CodeBuild

AWS CodeBuild is a fully managed build service in the cloud. AWS CodeBuild compiles your source code, runs unit tests, and produces artifacts that are ready to deploy. AWS 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 AWS CodeBuild to use your own build tools. AWS CodeBuild scales automatically to meet peak build requests. You pay only for the build time you consume. For more information about AWS CodeBuild, see the AWS CodeBuild User Guide.

AWS CodeBuild supports these operations:

  • BatchDeleteBuilds: Deletes one or more builds.

  • BatchGetProjects: Gets information about one or more build projects. A build project defines how AWS CodeBuild runs a build. This includes information such as where to get the source code to build, the build environment to use, the build commands to run, and where to store the build output. A build environment is a representation of operating system, programming language runtime, and tools that AWS CodeBuild uses to run a build. You can add tags to build projects to help manage your resources and costs.

  • CreateProject: Creates a build project.

  • CreateWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

  • UpdateWebhook: Changes the settings of an existing webhook.

  • DeleteProject: Deletes a build project.

  • DeleteWebhook: For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

  • ListProjects: Gets a list of build project names, with each build project name representing a single build project.

  • UpdateProject: Changes the settings of an existing build project.

  • BatchGetBuilds: Gets information about one or more builds.

  • ListBuilds: Gets a list of build IDs, with each build ID representing a single build.

  • ListBuildsForProject: Gets a list of build IDs for the specified build project, with each build ID representing a single build.

  • StartBuild: Starts running a build.

  • StopBuild: Attempts to stop running a build.

  • ListCuratedEnvironmentImages: Gets information about Docker images that are managed by AWS CodeBuild.

  • DeleteSourceCredentials: Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

  • ImportSourceCredentials: Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

  • ListSourceCredentials: Returns a list of SourceCredentialsInfo objects. Each SourceCredentialsInfo object includes the authentication type, token ARN, and type of source provider for one set of credentials.

For the AWS API documentation, see https://docs.aws.amazon.com/goto/WebAPI/codebuild-2016-10-06

METHODS

BatchDeleteBuilds

Ids => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchDeleteBuilds

Returns: a Paws::CodeBuild::BatchDeleteBuildsOutput instance

Deletes one or more builds.

BatchGetBuilds

Ids => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetBuilds

Returns: a Paws::CodeBuild::BatchGetBuildsOutput instance

Gets information about builds.

BatchGetProjects

Names => ArrayRef[Str|Undef]

Each argument is described in detail in: Paws::CodeBuild::BatchGetProjects

Returns: a Paws::CodeBuild::BatchGetProjectsOutput instance

Gets information about build projects.

CreateProject

Artifacts => Paws::CodeBuild::ProjectArtifacts
Environment => Paws::CodeBuild::ProjectEnvironment
Name => Str
ServiceRole => Str
Source => Paws::CodeBuild::ProjectSource
[BadgeEnabled => Bool]
[Cache => Paws::CodeBuild::ProjectCache]
[Description => Str]
[EncryptionKey => Str]
[LogsConfig => Paws::CodeBuild::LogsConfig]
[QueuedTimeoutInMinutes => Int]
[SecondaryArtifacts => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySources => ArrayRef[Paws::CodeBuild::ProjectSource]]
[Tags => ArrayRef[Paws::CodeBuild::Tag]]
[TimeoutInMinutes => Int]
[VpcConfig => Paws::CodeBuild::VpcConfig]

Each argument is described in detail in: Paws::CodeBuild::CreateProject

Returns: a Paws::CodeBuild::CreateProjectOutput instance

Creates a build project.

CreateWebhook

ProjectName => Str
[BranchFilter => Str]

Each argument is described in detail in: Paws::CodeBuild::CreateWebhook

Returns: a Paws::CodeBuild::CreateWebhookOutput instance

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, enables AWS CodeBuild to start rebuilding the source code every time a code change is pushed to the repository.

If you enable webhooks for an AWS CodeBuild project, and the project is used as a build step in AWS CodePipeline, then two identical builds are created for each commit. One build is triggered through webhooks, and one through AWS CodePipeline. Because billing is on a per-build basis, you are billed for both builds. Therefore, if you are using AWS CodePipeline, we recommend that you disable webhooks in AWS CodeBuild. In the AWS CodeBuild console, clear the Webhook box. For more information, see step 5 in Change a Build Project's Settings (http://docs.aws.amazon.com/codebuild/latest/userguide/change-project.html#change-project-console).

DeleteProject

Name => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteProject

Returns: a Paws::CodeBuild::DeleteProjectOutput instance

Deletes a build project.

DeleteSourceCredentials

Arn => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteSourceCredentials

Returns: a Paws::CodeBuild::DeleteSourceCredentialsOutput instance

Deletes a set of GitHub, GitHub Enterprise, or Bitbucket source credentials.

DeleteWebhook

ProjectName => Str

Each argument is described in detail in: Paws::CodeBuild::DeleteWebhook

Returns: a Paws::CodeBuild::DeleteWebhookOutput instance

For an existing AWS CodeBuild build project that has its source code stored in a GitHub or Bitbucket repository, stops AWS CodeBuild from rebuilding the source code every time a code change is pushed to the repository.

ImportSourceCredentials

AuthType => Str
ServerType => Str
Token => Str
[Username => Str]

Each argument is described in detail in: Paws::CodeBuild::ImportSourceCredentials

Returns: a Paws::CodeBuild::ImportSourceCredentialsOutput instance

Imports the source repository credentials for an AWS CodeBuild project that has its source code stored in a GitHub, GitHub Enterprise, or Bitbucket repository.

InvalidateProjectCache

ProjectName => Str

Each argument is described in detail in: Paws::CodeBuild::InvalidateProjectCache

Returns: a Paws::CodeBuild::InvalidateProjectCacheOutput instance

Resets the cache for a project.

ListBuilds

[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListBuilds

Returns: a Paws::CodeBuild::ListBuildsOutput instance

Gets a list of build IDs, with each build ID representing a single build.

ListBuildsForProject

ProjectName => Str
[NextToken => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListBuildsForProject

Returns: a Paws::CodeBuild::ListBuildsForProjectOutput instance

Gets a list of build IDs for the specified build project, with each build ID representing a single build.

ListCuratedEnvironmentImages

Each argument is described in detail in: Paws::CodeBuild::ListCuratedEnvironmentImages

Returns: a Paws::CodeBuild::ListCuratedEnvironmentImagesOutput instance

Gets information about Docker images that are managed by AWS CodeBuild.

ListProjects

[NextToken => Str]
[SortBy => Str]
[SortOrder => Str]

Each argument is described in detail in: Paws::CodeBuild::ListProjects

Returns: a Paws::CodeBuild::ListProjectsOutput instance

Gets a list of build project names, with each build project name representing a single build project.

ListSourceCredentials

Each argument is described in detail in: Paws::CodeBuild::ListSourceCredentials

Returns: a Paws::CodeBuild::ListSourceCredentialsOutput instance

Returns a list of SourceCredentialsInfo objects.

StartBuild

ProjectName => Str
[ArtifactsOverride => Paws::CodeBuild::ProjectArtifacts]
[BuildspecOverride => Str]
[CacheOverride => Paws::CodeBuild::ProjectCache]
[CertificateOverride => Str]
[ComputeTypeOverride => Str]
[EnvironmentTypeOverride => Str]
[EnvironmentVariablesOverride => ArrayRef[Paws::CodeBuild::EnvironmentVariable]]
[GitCloneDepthOverride => Int]
[IdempotencyToken => Str]
[ImageOverride => Str]
[ImagePullCredentialsTypeOverride => Str]
[InsecureSslOverride => Bool]
[LogsConfigOverride => Paws::CodeBuild::LogsConfig]
[PrivilegedModeOverride => Bool]
[QueuedTimeoutInMinutesOverride => Int]
[RegistryCredentialOverride => Paws::CodeBuild::RegistryCredential]
[ReportBuildStatusOverride => Bool]
[SecondaryArtifactsOverride => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySourcesOverride => ArrayRef[Paws::CodeBuild::ProjectSource]]
[SecondarySourcesVersionOverride => ArrayRef[Paws::CodeBuild::ProjectSourceVersion]]
[ServiceRoleOverride => Str]
[SourceAuthOverride => Paws::CodeBuild::SourceAuth]
[SourceLocationOverride => Str]
[SourceTypeOverride => Str]
[SourceVersion => Str]
[TimeoutInMinutesOverride => Int]

Each argument is described in detail in: Paws::CodeBuild::StartBuild

Returns: a Paws::CodeBuild::StartBuildOutput instance

Starts running a build.

StopBuild

Id => Str

Each argument is described in detail in: Paws::CodeBuild::StopBuild

Returns: a Paws::CodeBuild::StopBuildOutput instance

Attempts to stop running a build.

UpdateProject

Name => Str
[Artifacts => Paws::CodeBuild::ProjectArtifacts]
[BadgeEnabled => Bool]
[Cache => Paws::CodeBuild::ProjectCache]
[Description => Str]
[EncryptionKey => Str]
[Environment => Paws::CodeBuild::ProjectEnvironment]
[LogsConfig => Paws::CodeBuild::LogsConfig]
[QueuedTimeoutInMinutes => Int]
[SecondaryArtifacts => ArrayRef[Paws::CodeBuild::ProjectArtifacts]]
[SecondarySources => ArrayRef[Paws::CodeBuild::ProjectSource]]
[ServiceRole => Str]
[Source => Paws::CodeBuild::ProjectSource]
[Tags => ArrayRef[Paws::CodeBuild::Tag]]
[TimeoutInMinutes => Int]
[VpcConfig => Paws::CodeBuild::VpcConfig]

Each argument is described in detail in: Paws::CodeBuild::UpdateProject

Returns: a Paws::CodeBuild::UpdateProjectOutput instance

Changes the settings of a build project.

UpdateWebhook

ProjectName => Str
[BranchFilter => Str]
[RotateSecret => Bool]

Each argument is described in detail in: Paws::CodeBuild::UpdateWebhook

Returns: a Paws::CodeBuild::UpdateWebhookOutput instance

Updates the webhook associated with an AWS CodeBuild build project.

If you use Bitbucket for your repository, rotateSecret is ignored.

PAGINATORS

Paginator methods are helpers that repetively call methods that return partial results

ListAllBuilds(sub { },[NextToken => Str, SortOrder => Str])

ListAllBuilds([NextToken => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- ids, passing the object as the first parameter, and the string 'ids' as the second parameter

If not, it will return a a Paws::CodeBuild::ListBuildsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllBuildsForProject(sub { },ProjectName => Str, [NextToken => Str, SortOrder => Str])

ListAllBuildsForProject(ProjectName => Str, [NextToken => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- ids, passing the object as the first parameter, and the string 'ids' as the second parameter

If not, it will return a a Paws::CodeBuild::ListBuildsForProjectOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

ListAllProjects(sub { },[NextToken => Str, SortBy => Str, SortOrder => Str])

ListAllProjects([NextToken => Str, SortBy => Str, SortOrder => Str])

If passed a sub as first parameter, it will call the sub for each element found in :

- projects, passing the object as the first parameter, and the string 'projects' as the second parameter

If not, it will return a a Paws::CodeBuild::ListProjectsOutput instance with all the params; from all the responses. Please take into account that this mode can potentially consume vasts ammounts of memory.

SEE ALSO

This service class forms part of Paws

BUGS and CONTRIBUTIONS

The source code is located here: https://github.com/pplu/aws-sdk-perl

Please report bugs to: https://github.com/pplu/aws-sdk-perl/issues