| Copyright | (c) 2013-2016 Brendan Hay |
|---|---|
| License | Mozilla Public License, v. 2.0. |
| Maintainer | Brendan Hay <brendan.g.hay@gmail.com> |
| Stability | auto-generated |
| Portability | non-portable (GHC extensions) |
| Safe Haskell | None |
| Language | Haskell2010 |
Network.AWS.CodeBuild.Types
Contents
- Service Configuration
- Errors
- ArtifactNamespace
- ArtifactPackaging
- ArtifactsType
- BuildPhaseType
- ComputeType
- EnvironmentType
- LanguageType
- PlatformType
- ProjectSortByType
- SortOrderType
- SourceAuthType
- SourceType
- StatusType
- Build
- BuildArtifacts
- BuildPhase
- EnvironmentImage
- EnvironmentLanguage
- EnvironmentPlatform
- EnvironmentVariable
- LogsLocation
- PhaseContext
- Project
- ProjectArtifacts
- ProjectEnvironment
- ProjectSource
- SourceAuth
- Tag
Description
- codeBuild :: Service
- _ResourceAlreadyExistsException :: 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
- data ArtifactNamespace
- data ArtifactPackaging
- data ArtifactsType
- data BuildPhaseType
- data ComputeType
- data EnvironmentType = LinuxContainer
- 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)
- bCurrentPhase :: Lens' Build (Maybe Text)
- bSourceVersion :: Lens' Build (Maybe Text)
- bLogs :: Lens' Build (Maybe LogsLocation)
- 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 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
- 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
- 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 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)
- pName :: Lens' Project (Maybe Text)
- pSource :: Lens' Project (Maybe ProjectSource)
- pEncryptionKey :: Lens' Project (Maybe Text)
- pLastModified :: Lens' Project (Maybe UTCTime)
- 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 ProjectEnvironment
- projectEnvironment :: EnvironmentType -> Text -> ComputeType -> ProjectEnvironment
- peEnvironmentVariables :: Lens' ProjectEnvironment [EnvironmentVariable]
- peType :: Lens' ProjectEnvironment EnvironmentType
- peImage :: Lens' ProjectEnvironment Text
- peComputeType :: Lens' ProjectEnvironment ComputeType
- data ProjectSource
- projectSource :: SourceType -> ProjectSource
- psLocation :: Lens' ProjectSource (Maybe Text)
- psAuth :: Lens' ProjectSource (Maybe SourceAuth)
- psBuildspec :: Lens' ProjectSource (Maybe Text)
- 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)
Service Configuration
Errors
_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.
_AccountLimitExceededException :: AsError a => Getting (First ServiceError) a ServiceError Source #
An AWS service limit was exceeded for the calling AWS account.
_InvalidInputException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The input value that was provided is not valid.
_ResourceNotFoundException :: AsError a => Getting (First ServiceError) a ServiceError Source #
The specified AWS resource cannot be found.
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
ComputeType
data ComputeType Source #
Constructors
| BuildGENERAL1Large | |
| BuildGENERAL1Medium | |
| BuildGENERAL1Small |
Instances
EnvironmentType
data EnvironmentType Source #
Constructors
| LinuxContainer |
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
| STCodecommit | |
| STCodepipeline | |
| STGithub | |
| 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 have completed, and information about any current build phase that has not yet completed.bBuildComplete- Whether the build has finished. Valid values include true if completed; otherwise, false.bArn- The build's Amazon Resource Name (ARN).bStartTime- When the build process started, expressed in Unix time format.bArtifacts- Information about the build's output artifacts.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 examplecodepipeline/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.bCurrentPhase- The build's current build phase.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.bEndTime- When the build process ended, expressed in Unix time format.bProjectName- The build project's name.bBuildStatus- The build's current status. 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 build's unique ID.bTimeoutInMinutes- How long in minutes for AWS CodeBuild to wait to timeout this build if it does not get marked as completed.
bPhases :: Lens' Build [BuildPhase] Source #
Information about all previous build phases that have completed, and information about any current build phase that has not yet completed.
bBuildComplete :: Lens' Build (Maybe Bool) Source #
Whether the build has finished. Valid values include 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 build's output artifacts.
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 .
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.
bEndTime :: Lens' Build (Maybe UTCTime) Source #
When the build process ended, expressed in Unix time format.
bBuildStatus :: Lens' Build (Maybe StatusType) Source #
The build's current status. 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 to timeout 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 build artifacts' location.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 build artifacts' location.
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.
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 build phase's current status. 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 build phase's name. Valid values include: *BUILD: Core build activities typically occur in this build phase. *COMPLETED: The build has 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 output location.bpEndTime- When the build phase ended, expressed in Unix time format.bpDurationInSeconds- How long, in seconds, between the build's phase starting and ending times.
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 build phase's current status. 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 build phase's name. Valid values include: * BUILD : Core build activities typically occur in this build phase. * COMPLETED : The build has 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 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 build's phase starting and ending times.
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:
eiName- The Docker image's name.eiDescription- The Docker image's description.
eiDescription :: Lens' EnvironmentImage (Maybe Text) Source #
The Docker image's description.
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 related set of 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 related set of 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:
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 associated build logs.llStreamName- The name of the Amazon CloudWatch Logs stream for the associated 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 associated build logs.
llStreamName :: Lens' LogsLocation (Maybe Text) Source #
The name of the Amazon CloudWatch Logs stream for the associated build logs.
PhaseContext
data PhaseContext Source #
Additional information about a build phase that has an error, which you can use 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 may 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 may 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 build project's Amazon Resource Name (ARN).pArtifacts- Information about the build project's build output artifacts.pEnvironment- Information about the build environment for this build project.pCreated- When the build project was created, expressed in Unix time format.pName- The build project's name.pSource- Information about the build project's build input source code.pEncryptionKey- The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's 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.pDescription- A meaningful description of the build project.pServiceRole- The Amazon Resource Name (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 to timeout 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 project's build output artifacts.
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.
pSource :: Lens' Project (Maybe ProjectSource) Source #
Information about the build project's build input source code.
pEncryptionKey :: Lens' Project (Maybe Text) Source #
The AWS Key Management Service (AWS KMS) customer master key (CMK) to be used for encrypting the build project's 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.
pServiceRole :: Lens' Project (Maybe Text) Source #
The Amazon Resource Name (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 to timeout any related build that did not get marked as completed. The default is 60 minutes.
ProjectArtifacts
data ProjectArtifacts Source #
Information about the build project's build output artifacts.
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. Ifpathis not also specified, thenlocationcan also specify the path of the output artifact in 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 build output artifact's type. Valid values include: *CODEPIPELINE: The build project with 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. If path is not also specified, then location can also specify the path of the output artifact in 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 build output artifact's type. Valid values include: * CODEPIPELINE : The build project with 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).
ProjectEnvironment
data ProjectEnvironment Source #
Information about the build project's build environment.
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:
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. The only valid value isLINUX_CONTAINER, which represents a Linux-based build environment.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.
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. The only valid value is LINUX_CONTAINER , which represents a Linux-based build environment.
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 project's build input source code.
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:
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, including the user name and personal access token, to the repository that contains the source code and the build spec (for example,https:///login-user-name/ :personal-access-tokengithub.com/repo-owner-name /repo-name .git@ ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.psAuth- Information about the authorization settings for AWS CodeBuild to access the source code to be built. This information is only for the AWS CodeBuild console's use. Your code should not get or set this information directly.psBuildspec- The build spec declaration to use for this build project's related builds. If this value is not specified, a build spec must be included along with the source code to be built.psType- The type of repository that contains the source code to be built. Valid values include: *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.
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, including the user name and personal access token, to the repository that contains the source code and the build spec (for example, https:///login-user-name/ :personal-access-token github.com/repo-owner-name /repo-name .git@ ). For more information, see Creating an Access Token for Command-Line Use on the GitHub Help website.
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 only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
psBuildspec :: Lens' ProjectSource (Maybe Text) Source #
The build spec declaration to use for this build project's related builds. If this value is not specified, a build spec must be included along with the source code to be built.
psType :: Lens' ProjectSource SourceType Source #
The type of repository that contains the source code to be built. Valid values include: * 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 only for the AWS CodeBuild console's use. Your code should not get or set this information directly.
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.