| Copyright | (c) 2013-2018 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay+amazonka@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CodeBuild
Contents
- Service Configuration
- Errors
- Waiters
- Operations
- Types
- ArtifactNamespace
- ArtifactPackaging
- ArtifactsType
- BuildPhaseType
- CacheType
- ComputeType
- EnvironmentType
- EnvironmentVariableType
- LanguageType
- PlatformType
- ProjectSortByType
- SortOrderType
- SourceAuthType
- SourceType
- StatusType
- Build
- BuildArtifacts
- BuildNotDeleted
- BuildPhase
- EnvironmentImage
- EnvironmentLanguage
- EnvironmentPlatform
- EnvironmentVariable
- LogsLocation
- NetworkInterface
- PhaseContext
- Project
- ProjectArtifacts
- ProjectBadge
- ProjectCache
- ProjectEnvironment
- ProjectSource
- SourceAuth
- Tag
- VPCConfig
- Webhook
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, and 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 will run 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 represents a combination of operating system, programming language runtime, and tools that AWS CodeBuild will use to run a build. Also, 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 repository, enables AWS CodeBuild to begin automatically 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 repository, stops AWS CodeBuild from automatically 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.
- codeBuild :: Service
- _ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError
- _OAuthProviderException :: AsError a => Getting (First ServiceError) a ServiceError
- _AccountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError
- _InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError
- _ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError
- module Network.AWS.CodeBuild.ListProjects
- module Network.AWS.CodeBuild.DeleteProject
- module Network.AWS.CodeBuild.UpdateProject
- module Network.AWS.CodeBuild.ListBuilds
- module Network.AWS.CodeBuild.CreateWebhook
- module Network.AWS.CodeBuild.StartBuild
- module Network.AWS.CodeBuild.ListBuildsForProject
- module Network.AWS.CodeBuild.BatchGetProjects
- module Network.AWS.CodeBuild.BatchGetBuilds
- module Network.AWS.CodeBuild.UpdateWebhook
- module Network.AWS.CodeBuild.DeleteWebhook
- module Network.AWS.CodeBuild.InvalidateProjectCache
- module Network.AWS.CodeBuild.BatchDeleteBuilds
- module Network.AWS.CodeBuild.ListCuratedEnvironmentImages
- module Network.AWS.CodeBuild.StopBuild
- module Network.AWS.CodeBuild.CreateProject
- data ArtifactNamespace
- data ArtifactPackaging
- data ArtifactsType
- data BuildPhaseType
- data CacheType
- data ComputeType
- data EnvironmentType = LinuxContainer
- data EnvironmentVariableType
- data LanguageType
- data PlatformType
- = AmazonLinux
- | Debian
- | Ubuntu
- data ProjectSortByType
- data SortOrderType
- data SourceAuthType = Oauth
- data SourceType
- data StatusType
- data Build
- build :: Build
- bPhases :: Lens' Build [BuildPhase]
- bBuildComplete :: Lens' Build (Maybe Bool)
- bArn :: Lens' Build (Maybe Text)
- bStartTime :: Lens' Build (Maybe UTCTime)
- bArtifacts :: Lens' Build (Maybe BuildArtifacts)
- bEnvironment :: Lens' Build (Maybe ProjectEnvironment)
- bInitiator :: Lens' Build (Maybe Text)
- bNetworkInterface :: Lens' Build (Maybe NetworkInterface)
- bCurrentPhase :: Lens' Build (Maybe Text)
- bCache :: Lens' Build (Maybe ProjectCache)
- bSourceVersion :: Lens' Build (Maybe Text)
- bLogs :: Lens' Build (Maybe LogsLocation)
- bVpcConfig :: Lens' Build (Maybe VPCConfig)
- bEndTime :: Lens' Build (Maybe UTCTime)
- bProjectName :: Lens' Build (Maybe Text)
- bBuildStatus :: Lens' Build (Maybe StatusType)
- bSource :: Lens' Build (Maybe ProjectSource)
- bId :: Lens' Build (Maybe Text)
- bTimeoutInMinutes :: Lens' Build (Maybe Int)
- data BuildArtifacts
- buildArtifacts :: BuildArtifacts
- baLocation :: Lens' BuildArtifacts (Maybe Text)
- baMd5sum :: Lens' BuildArtifacts (Maybe Text)
- baSha256sum :: Lens' BuildArtifacts (Maybe Text)
- data BuildNotDeleted
- buildNotDeleted :: BuildNotDeleted
- bndId :: Lens' BuildNotDeleted (Maybe Text)
- bndStatusCode :: Lens' BuildNotDeleted (Maybe Text)
- data BuildPhase
- buildPhase :: BuildPhase
- bpContexts :: Lens' BuildPhase [PhaseContext]
- bpStartTime :: Lens' BuildPhase (Maybe UTCTime)
- bpPhaseStatus :: Lens' BuildPhase (Maybe StatusType)
- bpPhaseType :: Lens' BuildPhase (Maybe BuildPhaseType)
- bpEndTime :: Lens' BuildPhase (Maybe UTCTime)
- bpDurationInSeconds :: Lens' BuildPhase (Maybe Integer)
- data EnvironmentImage
- environmentImage :: EnvironmentImage
- eiVersions :: Lens' EnvironmentImage [Text]
- eiName :: Lens' EnvironmentImage (Maybe Text)
- eiDescription :: Lens' EnvironmentImage (Maybe Text)
- data EnvironmentLanguage
- environmentLanguage :: EnvironmentLanguage
- elImages :: Lens' EnvironmentLanguage [EnvironmentImage]
- elLanguage :: Lens' EnvironmentLanguage (Maybe LanguageType)
- data EnvironmentPlatform
- environmentPlatform :: EnvironmentPlatform
- epPlatform :: Lens' EnvironmentPlatform (Maybe PlatformType)
- epLanguages :: Lens' EnvironmentPlatform [EnvironmentLanguage]
- data EnvironmentVariable
- environmentVariable :: Text -> Text -> EnvironmentVariable
- evType :: Lens' EnvironmentVariable (Maybe EnvironmentVariableType)
- evName :: Lens' EnvironmentVariable Text
- evValue :: Lens' EnvironmentVariable Text
- data LogsLocation
- logsLocation :: LogsLocation
- llDeepLink :: Lens' LogsLocation (Maybe Text)
- llGroupName :: Lens' LogsLocation (Maybe Text)
- llStreamName :: Lens' LogsLocation (Maybe Text)
- data NetworkInterface
- networkInterface :: NetworkInterface
- niSubnetId :: Lens' NetworkInterface (Maybe Text)
- niNetworkInterfaceId :: Lens' NetworkInterface (Maybe Text)
- data PhaseContext
- phaseContext :: PhaseContext
- pcMessage :: Lens' PhaseContext (Maybe Text)
- pcStatusCode :: Lens' PhaseContext (Maybe Text)
- data Project
- project :: Project
- pArn :: Lens' Project (Maybe Text)
- pArtifacts :: Lens' Project (Maybe ProjectArtifacts)
- pEnvironment :: Lens' Project (Maybe ProjectEnvironment)
- pCreated :: Lens' Project (Maybe UTCTime)
- pCache :: Lens' Project (Maybe ProjectCache)
- pName :: Lens' Project (Maybe Text)
- pVpcConfig :: Lens' Project (Maybe VPCConfig)
- pSource :: Lens' Project (Maybe ProjectSource)
- pBadge :: Lens' Project (Maybe ProjectBadge)
- pEncryptionKey :: Lens' Project (Maybe Text)
- pLastModified :: Lens' Project (Maybe UTCTime)
- pWebhook :: Lens' Project (Maybe Webhook)
- pDescription :: Lens' Project (Maybe Text)
- pServiceRole :: Lens' Project (Maybe Text)
- pTags :: Lens' Project [Tag]
- pTimeoutInMinutes :: Lens' Project (Maybe Natural)
- data ProjectArtifacts
- projectArtifacts :: ArtifactsType -> ProjectArtifacts
- paPackaging :: Lens' ProjectArtifacts (Maybe ArtifactPackaging)
- paPath :: Lens' ProjectArtifacts (Maybe Text)
- paLocation :: Lens' ProjectArtifacts (Maybe Text)
- paName :: Lens' ProjectArtifacts (Maybe Text)
- paNamespaceType :: Lens' ProjectArtifacts (Maybe ArtifactNamespace)
- paType :: Lens' ProjectArtifacts ArtifactsType
- data ProjectBadge
- projectBadge :: ProjectBadge
- pbBadgeEnabled :: Lens' ProjectBadge (Maybe Bool)
- pbBadgeRequestURL :: Lens' ProjectBadge (Maybe Text)
- data ProjectCache
- projectCache :: CacheType -> ProjectCache
- pcLocation :: Lens' ProjectCache (Maybe Text)
- pcType :: Lens' ProjectCache CacheType
- data ProjectEnvironment
- projectEnvironment :: EnvironmentType -> Text -> ComputeType -> ProjectEnvironment
- pePrivilegedMode :: Lens' ProjectEnvironment (Maybe Bool)
- peCertificate :: Lens' ProjectEnvironment (Maybe Text)
- peEnvironmentVariables :: Lens' ProjectEnvironment [EnvironmentVariable]
- peType :: Lens' ProjectEnvironment EnvironmentType
- peImage :: Lens' ProjectEnvironment Text
- peComputeType :: Lens' ProjectEnvironment ComputeType
- data ProjectSource
- projectSource :: SourceType -> ProjectSource
- psInsecureSSL :: Lens' ProjectSource (Maybe Bool)
- psLocation :: Lens' ProjectSource (Maybe Text)
- psAuth :: Lens' ProjectSource (Maybe SourceAuth)
- psBuildspec :: Lens' ProjectSource (Maybe Text)
- psGitCloneDepth :: Lens' ProjectSource (Maybe Natural)
- psType :: Lens' ProjectSource SourceType
- data SourceAuth
- sourceAuth :: SourceAuthType -> SourceAuth
- saResource :: Lens' SourceAuth (Maybe Text)
- saType :: Lens' SourceAuth SourceAuthType
- data Tag
- tag :: Tag
- tagValue :: Lens' Tag (Maybe Text)
- tagKey :: Lens' Tag (Maybe Text)
- data VPCConfig
- vpcConfig :: VPCConfig
- vcSecurityGroupIds :: Lens' VPCConfig [Text]
- vcVpcId :: Lens' VPCConfig (Maybe Text)
- vcSubnets :: Lens' VPCConfig [Text]
- data Webhook
- webhook :: Webhook
- wBranchFilter :: Lens' Webhook (Maybe Text)
- wLastModifiedSecret :: Lens' Webhook (Maybe UTCTime)
- wUrl :: Lens' Webhook (Maybe Text)
- wSecret :: Lens' Webhook (Maybe Text)
- wPayloadURL :: Lens' Webhook (Maybe Text)
Service Configuration
Errors
Error matchers are designed for use with the functions provided by
Control.Exception.Lens.
This allows catching (and rethrowing) service specific errors returned
by CodeBuild.
ResourceAlreadyExistsException
_ResourceAlreadyExistsException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified AWS resource cannot be created, because an AWS resource with the same settings already exists.
OAuthProviderException
_OAuthProviderException :: AsError a => Getting (First ServiceError) a ServiceError Source #
There was a problem with the underlying OAuth provider.
AccountLimitExceededException
_AccountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An AWS service limit was exceeded for the calling AWS account.
InvalidInputException
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input value that was provided is not valid.
ResourceNotFoundException
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified AWS resource cannot be found.
Waiters
Waiters poll by repeatedly sending a request until some remote success condition
configured by the Wait specification is fulfilled. The Wait specification
determines how many attempts should be made, in addition to delay and retry strategies.
Operations
Some AWS operations return results that are incomplete and require subsequent
requests in order to obtain the entire result set. The process of sending
subsequent requests to continue where a previous request left off is called
pagination. For example, the ListObjects operation of Amazon S3 returns up to
1000 objects at a time, and you must send subsequent requests with the
appropriate Marker in order to retrieve the next page of results.
Operations that have an AWSPager instance can transparently perform subsequent
requests, correctly setting Markers and other request facets to iterate through
the entire result set of a truncated API operation. Operations which support
this have an additional note in the documentation.
Many operations have the ability to filter results on the server side. See the individual operation parameters for details.
ListProjects (Paginated)
DeleteProject
UpdateProject
ListBuilds (Paginated)
CreateWebhook
StartBuild
ListBuildsForProject (Paginated)
BatchGetProjects
BatchGetBuilds
UpdateWebhook
DeleteWebhook
InvalidateProjectCache
BatchDeleteBuilds
ListCuratedEnvironmentImages
StopBuild
CreateProject
Types
ArtifactNamespace
data ArtifactNamespace Source #
Instances
ArtifactPackaging
data ArtifactPackaging Source #
Instances
ArtifactsType
data ArtifactsType Source #
Constructors
| Codepipeline | |
| NoArtifacts | |
| S3 |
Instances
BuildPhaseType
data BuildPhaseType Source #
Constructors
| Build | |
| Completed | |
| DownloadSource | |
| Finalizing | |
| Install | |
| PostBuild | |
| PreBuild | |
| Provisioning | |
| Submitted | |
| UploadArtifacts |
Instances
CacheType
Instances
ComputeType
data ComputeType Source #
Constructors
| BuildGENERAL1Large | |
| BuildGENERAL1Medium | |
| BuildGENERAL1Small |
Instances
EnvironmentType
data EnvironmentType Source #
Constructors
| LinuxContainer |
Instances
EnvironmentVariableType
data EnvironmentVariableType Source #
Constructors
| ParameterStore | |
| Plaintext |
Instances
LanguageType
data LanguageType Source #
Instances
PlatformType
data PlatformType Source #
Constructors
| AmazonLinux | |
| Debian | |
| Ubuntu |
Instances
ProjectSortByType
data ProjectSortByType Source #
Constructors
| CreatedTime | |
| LastModifiedTime | |
| Name |
Instances
SortOrderType
data SortOrderType Source #
Constructors
| Ascending | |
| Descending |
Instances
SourceAuthType
data SourceAuthType Source #
Constructors
| Oauth |
Instances
SourceType
data SourceType Source #
Constructors
| STBitbucket | |
| STCodecommit | |
| STCodepipeline | |
| STGithub | |
| STGithubEnterprise | |
| STS3 |
Instances
StatusType
data StatusType Source #
Instances
Build
Information about a build.
See: build smart constructor.
Creates a value of Build with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bPhases- Information about all previous build phases that are completed and information about any current build phase that is not yet complete.bBuildComplete- Whether the build has finished. True if completed; otherwise, false.bArn- The Amazon Resource Name (ARN) of the build.bStartTime- When the build process started, expressed in Unix time format.bArtifacts- Information about the output artifacts for the build.bEnvironment- Information about the build environment for this build.bInitiator- The entity that started the build. Valid values include: * If AWS CodePipeline started the build, the pipeline's name (for example,codepipeline/my-demo-pipeline). * If an AWS Identity and Access Management (IAM) user started the build, the user's name (for exampleMyUserName). * If the Jenkins plugin for AWS CodeBuild started the build, the stringCodeBuild-Jenkins-Plugin.bNetworkInterface- Describes a network interface.bCurrentPhase- The current build phase.bCache- Information about the cache for the build.bSourceVersion- Any version identifier for the version of the source code to be built.bLogs- Information about the build's logs in Amazon CloudWatch Logs.bVpcConfig- If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.bEndTime- When the build process ended, expressed in Unix time format.bProjectName- The name of the AWS CodeBuild project.bBuildStatus- The current status of the build. Valid values include: *FAILED: The build failed. *FAULT: The build faulted. *IN_PROGRESS: The build is still in progress. *STOPPED: The build stopped. *SUCCEEDED: The build succeeded. *TIMED_OUT: The build timed out.bSource- Information about the source code to be built.bId- The unique ID for the build.bTimeoutInMinutes- How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
bPhases :: Lens' Build [BuildPhase] Source #
Information about all previous build phases that are completed and information about any current build phase that is not yet complete.
bBuildComplete :: Lens' Build (Maybe Bool) Source #
Whether the build has finished. True if completed; otherwise, false.
bStartTime :: Lens' Build (Maybe UTCTime) Source #
When the build process started, expressed in Unix time format.
bArtifacts :: Lens' Build (Maybe BuildArtifacts) Source #
Information about the output artifacts for the build.
bEnvironment :: Lens' Build (Maybe ProjectEnvironment) Source #
Information about the build environment for this build.
bInitiator :: Lens' Build (Maybe Text) Source #
The entity that started the build. Valid values include: * If AWS CodePipeline started the build, the pipeline's name (for example, codepipeline/my-demo-pipeline ). * If an AWS Identity and Access Management (IAM) user started the build, the user's name (for example MyUserName ). * If the Jenkins plugin for AWS CodeBuild started the build, the string CodeBuild-Jenkins-Plugin .
bNetworkInterface :: Lens' Build (Maybe NetworkInterface) Source #
Describes a network interface.
bSourceVersion :: Lens' Build (Maybe Text) Source #
Any version identifier for the version of the source code to be built.
bLogs :: Lens' Build (Maybe LogsLocation) Source #
Information about the build's logs in Amazon CloudWatch Logs.
bVpcConfig :: Lens' Build (Maybe VPCConfig) Source #
If your AWS CodeBuild project accesses resources in an Amazon VPC, you provide this parameter that identifies the VPC ID and the list of security group IDs and subnet IDs. The security groups and subnets must belong to the same VPC. You must provide at least one security group and one subnet ID.
bEndTime :: Lens' Build (Maybe UTCTime) Source #
When the build process ended, expressed in Unix time format.
bBuildStatus :: Lens' Build (Maybe StatusType) Source #
The current status of the build. Valid values include: * FAILED : The build failed. * FAULT : The build faulted. * IN_PROGRESS : The build is still in progress. * STOPPED : The build stopped. * SUCCEEDED : The build succeeded. * TIMED_OUT : The build timed out.
bTimeoutInMinutes :: Lens' Build (Maybe Int) Source #
How long, in minutes, for AWS CodeBuild to wait before timing out this build if it does not get marked as completed.
BuildArtifacts
data BuildArtifacts Source #
Information about build output artifacts.
See: buildArtifacts smart constructor.
buildArtifacts :: BuildArtifacts Source #
Creates a value of BuildArtifacts with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
baLocation- Information about the location of the build artifacts.baMd5sum- The MD5 hash of the build artifact. You can use this hash along with a checksum tool to confirm both file integrity and authenticity.baSha256sum- The SHA-256 hash of the build artifact. You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
baLocation :: Lens' BuildArtifacts (Maybe Text) Source #
Information about the location of the build artifacts.
baMd5sum :: Lens' BuildArtifacts (Maybe Text) Source #
The MD5 hash of the build artifact. You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
baSha256sum :: Lens' BuildArtifacts (Maybe Text) Source #
The SHA-256 hash of the build artifact. You can use this hash along with a checksum tool to confirm both file integrity and authenticity.
BuildNotDeleted
data BuildNotDeleted Source #
Information about a build that could not be successfully deleted.
See: buildNotDeleted smart constructor.
buildNotDeleted :: BuildNotDeleted Source #
Creates a value of BuildNotDeleted with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bndId- The ID of the build that could not be successfully deleted.bndStatusCode- Additional information about the build that could not be successfully deleted.
bndId :: Lens' BuildNotDeleted (Maybe Text) Source #
The ID of the build that could not be successfully deleted.
bndStatusCode :: Lens' BuildNotDeleted (Maybe Text) Source #
Additional information about the build that could not be successfully deleted.
BuildPhase
data BuildPhase Source #
Information about a stage for a build.
See: buildPhase smart constructor.
Instances
buildPhase :: BuildPhase Source #
Creates a value of BuildPhase with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
bpContexts- Additional information about a build phase, especially to help troubleshoot a failed build.bpStartTime- When the build phase started, expressed in Unix time format.bpPhaseStatus- The current status of the build phase. Valid values include: *FAILED: The build phase failed. *FAULT: The build phase faulted. *IN_PROGRESS: The build phase is still in progress. *STOPPED: The build phase stopped. *SUCCEEDED: The build phase succeeded. *TIMED_OUT: The build phase timed out.bpPhaseType- The name of the build phase. Valid values include: *BUILD: Core build activities typically occur in this build phase. *COMPLETED: The build has been completed. *DOWNLOAD_SOURCE: Source code is being downloaded in this build phase. *FINALIZING: The build process is completing in this build phase. *INSTALL: Installation activities typically occur in this build phase. *POST_BUILD: Post-build activities typically occur in this build phase. *PRE_BUILD: Pre-build activities typically occur in this build phase. *PROVISIONING: The build environment is being set up. *SUBMITTED: The build has been submitted. *UPLOAD_ARTIFACTS: Build output artifacts are being uploaded to the output location.bpEndTime- When the build phase ended, expressed in Unix time format.bpDurationInSeconds- How long, in seconds, between the starting and ending times of the build's phase.
bpContexts :: Lens' BuildPhase [PhaseContext] Source #
Additional information about a build phase, especially to help troubleshoot a failed build.
bpStartTime :: Lens' BuildPhase (Maybe UTCTime) Source #
When the build phase started, expressed in Unix time format.
bpPhaseStatus :: Lens' BuildPhase (Maybe StatusType) Source #
The current status of the build phase. Valid values include: * FAILED : The build phase failed. * FAULT : The build phase faulted. * IN_PROGRESS : The build phase is still in progress. * STOPPED : The build phase stopped. * SUCCEEDED : The build phase succeeded. * TIMED_OUT : The build phase timed out.
bpPhaseType :: Lens' BuildPhase (Maybe BuildPhaseType) Source #
The name of the build phase. Valid values include: * BUILD : Core build activities typically occur in this build phase. * COMPLETED : The build has been completed. * DOWNLOAD_SOURCE : Source code is being downloaded in this build phase. * FINALIZING : The build process is completing in this build phase. * INSTALL : Installation activities typically occur in this build phase. * POST_BUILD : Post-build activities typically occur in this build phase. * PRE_BUILD : Pre-build activities typically occur in this build phase. * PROVISIONING : The build environment is being set up. * SUBMITTED : The build has been submitted. * UPLOAD_ARTIFACTS : Build output artifacts are being uploaded to the output location.
bpEndTime :: Lens' BuildPhase (Maybe UTCTime) Source #
When the build phase ended, expressed in Unix time format.
bpDurationInSeconds :: Lens' BuildPhase (Maybe Integer) Source #
How long, in seconds, between the starting and ending times of the build's phase.
EnvironmentImage
data EnvironmentImage Source #
Information about a Docker image that is managed by AWS CodeBuild.
See: environmentImage smart constructor.
Instances
environmentImage :: EnvironmentImage Source #
Creates a value of EnvironmentImage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
eiVersions- A list of environment image versions.eiName- The name of the Docker image.eiDescription- The description of the Docker image.
eiVersions :: Lens' EnvironmentImage [Text] Source #
A list of environment image versions.
eiDescription :: Lens' EnvironmentImage (Maybe Text) Source #
The description of the Docker image.
EnvironmentLanguage
data EnvironmentLanguage Source #
A set of Docker images that are related by programming language and are managed by AWS CodeBuild.
See: environmentLanguage smart constructor.
Instances
environmentLanguage :: EnvironmentLanguage Source #
Creates a value of EnvironmentLanguage with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
elImages- The list of Docker images that are related by the specified programming language.elLanguage- The programming language for the Docker images.
elImages :: Lens' EnvironmentLanguage [EnvironmentImage] Source #
The list of Docker images that are related by the specified programming language.
elLanguage :: Lens' EnvironmentLanguage (Maybe LanguageType) Source #
The programming language for the Docker images.
EnvironmentPlatform
data EnvironmentPlatform Source #
A set of Docker images that are related by platform and are managed by AWS CodeBuild.
See: environmentPlatform smart constructor.
Instances
environmentPlatform :: EnvironmentPlatform Source #
Creates a value of EnvironmentPlatform with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
epPlatform- The platform's name.epLanguages- The list of programming languages that are available for the specified platform.
epPlatform :: Lens' EnvironmentPlatform (Maybe PlatformType) Source #
The platform's name.
epLanguages :: Lens' EnvironmentPlatform [EnvironmentLanguage] Source #
The list of programming languages that are available for the specified platform.
EnvironmentVariable
data EnvironmentVariable Source #
Information about an environment variable for a build project or a build.
See: environmentVariable smart constructor.
Instances
Arguments
| :: Text | |
| -> Text | |
| -> EnvironmentVariable |
Creates a value of EnvironmentVariable with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
evType- The type of environment variable. Valid values include: *PARAMETER_STORE: An environment variable stored in Amazon EC2 Systems Manager Parameter Store. *PLAINTEXT: An environment variable in plaintext format.evName- The name or key of the environment variable.evValue- The value of the environment variable. Important: We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).
evType :: Lens' EnvironmentVariable (Maybe EnvironmentVariableType) Source #
The type of environment variable. Valid values include: * PARAMETER_STORE : An environment variable stored in Amazon EC2 Systems Manager Parameter Store. * PLAINTEXT : An environment variable in plaintext format.
evValue :: Lens' EnvironmentVariable Text Source #
The value of the environment variable. Important: We strongly discourage using environment variables to store sensitive values, especially AWS secret key IDs and secret access keys. Environment variables can be displayed in plain text using tools such as the AWS CodeBuild console and the AWS Command Line Interface (AWS CLI).
LogsLocation
data LogsLocation Source #
Information about build logs in Amazon CloudWatch Logs.
See: logsLocation smart constructor.
logsLocation :: LogsLocation Source #
Creates a value of LogsLocation with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
llDeepLink- The URL to an individual build log in Amazon CloudWatch Logs.llGroupName- The name of the Amazon CloudWatch Logs group for the build logs.llStreamName- The name of the Amazon CloudWatch Logs stream for the build logs.
llDeepLink :: Lens' LogsLocation (Maybe Text) Source #
The URL to an individual build log in Amazon CloudWatch Logs.
llGroupName :: Lens' LogsLocation (Maybe Text) Source #
The name of the Amazon CloudWatch Logs group for the build logs.
llStreamName :: Lens' LogsLocation (Maybe Text) Source #
The name of the Amazon CloudWatch Logs stream for the build logs.
NetworkInterface
data NetworkInterface Source #
Describes a network interface.
See: networkInterface smart constructor.
Instances
networkInterface :: NetworkInterface Source #
Creates a value of NetworkInterface with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
niSubnetId- The ID of the subnet.niNetworkInterfaceId- The ID of the network interface.
niSubnetId :: Lens' NetworkInterface (Maybe Text) Source #
The ID of the subnet.
niNetworkInterfaceId :: Lens' NetworkInterface (Maybe Text) Source #
The ID of the network interface.
PhaseContext
data PhaseContext Source #
Additional information about a build phase that has an error. You can use this information to help troubleshoot a failed build.
See: phaseContext smart constructor.
phaseContext :: PhaseContext Source #
Creates a value of PhaseContext with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcMessage- An explanation of the build phase's context. This explanation might include a command ID and an exit code.pcStatusCode- The status code for the context of the build phase.
pcMessage :: Lens' PhaseContext (Maybe Text) Source #
An explanation of the build phase's context. This explanation might include a command ID and an exit code.
pcStatusCode :: Lens' PhaseContext (Maybe Text) Source #
The status code for the context of the build phase.
Project
Information about a build project.
See: project smart constructor.
Creates a value of Project with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pArn- The Amazon Resource Name (ARN) of the build project.pArtifacts- Information about the build output artifacts for the build project.pEnvironment- Information about the build environment for this build project.pCreated- When the build project was created, expressed in Unix time format.pCache- Information about the cache for the build project.pName- The name of the build project.pVpcConfig- Information about the VPC configuration that AWS CodeBuild will access.pSource- Information about the build input source code for this build project.pBadge- Information about the build badge for the build project.pEncryptionKey- The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the formatalias/alias-name).pLastModified- When the build project's settings were last modified, expressed in Unix time format.pWebhook- Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.pDescription- A description that makes the build project easy to identify.pServiceRole- The 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.pTags- The tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.pTimeoutInMinutes- How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
pArtifacts :: Lens' Project (Maybe ProjectArtifacts) Source #
Information about the build output artifacts for the build project.
pEnvironment :: Lens' Project (Maybe ProjectEnvironment) Source #
Information about the build environment for this build project.
pCreated :: Lens' Project (Maybe UTCTime) Source #
When the build project was created, expressed in Unix time format.
pCache :: Lens' Project (Maybe ProjectCache) Source #
Information about the cache for the build project.
pVpcConfig :: Lens' Project (Maybe VPCConfig) Source #
Information about the VPC configuration that AWS CodeBuild will access.
pSource :: Lens' Project (Maybe ProjectSource) Source #
Information about the build input source code for this build project.
pBadge :: Lens' Project (Maybe ProjectBadge) Source #
Information about the build badge for the build project.
pEncryptionKey :: Lens' Project (Maybe Text) Source #
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build output artifacts. This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name ).
pLastModified :: Lens' Project (Maybe UTCTime) Source #
When the build project's settings were last modified, expressed in Unix time format.
pWebhook :: Lens' Project (Maybe Webhook) Source #
Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.
pDescription :: Lens' Project (Maybe Text) Source #
A description that makes the build project easy to identify.
pServiceRole :: Lens' Project (Maybe Text) Source #
The 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.
pTags :: Lens' Project [Tag] Source #
The tags for this build project. These tags are available for use by AWS services that support AWS CodeBuild build project tags.
pTimeoutInMinutes :: Lens' Project (Maybe Natural) Source #
How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.
ProjectArtifacts
data ProjectArtifacts Source #
Information about the build output artifacts for the build project.
See: projectArtifacts smart constructor.
Instances
Arguments
| :: ArtifactsType | |
| -> ProjectArtifacts |
Creates a value of ProjectArtifacts with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
paPackaging- The type of build output artifact to create, as follows: * Iftypeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. * Iftypeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. * Iftypeis set toS3, valid values include: *NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default ifpackagingis not specified. *ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.paPath- Along withnamespaceTypeandname, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows: * Iftypeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * Iftypeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. * Iftypeis set toS3, this is the path to the output artifact. Ifpathis not specified, thenpathwill not be used. For example, ifpathis set toMyArtifacts,namespaceTypeis set toNONE, andnameis set toMyArtifact.zip, then the output artifact would be stored in the output bucket atMyArtifacts/MyArtifact.zip.paLocation- Information about the build output artifact location, as follows: * Iftypeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. * Iftypeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. * Iftypeis set toS3, this is the name of the output bucket.paName- Along withpathandnamespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows: * Iftypeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * Iftypeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. * Iftypeis set toS3, this is the name of the output artifact object. For example, ifpathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact would be stored inMyArtifacts/build-ID /MyArtifact.zip.paNamespaceType- Along withpathandname, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows: * Iftypeis set toCODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * Iftypeis set toNO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced. * Iftypeis set toS3, then valid values include: *BUILD_ID: Include the build ID in the location of the build output artifact. *NONE: Do not include the build ID. This is the default ifnamespaceTypeis not specified. For example, ifpathis set toMyArtifacts,namespaceTypeis set toBUILD_ID, andnameis set toMyArtifact.zip, then the output artifact would be stored inMyArtifacts/build-ID /MyArtifact.zip.paType- The type of build output artifact. Valid values include: *CODEPIPELINE: The build project will have build output generated through AWS CodePipeline. *NO_ARTIFACTS: The build project will not produce any build output. *S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).
paPackaging :: Lens' ProjectArtifacts (Maybe ArtifactPackaging) Source #
The type of build output artifact to create, as follows: * If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild. * If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced. * If type is set to S3 , valid values include: * NONE : AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified. * ZIP : AWS CodeBuild will create in the output bucket a ZIP file containing the build output.
paPath :: Lens' ProjectArtifacts (Maybe Text) Source #
Along with namespaceType and name , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows: * If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced. * If type is set to S3 , this is the path to the output artifact. If path is not specified, then path will not be used. For example, if path is set to MyArtifacts , namespaceType is set to NONE , and name is set to MyArtifact.zip , then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip .
paLocation :: Lens' ProjectArtifacts (Maybe Text) Source #
Information about the build output artifact location, as follows: * If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild. * If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced. * If type is set to S3 , this is the name of the output bucket.
paName :: Lens' ProjectArtifacts (Maybe Text) Source #
Along with path and namespaceType , the pattern that AWS CodeBuild will use to name and store the output artifact, as follows: * If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced. * If type is set to S3 , this is the name of the output artifact object. For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID /MyArtifact.zip .
paNamespaceType :: Lens' ProjectArtifacts (Maybe ArtifactNamespace) Source #
Along with path and name , the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows: * If type is set to CODEPIPELINE , then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild. * If type is set to NO_ARTIFACTS , then this value will be ignored if specified, because no build output will be produced. * If type is set to S3 , then valid values include: * BUILD_ID : Include the build ID in the location of the build output artifact. * NONE : Do not include the build ID. This is the default if namespaceType is not specified. For example, if path is set to MyArtifacts , namespaceType is set to BUILD_ID , and name is set to MyArtifact.zip , then the output artifact would be stored in MyArtifacts/build-ID /MyArtifact.zip .
paType :: Lens' ProjectArtifacts ArtifactsType Source #
The type of build output artifact. Valid values include: * CODEPIPELINE : The build project will have build output generated through AWS CodePipeline. * NO_ARTIFACTS : The build project will not produce any build output. * S3 : The build project will store build output in Amazon Simple Storage Service (Amazon S3).
ProjectBadge
data ProjectBadge Source #
Information about the build badge for the build project.
See: projectBadge smart constructor.
projectBadge :: ProjectBadge Source #
Creates a value of ProjectBadge with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pbBadgeEnabled- Set this to true to generate a publicly-accessible URL for your project's build badge.pbBadgeRequestURL- The publicly-accessible URL through which you can access the build badge for your project.
pbBadgeEnabled :: Lens' ProjectBadge (Maybe Bool) Source #
Set this to true to generate a publicly-accessible URL for your project's build badge.
pbBadgeRequestURL :: Lens' ProjectBadge (Maybe Text) Source #
The publicly-accessible URL through which you can access the build badge for your project.
ProjectCache
data ProjectCache Source #
Information about the cache for the build project.
See: projectCache smart constructor.
Arguments
| :: CacheType | |
| -> ProjectCache |
Creates a value of ProjectCache with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pcLocation- Information about the cache location, as follows: *NO_CACHE: This value will be ignored. *S3: This is the S3 bucket name/prefix.pcType- The type of cache used by the build project. Valid values include: *NO_CACHE: The build project will not use any cache. *S3: The build project will read and write from/to S3.
pcLocation :: Lens' ProjectCache (Maybe Text) Source #
Information about the cache location, as follows: * NO_CACHE : This value will be ignored. * S3 : This is the S3 bucket name/prefix.
pcType :: Lens' ProjectCache CacheType Source #
The type of cache used by the build project. Valid values include: * NO_CACHE : The build project will not use any cache. * S3 : The build project will read and write from/to S3.
ProjectEnvironment
data ProjectEnvironment Source #
Information about the build environment of the build project.
See: projectEnvironment smart constructor.
Instances
Arguments
| :: EnvironmentType | |
| -> Text | |
| -> ComputeType | |
| -> ProjectEnvironment |
Creates a value of ProjectEnvironment with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
pePrivilegedMode- Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.)- nohup usrlocalbindockerd --host=unix://varrundocker.sock --host=tcp:/0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"peCertificate- The certificate to use with this build project.peEnvironmentVariables- A set of environment variables to make available to builds for this build project.peType- The type of build environment to use for related builds.peImage- The ID of the Docker image to use for this build project.peComputeType- Information about the compute resources the build project will use. Available values include: *BUILD_GENERAL1_SMALL: Use up to 3 GB memory and 2 vCPUs for builds. *BUILD_GENERAL1_MEDIUM: Use up to 7 GB memory and 4 vCPUs for builds. *BUILD_GENERAL1_LARGE: Use up to 15 GB memory and 8 vCPUs for builds.
pePrivilegedMode :: Lens' ProjectEnvironment (Maybe Bool) Source #
Enables running the Docker daemon inside a Docker container. Set to true only if the build project is be used to build Docker images, and the specified build environment image is not provided by AWS CodeBuild with Docker support. Otherwise, all associated builds that attempt to interact with the Docker daemon will fail. Note that you must also start the Docker daemon so that builds can interact with it. One way to do this is to initialize the Docker daemon during the install phase of your build spec by running the following build commands. (Do not run the following build commands if the specified build environment image is provided by AWS CodeBuild with Docker support.) - nohup usrlocalbindockerd --host=unix://varrundocker.sock --host=tcp:/0.0.0.0:2375 --storage-driver=overlay& - timeout -t 15 sh -c "until docker info; do echo .; sleep 1; done"
peCertificate :: Lens' ProjectEnvironment (Maybe Text) Source #
The certificate to use with this build project.
peEnvironmentVariables :: Lens' ProjectEnvironment [EnvironmentVariable] Source #
A set of environment variables to make available to builds for this build project.
peType :: Lens' ProjectEnvironment EnvironmentType Source #
The type of build environment to use for related builds.
peImage :: Lens' ProjectEnvironment Text Source #
The ID of the Docker image to use for this build project.
peComputeType :: Lens' ProjectEnvironment ComputeType Source #
Information about the compute resources the build project will use. Available values include: * BUILD_GENERAL1_SMALL : Use up to 3 GB memory and 2 vCPUs for builds. * BUILD_GENERAL1_MEDIUM : Use up to 7 GB memory and 4 vCPUs for builds. * BUILD_GENERAL1_LARGE : Use up to 15 GB memory and 8 vCPUs for builds.
ProjectSource
data ProjectSource Source #
Information about the build input source code for the build project.
See: projectSource smart constructor.
Instances
Arguments
| :: SourceType | |
| -> ProjectSource |
Creates a value of ProjectSource with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
psInsecureSSL- Enable this flag to ignore SSL warnings while connecting to the project source code.psLocation- Information about the location of the source code to be built. Valid values include: * For source code settings that are specified in the source action of a pipeline in AWS CodePipeline,locationshould not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. * For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example,https://git-codecommit./region-ID/ .amazonaws.comv1repos/repo-name). * For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example,bucket-name /path /to /object-name .zip) * For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page that displays, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to. Then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in thesourceobject, set theauthobject'stypevalue toOAUTH. * For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page that displays, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in thesourceobject, set theauthobject'stypevalue toOAUTH.psAuth- Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's sourcetypevalue isBITBUCKETorGITHUB).psBuildspec- The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built.psGitCloneDepth- Information about the git clone depth for the build project.psType- The type of repository that contains the source code to be built. Valid values include: *BITBUCKET: The source code is in a Bitbucket repository. *CODECOMMIT: The source code is in an AWS CodeCommit repository. *CODEPIPELINE: The source code settings are specified in the source action of a pipeline in AWS CodePipeline. *GITHUB: The source code is in a GitHub repository. *S3: The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
psInsecureSSL :: Lens' ProjectSource (Maybe Bool) Source #
Enable this flag to ignore SSL warnings while connecting to the project source code.
psLocation :: Lens' ProjectSource (Maybe Text) Source #
Information about the location of the source code to be built. Valid values include: * For source code settings that are specified in the source action of a pipeline in AWS CodePipeline, location should not be specified. If it is specified, AWS CodePipeline will ignore it. This is because AWS CodePipeline uses the settings in a pipeline's source action instead of this value. * For source code in an AWS CodeCommit repository, the HTTPS clone URL to the repository that contains the source code and the build spec (for example, https://git-codecommit./region-ID/ .amazonaws.comv1repos/repo-name ). * For source code in an Amazon Simple Storage Service (Amazon S3) input bucket, the path to the ZIP file that contains the source code (for example, bucket-name /path /to /object-name .zip ) * For source code in a GitHub repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your GitHub account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with GitHub, on the GitHub Authorize application page that displays, for Organization access , choose Request access next to each repository you want to allow AWS CodeBuild to have access to. Then choose Authorize application . (After you have connected to your GitHub account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH . * For source code in a Bitbucket repository, the HTTPS clone URL to the repository that contains the source and the build spec. Also, you must connect your AWS account to your Bitbucket account. To do this, use the AWS CodeBuild console to begin creating a build project. When you use the console to connect (or reconnect) with Bitbucket, on the Bitbucket Confirm access to your account page that displays, choose Grant access . (After you have connected to your Bitbucket account, you do not need to finish creating the build project, and you may then leave the AWS CodeBuild console.) To instruct AWS CodeBuild to then use this connection, in the source object, set the auth object's type value to OAUTH .
psAuth :: Lens' ProjectSource (Maybe SourceAuth) Source #
Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB ).
psBuildspec :: Lens' ProjectSource (Maybe Text) Source #
The build spec declaration to use for the builds in this build project. If this value is not specified, a build spec must be included along with the source code to be built.
psGitCloneDepth :: Lens' ProjectSource (Maybe Natural) Source #
Information about the git clone depth for the build project.
psType :: Lens' ProjectSource SourceType Source #
The type of repository that contains the source code to be built. Valid values include: * BITBUCKET : The source code is in a Bitbucket repository. * CODECOMMIT : The source code is in an AWS CodeCommit repository. * CODEPIPELINE : The source code settings are specified in the source action of a pipeline in AWS CodePipeline. * GITHUB : The source code is in a GitHub repository. * S3 : The source code is in an Amazon Simple Storage Service (Amazon S3) input bucket.
SourceAuth
data SourceAuth Source #
Information about the authorization settings for AWS CodeBuild to access the source code to be built.
This information is for the AWS CodeBuild console's use only. Your code should not get or set this information directly (unless the build project's source type value is BITBUCKET or GITHUB ).
See: sourceAuth smart constructor.
Arguments
| :: SourceAuthType | |
| -> SourceAuth |
Creates a value of SourceAuth with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
saResource- The resource value that applies to the specified authorization type.saType- The authorization type to use. The only valid value isOAUTH, which represents the OAuth authorization type.
saResource :: Lens' SourceAuth (Maybe Text) Source #
The resource value that applies to the specified authorization type.
saType :: Lens' SourceAuth SourceAuthType Source #
The authorization type to use. The only valid value is OAUTH , which represents the OAuth authorization type.
Tag
A tag, consisting of a key and a value.
This tag is available for use by AWS services that support tags in AWS CodeBuild.
See: tag smart constructor.
VPCConfig
Information about the VPC configuration that AWS CodeBuild will access.
See: vpcConfig smart constructor.
vpcConfig :: VPCConfig Source #
Creates a value of VPCConfig with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
vcSecurityGroupIds- A list of one or more security groups IDs in your Amazon VPC.vcVpcId- The ID of the Amazon VPC.vcSubnets- A list of one or more subnet IDs in your Amazon VPC.
vcSecurityGroupIds :: Lens' VPCConfig [Text] Source #
A list of one or more security groups IDs in your Amazon VPC.
Webhook
Information about a webhook in GitHub that connects repository events to a build project in AWS CodeBuild.
See: webhook smart constructor.
Creates a value of Webhook with the minimum fields required to make a request.
Use one of the following lenses to modify other fields as desired:
wBranchFilter- A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.wLastModifiedSecret- A timestamp indicating the last time a repository's secret token was modified.wUrl- The URL to the webhook.wSecret- The secret token of the associated repository.wPayloadURL- The CodeBuild endpoint where webhook events are sent.
wBranchFilter :: Lens' Webhook (Maybe Text) Source #
A regular expression used to determine which branches in a repository are built when a webhook is triggered. If the name of a branch matches the regular expression, then it is built. If it doesn't match, then it is not. If branchFilter is empty, then all branches are built.