AWS SDK for C++  1.8.54
AWS SDK for C++
Public Member Functions | List of all members
Aws::CodeBuild::Model::StartBuildRequest Class Reference

#include <StartBuildRequest.h>

+ Inheritance diagram for Aws::CodeBuild::Model::StartBuildRequest:

Public Member Functions

 StartBuildRequest ()
 
virtual const char * GetServiceRequestName () const override
 
Aws::String SerializePayload () const override
 
Aws::Http::HeaderValueCollection GetRequestSpecificHeaders () const override
 
const Aws::StringGetProjectName () const
 
bool ProjectNameHasBeenSet () const
 
void SetProjectName (const Aws::String &value)
 
void SetProjectName (Aws::String &&value)
 
void SetProjectName (const char *value)
 
StartBuildRequestWithProjectName (const Aws::String &value)
 
StartBuildRequestWithProjectName (Aws::String &&value)
 
StartBuildRequestWithProjectName (const char *value)
 
const Aws::Vector< ProjectSource > & GetSecondarySourcesOverride () const
 
bool SecondarySourcesOverrideHasBeenSet () const
 
void SetSecondarySourcesOverride (const Aws::Vector< ProjectSource > &value)
 
void SetSecondarySourcesOverride (Aws::Vector< ProjectSource > &&value)
 
StartBuildRequestWithSecondarySourcesOverride (const Aws::Vector< ProjectSource > &value)
 
StartBuildRequestWithSecondarySourcesOverride (Aws::Vector< ProjectSource > &&value)
 
StartBuildRequestAddSecondarySourcesOverride (const ProjectSource &value)
 
StartBuildRequestAddSecondarySourcesOverride (ProjectSource &&value)
 
const Aws::Vector< ProjectSourceVersion > & GetSecondarySourcesVersionOverride () const
 
bool SecondarySourcesVersionOverrideHasBeenSet () const
 
void SetSecondarySourcesVersionOverride (const Aws::Vector< ProjectSourceVersion > &value)
 
void SetSecondarySourcesVersionOverride (Aws::Vector< ProjectSourceVersion > &&value)
 
StartBuildRequestWithSecondarySourcesVersionOverride (const Aws::Vector< ProjectSourceVersion > &value)
 
StartBuildRequestWithSecondarySourcesVersionOverride (Aws::Vector< ProjectSourceVersion > &&value)
 
StartBuildRequestAddSecondarySourcesVersionOverride (const ProjectSourceVersion &value)
 
StartBuildRequestAddSecondarySourcesVersionOverride (ProjectSourceVersion &&value)
 
const Aws::StringGetSourceVersion () const
 
bool SourceVersionHasBeenSet () const
 
void SetSourceVersion (const Aws::String &value)
 
void SetSourceVersion (Aws::String &&value)
 
void SetSourceVersion (const char *value)
 
StartBuildRequestWithSourceVersion (const Aws::String &value)
 
StartBuildRequestWithSourceVersion (Aws::String &&value)
 
StartBuildRequestWithSourceVersion (const char *value)
 
const ProjectArtifactsGetArtifactsOverride () const
 
bool ArtifactsOverrideHasBeenSet () const
 
void SetArtifactsOverride (const ProjectArtifacts &value)
 
void SetArtifactsOverride (ProjectArtifacts &&value)
 
StartBuildRequestWithArtifactsOverride (const ProjectArtifacts &value)
 
StartBuildRequestWithArtifactsOverride (ProjectArtifacts &&value)
 
const Aws::Vector< ProjectArtifacts > & GetSecondaryArtifactsOverride () const
 
bool SecondaryArtifactsOverrideHasBeenSet () const
 
void SetSecondaryArtifactsOverride (const Aws::Vector< ProjectArtifacts > &value)
 
void SetSecondaryArtifactsOverride (Aws::Vector< ProjectArtifacts > &&value)
 
StartBuildRequestWithSecondaryArtifactsOverride (const Aws::Vector< ProjectArtifacts > &value)
 
StartBuildRequestWithSecondaryArtifactsOverride (Aws::Vector< ProjectArtifacts > &&value)
 
StartBuildRequestAddSecondaryArtifactsOverride (const ProjectArtifacts &value)
 
StartBuildRequestAddSecondaryArtifactsOverride (ProjectArtifacts &&value)
 
const Aws::Vector< EnvironmentVariable > & GetEnvironmentVariablesOverride () const
 
bool EnvironmentVariablesOverrideHasBeenSet () const
 
void SetEnvironmentVariablesOverride (const Aws::Vector< EnvironmentVariable > &value)
 
void SetEnvironmentVariablesOverride (Aws::Vector< EnvironmentVariable > &&value)
 
StartBuildRequestWithEnvironmentVariablesOverride (const Aws::Vector< EnvironmentVariable > &value)
 
StartBuildRequestWithEnvironmentVariablesOverride (Aws::Vector< EnvironmentVariable > &&value)
 
StartBuildRequestAddEnvironmentVariablesOverride (const EnvironmentVariable &value)
 
StartBuildRequestAddEnvironmentVariablesOverride (EnvironmentVariable &&value)
 
const SourceTypeGetSourceTypeOverride () const
 
bool SourceTypeOverrideHasBeenSet () const
 
void SetSourceTypeOverride (const SourceType &value)
 
void SetSourceTypeOverride (SourceType &&value)
 
StartBuildRequestWithSourceTypeOverride (const SourceType &value)
 
StartBuildRequestWithSourceTypeOverride (SourceType &&value)
 
const Aws::StringGetSourceLocationOverride () const
 
bool SourceLocationOverrideHasBeenSet () const
 
void SetSourceLocationOverride (const Aws::String &value)
 
void SetSourceLocationOverride (Aws::String &&value)
 
void SetSourceLocationOverride (const char *value)
 
StartBuildRequestWithSourceLocationOverride (const Aws::String &value)
 
StartBuildRequestWithSourceLocationOverride (Aws::String &&value)
 
StartBuildRequestWithSourceLocationOverride (const char *value)
 
const SourceAuthGetSourceAuthOverride () const
 
bool SourceAuthOverrideHasBeenSet () const
 
void SetSourceAuthOverride (const SourceAuth &value)
 
void SetSourceAuthOverride (SourceAuth &&value)
 
StartBuildRequestWithSourceAuthOverride (const SourceAuth &value)
 
StartBuildRequestWithSourceAuthOverride (SourceAuth &&value)
 
int GetGitCloneDepthOverride () const
 
bool GitCloneDepthOverrideHasBeenSet () const
 
void SetGitCloneDepthOverride (int value)
 
StartBuildRequestWithGitCloneDepthOverride (int value)
 
const GitSubmodulesConfigGetGitSubmodulesConfigOverride () const
 
bool GitSubmodulesConfigOverrideHasBeenSet () const
 
void SetGitSubmodulesConfigOverride (const GitSubmodulesConfig &value)
 
void SetGitSubmodulesConfigOverride (GitSubmodulesConfig &&value)
 
StartBuildRequestWithGitSubmodulesConfigOverride (const GitSubmodulesConfig &value)
 
StartBuildRequestWithGitSubmodulesConfigOverride (GitSubmodulesConfig &&value)
 
const Aws::StringGetBuildspecOverride () const
 
bool BuildspecOverrideHasBeenSet () const
 
void SetBuildspecOverride (const Aws::String &value)
 
void SetBuildspecOverride (Aws::String &&value)
 
void SetBuildspecOverride (const char *value)
 
StartBuildRequestWithBuildspecOverride (const Aws::String &value)
 
StartBuildRequestWithBuildspecOverride (Aws::String &&value)
 
StartBuildRequestWithBuildspecOverride (const char *value)
 
bool GetInsecureSslOverride () const
 
bool InsecureSslOverrideHasBeenSet () const
 
void SetInsecureSslOverride (bool value)
 
StartBuildRequestWithInsecureSslOverride (bool value)
 
bool GetReportBuildStatusOverride () const
 
bool ReportBuildStatusOverrideHasBeenSet () const
 
void SetReportBuildStatusOverride (bool value)
 
StartBuildRequestWithReportBuildStatusOverride (bool value)
 
const BuildStatusConfigGetBuildStatusConfigOverride () const
 
bool BuildStatusConfigOverrideHasBeenSet () const
 
void SetBuildStatusConfigOverride (const BuildStatusConfig &value)
 
void SetBuildStatusConfigOverride (BuildStatusConfig &&value)
 
StartBuildRequestWithBuildStatusConfigOverride (const BuildStatusConfig &value)
 
StartBuildRequestWithBuildStatusConfigOverride (BuildStatusConfig &&value)
 
const EnvironmentTypeGetEnvironmentTypeOverride () const
 
bool EnvironmentTypeOverrideHasBeenSet () const
 
void SetEnvironmentTypeOverride (const EnvironmentType &value)
 
void SetEnvironmentTypeOverride (EnvironmentType &&value)
 
StartBuildRequestWithEnvironmentTypeOverride (const EnvironmentType &value)
 
StartBuildRequestWithEnvironmentTypeOverride (EnvironmentType &&value)
 
const Aws::StringGetImageOverride () const
 
bool ImageOverrideHasBeenSet () const
 
void SetImageOverride (const Aws::String &value)
 
void SetImageOverride (Aws::String &&value)
 
void SetImageOverride (const char *value)
 
StartBuildRequestWithImageOverride (const Aws::String &value)
 
StartBuildRequestWithImageOverride (Aws::String &&value)
 
StartBuildRequestWithImageOverride (const char *value)
 
const ComputeTypeGetComputeTypeOverride () const
 
bool ComputeTypeOverrideHasBeenSet () const
 
void SetComputeTypeOverride (const ComputeType &value)
 
void SetComputeTypeOverride (ComputeType &&value)
 
StartBuildRequestWithComputeTypeOverride (const ComputeType &value)
 
StartBuildRequestWithComputeTypeOverride (ComputeType &&value)
 
const Aws::StringGetCertificateOverride () const
 
bool CertificateOverrideHasBeenSet () const
 
void SetCertificateOverride (const Aws::String &value)
 
void SetCertificateOverride (Aws::String &&value)
 
void SetCertificateOverride (const char *value)
 
StartBuildRequestWithCertificateOverride (const Aws::String &value)
 
StartBuildRequestWithCertificateOverride (Aws::String &&value)
 
StartBuildRequestWithCertificateOverride (const char *value)
 
const ProjectCacheGetCacheOverride () const
 
bool CacheOverrideHasBeenSet () const
 
void SetCacheOverride (const ProjectCache &value)
 
void SetCacheOverride (ProjectCache &&value)
 
StartBuildRequestWithCacheOverride (const ProjectCache &value)
 
StartBuildRequestWithCacheOverride (ProjectCache &&value)
 
const Aws::StringGetServiceRoleOverride () const
 
bool ServiceRoleOverrideHasBeenSet () const
 
void SetServiceRoleOverride (const Aws::String &value)
 
void SetServiceRoleOverride (Aws::String &&value)
 
void SetServiceRoleOverride (const char *value)
 
StartBuildRequestWithServiceRoleOverride (const Aws::String &value)
 
StartBuildRequestWithServiceRoleOverride (Aws::String &&value)
 
StartBuildRequestWithServiceRoleOverride (const char *value)
 
bool GetPrivilegedModeOverride () const
 
bool PrivilegedModeOverrideHasBeenSet () const
 
void SetPrivilegedModeOverride (bool value)
 
StartBuildRequestWithPrivilegedModeOverride (bool value)
 
int GetTimeoutInMinutesOverride () const
 
bool TimeoutInMinutesOverrideHasBeenSet () const
 
void SetTimeoutInMinutesOverride (int value)
 
StartBuildRequestWithTimeoutInMinutesOverride (int value)
 
int GetQueuedTimeoutInMinutesOverride () const
 
bool QueuedTimeoutInMinutesOverrideHasBeenSet () const
 
void SetQueuedTimeoutInMinutesOverride (int value)
 
StartBuildRequestWithQueuedTimeoutInMinutesOverride (int value)
 
const Aws::StringGetEncryptionKeyOverride () const
 
bool EncryptionKeyOverrideHasBeenSet () const
 
void SetEncryptionKeyOverride (const Aws::String &value)
 
void SetEncryptionKeyOverride (Aws::String &&value)
 
void SetEncryptionKeyOverride (const char *value)
 
StartBuildRequestWithEncryptionKeyOverride (const Aws::String &value)
 
StartBuildRequestWithEncryptionKeyOverride (Aws::String &&value)
 
StartBuildRequestWithEncryptionKeyOverride (const char *value)
 
const Aws::StringGetIdempotencyToken () const
 
bool IdempotencyTokenHasBeenSet () const
 
void SetIdempotencyToken (const Aws::String &value)
 
void SetIdempotencyToken (Aws::String &&value)
 
void SetIdempotencyToken (const char *value)
 
StartBuildRequestWithIdempotencyToken (const Aws::String &value)
 
StartBuildRequestWithIdempotencyToken (Aws::String &&value)
 
StartBuildRequestWithIdempotencyToken (const char *value)
 
const LogsConfigGetLogsConfigOverride () const
 
bool LogsConfigOverrideHasBeenSet () const
 
void SetLogsConfigOverride (const LogsConfig &value)
 
void SetLogsConfigOverride (LogsConfig &&value)
 
StartBuildRequestWithLogsConfigOverride (const LogsConfig &value)
 
StartBuildRequestWithLogsConfigOverride (LogsConfig &&value)
 
const RegistryCredentialGetRegistryCredentialOverride () const
 
bool RegistryCredentialOverrideHasBeenSet () const
 
void SetRegistryCredentialOverride (const RegistryCredential &value)
 
void SetRegistryCredentialOverride (RegistryCredential &&value)
 
StartBuildRequestWithRegistryCredentialOverride (const RegistryCredential &value)
 
StartBuildRequestWithRegistryCredentialOverride (RegistryCredential &&value)
 
const ImagePullCredentialsTypeGetImagePullCredentialsTypeOverride () const
 
bool ImagePullCredentialsTypeOverrideHasBeenSet () const
 
void SetImagePullCredentialsTypeOverride (const ImagePullCredentialsType &value)
 
void SetImagePullCredentialsTypeOverride (ImagePullCredentialsType &&value)
 
StartBuildRequestWithImagePullCredentialsTypeOverride (const ImagePullCredentialsType &value)
 
StartBuildRequestWithImagePullCredentialsTypeOverride (ImagePullCredentialsType &&value)
 
bool GetDebugSessionEnabled () const
 
bool DebugSessionEnabledHasBeenSet () const
 
void SetDebugSessionEnabled (bool value)
 
StartBuildRequestWithDebugSessionEnabled (bool value)
 
- Public Member Functions inherited from Aws::CodeBuild::CodeBuildRequest
virtual ~CodeBuildRequest ()
 
void AddParametersToRequest (Aws::Http::HttpRequest &httpRequest) const
 
Aws::Http::HeaderValueCollection GetHeaders () const override
 
- Public Member Functions inherited from Aws::AmazonSerializableWebServiceRequest
 AmazonSerializableWebServiceRequest ()
 
virtual ~AmazonSerializableWebServiceRequest ()
 
std::shared_ptr< Aws::IOStreamGetBody () const override
 
- Public Member Functions inherited from Aws::AmazonWebServiceRequest
 AmazonWebServiceRequest ()
 
virtual ~AmazonWebServiceRequest ()=default
 
virtual void AddQueryStringParameters (Aws::Http::URI &uri) const
 
virtual void PutToPresignedUrl (Aws::Http::URI &uri) const
 
virtual bool IsStreaming () const
 
virtual bool IsEventStreamRequest () const
 
virtual bool SignBody () const
 
virtual bool IsChunked () const
 
virtual void SetRequestSignedHandler (const RequestSignedHandler &handler)
 
virtual const RequestSignedHandlerGetRequestSignedHandler () const
 
const Aws::IOStreamFactoryGetResponseStreamFactory () const
 
void SetResponseStreamFactory (const Aws::IOStreamFactory &factory)
 
virtual void SetDataReceivedEventHandler (const Aws::Http::DataReceivedEventHandler &dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (const Aws::Http::DataSentEventHandler &dataSentEventHandler)
 
virtual void SetContinueRequestHandler (const Aws::Http::ContinueRequestHandler &continueRequestHandler)
 
virtual void SetDataReceivedEventHandler (Aws::Http::DataReceivedEventHandler &&dataReceivedEventHandler)
 
virtual void SetDataSentEventHandler (Aws::Http::DataSentEventHandler &&dataSentEventHandler)
 
virtual void SetContinueRequestHandler (Aws::Http::ContinueRequestHandler &&continueRequestHandler)
 
virtual void SetRequestRetryHandler (const RequestRetryHandler &handler)
 
virtual void SetRequestRetryHandler (RequestRetryHandler &&handler)
 
virtual const Aws::Http::DataReceivedEventHandlerGetDataReceivedEventHandler () const
 
virtual const Aws::Http::DataSentEventHandlerGetDataSentEventHandler () const
 
virtual const Aws::Http::ContinueRequestHandlerGetContinueRequestHandler () const
 
virtual const RequestRetryHandlerGetRequestRetryHandler () const
 
virtual bool ShouldComputeContentMd5 () const
 

Additional Inherited Members

- Protected Member Functions inherited from Aws::AmazonWebServiceRequest
virtual void DumpBodyToUrl (Aws::Http::URI &uri) const
 

Detailed Description

Definition at line 36 of file StartBuildRequest.h.

Constructor & Destructor Documentation

◆ StartBuildRequest()

Aws::CodeBuild::Model::StartBuildRequest::StartBuildRequest ( )

Member Function Documentation

◆ AddEnvironmentVariablesOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddEnvironmentVariablesOverride ( const EnvironmentVariable value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 494 of file StartBuildRequest.h.

◆ AddEnvironmentVariablesOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddEnvironmentVariablesOverride ( EnvironmentVariable &&  value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 500 of file StartBuildRequest.h.

◆ AddSecondaryArtifactsOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondaryArtifactsOverride ( const ProjectArtifacts value)
inline

An array of ProjectArtifacts objects.

Definition at line 446 of file StartBuildRequest.h.

◆ AddSecondaryArtifactsOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondaryArtifactsOverride ( ProjectArtifacts &&  value)
inline

An array of ProjectArtifacts objects.

Definition at line 451 of file StartBuildRequest.h.

◆ AddSecondarySourcesOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondarySourcesOverride ( const ProjectSource value)
inline

An array of ProjectSource objects.

Definition at line 126 of file StartBuildRequest.h.

◆ AddSecondarySourcesOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondarySourcesOverride ( ProjectSource &&  value)
inline

An array of ProjectSource objects.

Definition at line 131 of file StartBuildRequest.h.

◆ AddSecondarySourcesVersionOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondarySourcesVersionOverride ( const ProjectSourceVersion value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 181 of file StartBuildRequest.h.

◆ AddSecondarySourcesVersionOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::AddSecondarySourcesVersionOverride ( ProjectSourceVersion &&  value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 188 of file StartBuildRequest.h.

◆ ArtifactsOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ArtifactsOverrideHasBeenSet ( ) const
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 386 of file StartBuildRequest.h.

◆ BuildspecOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::BuildspecOverrideHasBeenSet ( ) const
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 726 of file StartBuildRequest.h.

◆ BuildStatusConfigOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::BuildStatusConfigOverrideHasBeenSet ( ) const
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 903 of file StartBuildRequest.h.

◆ CacheOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::CacheOverrideHasBeenSet ( ) const
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1120 of file StartBuildRequest.h.

◆ CertificateOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::CertificateOverrideHasBeenSet ( ) const
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1071 of file StartBuildRequest.h.

◆ ComputeTypeOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ComputeTypeOverrideHasBeenSet ( ) const
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1034 of file StartBuildRequest.h.

◆ DebugSessionEnabledHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::DebugSessionEnabledHasBeenSet ( ) const
inline

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

Definition at line 1586 of file StartBuildRequest.h.

◆ EncryptionKeyOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::EncryptionKeyOverrideHasBeenSet ( ) const
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1291 of file StartBuildRequest.h.

◆ EnvironmentTypeOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::EnvironmentTypeOverrideHasBeenSet ( ) const
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 948 of file StartBuildRequest.h.

◆ EnvironmentVariablesOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::EnvironmentVariablesOverrideHasBeenSet ( ) const
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 464 of file StartBuildRequest.h.

◆ GetArtifactsOverride()

const ProjectArtifacts& Aws::CodeBuild::Model::StartBuildRequest::GetArtifactsOverride ( ) const
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 380 of file StartBuildRequest.h.

◆ GetBuildspecOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetBuildspecOverride ( ) const
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 711 of file StartBuildRequest.h.

◆ GetBuildStatusConfigOverride()

const BuildStatusConfig& Aws::CodeBuild::Model::StartBuildRequest::GetBuildStatusConfigOverride ( ) const
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 895 of file StartBuildRequest.h.

◆ GetCacheOverride()

const ProjectCache& Aws::CodeBuild::Model::StartBuildRequest::GetCacheOverride ( ) const
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1114 of file StartBuildRequest.h.

◆ GetCertificateOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetCertificateOverride ( ) const
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1065 of file StartBuildRequest.h.

◆ GetComputeTypeOverride()

const ComputeType& Aws::CodeBuild::Model::StartBuildRequest::GetComputeTypeOverride ( ) const
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1028 of file StartBuildRequest.h.

◆ GetDebugSessionEnabled()

bool Aws::CodeBuild::Model::StartBuildRequest::GetDebugSessionEnabled ( ) const
inline

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

Definition at line 1578 of file StartBuildRequest.h.

◆ GetEncryptionKeyOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetEncryptionKeyOverride ( ) const
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1280 of file StartBuildRequest.h.

◆ GetEnvironmentTypeOverride()

const EnvironmentType& Aws::CodeBuild::Model::StartBuildRequest::GetEnvironmentTypeOverride ( ) const
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 942 of file StartBuildRequest.h.

◆ GetEnvironmentVariablesOverride()

const Aws::Vector<EnvironmentVariable>& Aws::CodeBuild::Model::StartBuildRequest::GetEnvironmentVariablesOverride ( ) const
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 458 of file StartBuildRequest.h.

◆ GetGitCloneDepthOverride()

int Aws::CodeBuild::Model::StartBuildRequest::GetGitCloneDepthOverride ( ) const
inline

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Definition at line 637 of file StartBuildRequest.h.

◆ GetGitSubmodulesConfigOverride()

const GitSubmodulesConfig& Aws::CodeBuild::Model::StartBuildRequest::GetGitSubmodulesConfigOverride ( ) const
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 665 of file StartBuildRequest.h.

◆ GetIdempotencyToken()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetIdempotencyToken ( ) const
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1366 of file StartBuildRequest.h.

◆ GetImageOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetImageOverride ( ) const
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 979 of file StartBuildRequest.h.

◆ GetImagePullCredentialsTypeOverride()

const ImagePullCredentialsType& Aws::CodeBuild::Model::StartBuildRequest::GetImagePullCredentialsTypeOverride ( ) const
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1504 of file StartBuildRequest.h.

◆ GetInsecureSslOverride()

bool Aws::CodeBuild::Model::StartBuildRequest::GetInsecureSslOverride ( ) const
inline

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Definition at line 825 of file StartBuildRequest.h.

◆ GetLogsConfigOverride()

const LogsConfig& Aws::CodeBuild::Model::StartBuildRequest::GetLogsConfigOverride ( ) const
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1429 of file StartBuildRequest.h.

◆ GetPrivilegedModeOverride()

bool Aws::CodeBuild::Model::StartBuildRequest::GetPrivilegedModeOverride ( ) const
inline

Enable this flag to override privileged mode in the build project.

Definition at line 1199 of file StartBuildRequest.h.

◆ GetProjectName()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetProjectName ( ) const
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 55 of file StartBuildRequest.h.

◆ GetQueuedTimeoutInMinutesOverride()

int Aws::CodeBuild::Model::StartBuildRequest::GetQueuedTimeoutInMinutesOverride ( ) const
inline

The number of minutes a build is allowed to be queued before it times out.

Definition at line 1250 of file StartBuildRequest.h.

◆ GetRegistryCredentialOverride()

const RegistryCredential& Aws::CodeBuild::Model::StartBuildRequest::GetRegistryCredentialOverride ( ) const
inline

The credentials for access to a private registry.

Definition at line 1465 of file StartBuildRequest.h.

◆ GetReportBuildStatusOverride()

bool Aws::CodeBuild::Model::StartBuildRequest::GetReportBuildStatusOverride ( ) const
inline

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Definition at line 859 of file StartBuildRequest.h.

◆ GetRequestSpecificHeaders()

Aws::Http::HeaderValueCollection Aws::CodeBuild::Model::StartBuildRequest::GetRequestSpecificHeaders ( ) const
overridevirtual

Reimplemented from Aws::CodeBuild::CodeBuildRequest.

◆ GetSecondaryArtifactsOverride()

const Aws::Vector<ProjectArtifacts>& Aws::CodeBuild::Model::StartBuildRequest::GetSecondaryArtifactsOverride ( ) const
inline

An array of ProjectArtifacts objects.

Definition at line 416 of file StartBuildRequest.h.

◆ GetSecondarySourcesOverride()

const Aws::Vector<ProjectSource>& Aws::CodeBuild::Model::StartBuildRequest::GetSecondarySourcesOverride ( ) const
inline

An array of ProjectSource objects.

Definition at line 96 of file StartBuildRequest.h.

◆ GetSecondarySourcesVersionOverride()

const Aws::Vector<ProjectSourceVersion>& Aws::CodeBuild::Model::StartBuildRequest::GetSecondarySourcesVersionOverride ( ) const
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 139 of file StartBuildRequest.h.

◆ GetServiceRequestName()

virtual const char* Aws::CodeBuild::Model::StartBuildRequest::GetServiceRequestName ( ) const
inlineoverridevirtual

Implements Aws::AmazonWebServiceRequest.

Definition at line 45 of file StartBuildRequest.h.

◆ GetServiceRoleOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetServiceRoleOverride ( ) const
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1151 of file StartBuildRequest.h.

◆ GetSourceAuthOverride()

const SourceAuth& Aws::CodeBuild::Model::StartBuildRequest::GetSourceAuthOverride ( ) const
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 594 of file StartBuildRequest.h.

◆ GetSourceLocationOverride()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetSourceLocationOverride ( ) const
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 544 of file StartBuildRequest.h.

◆ GetSourceTypeOverride()

const SourceType& Aws::CodeBuild::Model::StartBuildRequest::GetSourceTypeOverride ( ) const
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 507 of file StartBuildRequest.h.

◆ GetSourceVersion()

const Aws::String& Aws::CodeBuild::Model::StartBuildRequest::GetSourceVersion ( ) const
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 212 of file StartBuildRequest.h.

◆ GetTimeoutInMinutesOverride()

int Aws::CodeBuild::Model::StartBuildRequest::GetTimeoutInMinutesOverride ( ) const
inline

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Definition at line 1222 of file StartBuildRequest.h.

◆ GitCloneDepthOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::GitCloneDepthOverrideHasBeenSet ( ) const
inline

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Definition at line 644 of file StartBuildRequest.h.

◆ GitSubmodulesConfigOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::GitSubmodulesConfigOverrideHasBeenSet ( ) const
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 671 of file StartBuildRequest.h.

◆ IdempotencyTokenHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::IdempotencyTokenHasBeenSet ( ) const
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1374 of file StartBuildRequest.h.

◆ ImageOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ImageOverrideHasBeenSet ( ) const
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 985 of file StartBuildRequest.h.

◆ ImagePullCredentialsTypeOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ImagePullCredentialsTypeOverrideHasBeenSet ( ) const
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1517 of file StartBuildRequest.h.

◆ InsecureSslOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::InsecureSslOverrideHasBeenSet ( ) const
inline

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Definition at line 833 of file StartBuildRequest.h.

◆ LogsConfigOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::LogsConfigOverrideHasBeenSet ( ) const
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1435 of file StartBuildRequest.h.

◆ PrivilegedModeOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::PrivilegedModeOverrideHasBeenSet ( ) const
inline

Enable this flag to override privileged mode in the build project.

Definition at line 1204 of file StartBuildRequest.h.

◆ ProjectNameHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ProjectNameHasBeenSet ( ) const
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 60 of file StartBuildRequest.h.

◆ QueuedTimeoutInMinutesOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::QueuedTimeoutInMinutesOverrideHasBeenSet ( ) const
inline

The number of minutes a build is allowed to be queued before it times out.

Definition at line 1256 of file StartBuildRequest.h.

◆ RegistryCredentialOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::RegistryCredentialOverrideHasBeenSet ( ) const
inline

The credentials for access to a private registry.

Definition at line 1470 of file StartBuildRequest.h.

◆ ReportBuildStatusOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ReportBuildStatusOverrideHasBeenSet ( ) const
inline

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Definition at line 868 of file StartBuildRequest.h.

◆ SecondaryArtifactsOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SecondaryArtifactsOverrideHasBeenSet ( ) const
inline

An array of ProjectArtifacts objects.

Definition at line 421 of file StartBuildRequest.h.

◆ SecondarySourcesOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SecondarySourcesOverrideHasBeenSet ( ) const
inline

An array of ProjectSource objects.

Definition at line 101 of file StartBuildRequest.h.

◆ SecondarySourcesVersionOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SecondarySourcesVersionOverrideHasBeenSet ( ) const
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 146 of file StartBuildRequest.h.

◆ SerializePayload()

Aws::String Aws::CodeBuild::Model::StartBuildRequest::SerializePayload ( ) const
overridevirtual

Convert payload into String.

Implements Aws::AmazonSerializableWebServiceRequest.

◆ ServiceRoleOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::ServiceRoleOverrideHasBeenSet ( ) const
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1157 of file StartBuildRequest.h.

◆ SetArtifactsOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetArtifactsOverride ( const ProjectArtifacts value)
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 392 of file StartBuildRequest.h.

◆ SetArtifactsOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetArtifactsOverride ( ProjectArtifacts &&  value)
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 398 of file StartBuildRequest.h.

◆ SetBuildspecOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetBuildspecOverride ( const Aws::String value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 741 of file StartBuildRequest.h.

◆ SetBuildspecOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetBuildspecOverride ( Aws::String &&  value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 756 of file StartBuildRequest.h.

◆ SetBuildspecOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetBuildspecOverride ( const char *  value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 771 of file StartBuildRequest.h.

◆ SetBuildStatusConfigOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetBuildStatusConfigOverride ( const BuildStatusConfig value)
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 911 of file StartBuildRequest.h.

◆ SetBuildStatusConfigOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetBuildStatusConfigOverride ( BuildStatusConfig &&  value)
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 919 of file StartBuildRequest.h.

◆ SetCacheOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetCacheOverride ( const ProjectCache value)
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1126 of file StartBuildRequest.h.

◆ SetCacheOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetCacheOverride ( ProjectCache &&  value)
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1132 of file StartBuildRequest.h.

◆ SetCertificateOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetCertificateOverride ( const Aws::String value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1077 of file StartBuildRequest.h.

◆ SetCertificateOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetCertificateOverride ( Aws::String &&  value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1083 of file StartBuildRequest.h.

◆ SetCertificateOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetCertificateOverride ( const char *  value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1089 of file StartBuildRequest.h.

◆ SetComputeTypeOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetComputeTypeOverride ( const ComputeType value)
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1040 of file StartBuildRequest.h.

◆ SetComputeTypeOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetComputeTypeOverride ( ComputeType &&  value)
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1046 of file StartBuildRequest.h.

◆ SetDebugSessionEnabled()

void Aws::CodeBuild::Model::StartBuildRequest::SetDebugSessionEnabled ( bool  value)
inline

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

Definition at line 1594 of file StartBuildRequest.h.

◆ SetEncryptionKeyOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetEncryptionKeyOverride ( const Aws::String value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1302 of file StartBuildRequest.h.

◆ SetEncryptionKeyOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetEncryptionKeyOverride ( Aws::String &&  value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1313 of file StartBuildRequest.h.

◆ SetEncryptionKeyOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetEncryptionKeyOverride ( const char *  value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1324 of file StartBuildRequest.h.

◆ SetEnvironmentTypeOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetEnvironmentTypeOverride ( const EnvironmentType value)
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 954 of file StartBuildRequest.h.

◆ SetEnvironmentTypeOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetEnvironmentTypeOverride ( EnvironmentType &&  value)
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 960 of file StartBuildRequest.h.

◆ SetEnvironmentVariablesOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetEnvironmentVariablesOverride ( const Aws::Vector< EnvironmentVariable > &  value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 470 of file StartBuildRequest.h.

◆ SetEnvironmentVariablesOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetEnvironmentVariablesOverride ( Aws::Vector< EnvironmentVariable > &&  value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 476 of file StartBuildRequest.h.

◆ SetGitCloneDepthOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetGitCloneDepthOverride ( int  value)
inline

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Definition at line 651 of file StartBuildRequest.h.

◆ SetGitSubmodulesConfigOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetGitSubmodulesConfigOverride ( const GitSubmodulesConfig value)
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 677 of file StartBuildRequest.h.

◆ SetGitSubmodulesConfigOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetGitSubmodulesConfigOverride ( GitSubmodulesConfig &&  value)
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 683 of file StartBuildRequest.h.

◆ SetIdempotencyToken() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetIdempotencyToken ( const Aws::String value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1382 of file StartBuildRequest.h.

◆ SetIdempotencyToken() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetIdempotencyToken ( Aws::String &&  value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1390 of file StartBuildRequest.h.

◆ SetIdempotencyToken() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetIdempotencyToken ( const char *  value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1398 of file StartBuildRequest.h.

◆ SetImageOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetImageOverride ( const Aws::String value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 991 of file StartBuildRequest.h.

◆ SetImageOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetImageOverride ( Aws::String &&  value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 997 of file StartBuildRequest.h.

◆ SetImageOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetImageOverride ( const char *  value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 1003 of file StartBuildRequest.h.

◆ SetImagePullCredentialsTypeOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetImagePullCredentialsTypeOverride ( const ImagePullCredentialsType value)
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1530 of file StartBuildRequest.h.

◆ SetImagePullCredentialsTypeOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetImagePullCredentialsTypeOverride ( ImagePullCredentialsType &&  value)
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1543 of file StartBuildRequest.h.

◆ SetInsecureSslOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetInsecureSslOverride ( bool  value)
inline

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Definition at line 841 of file StartBuildRequest.h.

◆ SetLogsConfigOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetLogsConfigOverride ( const LogsConfig value)
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1441 of file StartBuildRequest.h.

◆ SetLogsConfigOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetLogsConfigOverride ( LogsConfig &&  value)
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1447 of file StartBuildRequest.h.

◆ SetPrivilegedModeOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetPrivilegedModeOverride ( bool  value)
inline

Enable this flag to override privileged mode in the build project.

Definition at line 1209 of file StartBuildRequest.h.

◆ SetProjectName() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetProjectName ( const Aws::String value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 65 of file StartBuildRequest.h.

◆ SetProjectName() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetProjectName ( Aws::String &&  value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 70 of file StartBuildRequest.h.

◆ SetProjectName() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetProjectName ( const char *  value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 75 of file StartBuildRequest.h.

◆ SetQueuedTimeoutInMinutesOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetQueuedTimeoutInMinutesOverride ( int  value)
inline

The number of minutes a build is allowed to be queued before it times out.

Definition at line 1262 of file StartBuildRequest.h.

◆ SetRegistryCredentialOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetRegistryCredentialOverride ( const RegistryCredential value)
inline

The credentials for access to a private registry.

Definition at line 1475 of file StartBuildRequest.h.

◆ SetRegistryCredentialOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetRegistryCredentialOverride ( RegistryCredential &&  value)
inline

The credentials for access to a private registry.

Definition at line 1480 of file StartBuildRequest.h.

◆ SetReportBuildStatusOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetReportBuildStatusOverride ( bool  value)
inline

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Definition at line 877 of file StartBuildRequest.h.

◆ SetSecondaryArtifactsOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondaryArtifactsOverride ( const Aws::Vector< ProjectArtifacts > &  value)
inline

An array of ProjectArtifacts objects.

Definition at line 426 of file StartBuildRequest.h.

◆ SetSecondaryArtifactsOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondaryArtifactsOverride ( Aws::Vector< ProjectArtifacts > &&  value)
inline

An array of ProjectArtifacts objects.

Definition at line 431 of file StartBuildRequest.h.

◆ SetSecondarySourcesOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondarySourcesOverride ( const Aws::Vector< ProjectSource > &  value)
inline

An array of ProjectSource objects.

Definition at line 106 of file StartBuildRequest.h.

◆ SetSecondarySourcesOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondarySourcesOverride ( Aws::Vector< ProjectSource > &&  value)
inline

An array of ProjectSource objects.

Definition at line 111 of file StartBuildRequest.h.

◆ SetSecondarySourcesVersionOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondarySourcesVersionOverride ( const Aws::Vector< ProjectSourceVersion > &  value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 153 of file StartBuildRequest.h.

◆ SetSecondarySourcesVersionOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSecondarySourcesVersionOverride ( Aws::Vector< ProjectSourceVersion > &&  value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 160 of file StartBuildRequest.h.

◆ SetServiceRoleOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetServiceRoleOverride ( const Aws::String value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1163 of file StartBuildRequest.h.

◆ SetServiceRoleOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetServiceRoleOverride ( Aws::String &&  value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1169 of file StartBuildRequest.h.

◆ SetServiceRoleOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetServiceRoleOverride ( const char *  value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1175 of file StartBuildRequest.h.

◆ SetSourceAuthOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceAuthOverride ( const SourceAuth value)
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 608 of file StartBuildRequest.h.

◆ SetSourceAuthOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceAuthOverride ( SourceAuth &&  value)
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 615 of file StartBuildRequest.h.

◆ SetSourceLocationOverride() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceLocationOverride ( const Aws::String value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 556 of file StartBuildRequest.h.

◆ SetSourceLocationOverride() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceLocationOverride ( Aws::String &&  value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 562 of file StartBuildRequest.h.

◆ SetSourceLocationOverride() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceLocationOverride ( const char *  value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 568 of file StartBuildRequest.h.

◆ SetSourceTypeOverride() [1/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceTypeOverride ( const SourceType value)
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 519 of file StartBuildRequest.h.

◆ SetSourceTypeOverride() [2/2]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceTypeOverride ( SourceType &&  value)
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 525 of file StartBuildRequest.h.

◆ SetSourceVersion() [1/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceVersion ( const Aws::String value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 258 of file StartBuildRequest.h.

◆ SetSourceVersion() [2/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceVersion ( Aws::String &&  value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 281 of file StartBuildRequest.h.

◆ SetSourceVersion() [3/3]

void Aws::CodeBuild::Model::StartBuildRequest::SetSourceVersion ( const char *  value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 304 of file StartBuildRequest.h.

◆ SetTimeoutInMinutesOverride()

void Aws::CodeBuild::Model::StartBuildRequest::SetTimeoutInMinutesOverride ( int  value)
inline

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Definition at line 1236 of file StartBuildRequest.h.

◆ SourceAuthOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SourceAuthOverrideHasBeenSet ( ) const
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 601 of file StartBuildRequest.h.

◆ SourceLocationOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SourceLocationOverrideHasBeenSet ( ) const
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 550 of file StartBuildRequest.h.

◆ SourceTypeOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SourceTypeOverrideHasBeenSet ( ) const
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 513 of file StartBuildRequest.h.

◆ SourceVersionHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::SourceVersionHasBeenSet ( ) const
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 235 of file StartBuildRequest.h.

◆ TimeoutInMinutesOverrideHasBeenSet()

bool Aws::CodeBuild::Model::StartBuildRequest::TimeoutInMinutesOverrideHasBeenSet ( ) const
inline

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Definition at line 1229 of file StartBuildRequest.h.

◆ WithArtifactsOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithArtifactsOverride ( const ProjectArtifacts value)
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 404 of file StartBuildRequest.h.

◆ WithArtifactsOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithArtifactsOverride ( ProjectArtifacts &&  value)
inline

Build output artifact settings that override, for this build only, the latest ones already defined in the build project.

Definition at line 410 of file StartBuildRequest.h.

◆ WithBuildspecOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithBuildspecOverride ( const Aws::String value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 786 of file StartBuildRequest.h.

◆ WithBuildspecOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithBuildspecOverride ( Aws::String &&  value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 801 of file StartBuildRequest.h.

◆ WithBuildspecOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithBuildspecOverride ( const char *  value)
inline

A buildspec file declaration that overrides, for this build only, the latest one already defined in the build project.

If this value is set, it can be either an inline buildspec definition, the path to an alternate buildspec file relative to the value of the built-in CODEBUILD_SRC_DIR environment variable, or the path to an S3 bucket. The bucket must be in the same AWS Region as the build project. Specify the buildspec file using its ARN (for example, arn:aws:s3:::my-codebuild-sample2/buildspec.yml). If this value is not provided or is set to an empty string, the source code must contain a buildspec file in its root directory. For more information, see Buildspec File Name and Storage Location.

Definition at line 816 of file StartBuildRequest.h.

◆ WithBuildStatusConfigOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithBuildStatusConfigOverride ( const BuildStatusConfig value)
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 927 of file StartBuildRequest.h.

◆ WithBuildStatusConfigOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithBuildStatusConfigOverride ( BuildStatusConfig &&  value)
inline

Contains information that defines how the build project reports the build status to the source provider. This option is only used when the source provider is GITHUB, GITHUB_ENTERPRISE, or BITBUCKET.

Definition at line 935 of file StartBuildRequest.h.

◆ WithCacheOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithCacheOverride ( const ProjectCache value)
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1138 of file StartBuildRequest.h.

◆ WithCacheOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithCacheOverride ( ProjectCache &&  value)
inline

A ProjectCache object specified for this build that overrides the one defined in the build project.

Definition at line 1144 of file StartBuildRequest.h.

◆ WithCertificateOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithCertificateOverride ( const Aws::String value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1095 of file StartBuildRequest.h.

◆ WithCertificateOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithCertificateOverride ( Aws::String &&  value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1101 of file StartBuildRequest.h.

◆ WithCertificateOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithCertificateOverride ( const char *  value)
inline

The name of a certificate for this build that overrides the one specified in the build project.

Definition at line 1107 of file StartBuildRequest.h.

◆ WithComputeTypeOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithComputeTypeOverride ( const ComputeType value)
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1052 of file StartBuildRequest.h.

◆ WithComputeTypeOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithComputeTypeOverride ( ComputeType &&  value)
inline

The name of a compute type for this build that overrides the one specified in the build project.

Definition at line 1058 of file StartBuildRequest.h.

◆ WithDebugSessionEnabled()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithDebugSessionEnabled ( bool  value)
inline

Specifies if session debugging is enabled for this build. For more information, see Viewing a running build in Session Manager.

Definition at line 1602 of file StartBuildRequest.h.

◆ WithEncryptionKeyOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEncryptionKeyOverride ( const Aws::String value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1335 of file StartBuildRequest.h.

◆ WithEncryptionKeyOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEncryptionKeyOverride ( Aws::String &&  value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1346 of file StartBuildRequest.h.

◆ WithEncryptionKeyOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEncryptionKeyOverride ( const char *  value)
inline

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the build project. The CMK key encrypts the build output artifacts.

You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

Definition at line 1357 of file StartBuildRequest.h.

◆ WithEnvironmentTypeOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEnvironmentTypeOverride ( const EnvironmentType value)
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 966 of file StartBuildRequest.h.

◆ WithEnvironmentTypeOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEnvironmentTypeOverride ( EnvironmentType &&  value)
inline

A container type for this build that overrides the one specified in the build project.

Definition at line 972 of file StartBuildRequest.h.

◆ WithEnvironmentVariablesOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEnvironmentVariablesOverride ( const Aws::Vector< EnvironmentVariable > &  value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 482 of file StartBuildRequest.h.

◆ WithEnvironmentVariablesOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithEnvironmentVariablesOverride ( Aws::Vector< EnvironmentVariable > &&  value)
inline

A set of environment variables that overrides, for this build only, the latest ones already defined in the build project.

Definition at line 488 of file StartBuildRequest.h.

◆ WithGitCloneDepthOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithGitCloneDepthOverride ( int  value)
inline

The user-defined depth of history, with a minimum value of 0, that overrides, for this build only, any previous depth of history defined in the build project.

Definition at line 658 of file StartBuildRequest.h.

◆ WithGitSubmodulesConfigOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithGitSubmodulesConfigOverride ( const GitSubmodulesConfig value)
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 689 of file StartBuildRequest.h.

◆ WithGitSubmodulesConfigOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithGitSubmodulesConfigOverride ( GitSubmodulesConfig &&  value)
inline

Information about the Git submodules configuration for this build of an AWS CodeBuild build project.

Definition at line 695 of file StartBuildRequest.h.

◆ WithIdempotencyToken() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithIdempotencyToken ( const Aws::String value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1406 of file StartBuildRequest.h.

◆ WithIdempotencyToken() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithIdempotencyToken ( Aws::String &&  value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1414 of file StartBuildRequest.h.

◆ WithIdempotencyToken() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithIdempotencyToken ( const char *  value)
inline

A unique, case sensitive identifier you provide to ensure the idempotency of the StartBuild request. The token is included in the StartBuild request and is valid for 5 minutes. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

Definition at line 1422 of file StartBuildRequest.h.

◆ WithImageOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithImageOverride ( const Aws::String value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 1009 of file StartBuildRequest.h.

◆ WithImageOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithImageOverride ( Aws::String &&  value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 1015 of file StartBuildRequest.h.

◆ WithImageOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithImageOverride ( const char *  value)
inline

The name of an image for this build that overrides the one specified in the build project.

Definition at line 1021 of file StartBuildRequest.h.

◆ WithImagePullCredentialsTypeOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithImagePullCredentialsTypeOverride ( const ImagePullCredentialsType value)
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1556 of file StartBuildRequest.h.

◆ WithImagePullCredentialsTypeOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithImagePullCredentialsTypeOverride ( ImagePullCredentialsType &&  value)
inline

The type of credentials AWS CodeBuild uses to pull images in your build. There are two valid values:

CODEBUILD

Specifies that AWS CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust AWS CodeBuild's service principal.

SERVICE_ROLE

Specifies that AWS CodeBuild uses your build project's service role.

When using a cross-account or private registry image, you must use SERVICE_ROLE credentials. When using an AWS CodeBuild curated image, you must use CODEBUILD credentials.

Definition at line 1569 of file StartBuildRequest.h.

◆ WithInsecureSslOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithInsecureSslOverride ( bool  value)
inline

Enable this flag to override the insecure SSL setting that is specified in the build project. The insecure SSL setting determines whether to ignore SSL warnings while connecting to the project source code. This override applies only if the build's source is GitHub Enterprise.

Definition at line 849 of file StartBuildRequest.h.

◆ WithLogsConfigOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithLogsConfigOverride ( const LogsConfig value)
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1453 of file StartBuildRequest.h.

◆ WithLogsConfigOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithLogsConfigOverride ( LogsConfig &&  value)
inline

Log settings for this build that override the log settings defined in the build project.

Definition at line 1459 of file StartBuildRequest.h.

◆ WithPrivilegedModeOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithPrivilegedModeOverride ( bool  value)
inline

Enable this flag to override privileged mode in the build project.

Definition at line 1214 of file StartBuildRequest.h.

◆ WithProjectName() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithProjectName ( const Aws::String value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 80 of file StartBuildRequest.h.

◆ WithProjectName() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithProjectName ( Aws::String &&  value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 85 of file StartBuildRequest.h.

◆ WithProjectName() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithProjectName ( const char *  value)
inline

The name of the AWS CodeBuild build project to start running a build.

Definition at line 90 of file StartBuildRequest.h.

◆ WithQueuedTimeoutInMinutesOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithQueuedTimeoutInMinutesOverride ( int  value)
inline

The number of minutes a build is allowed to be queued before it times out.

Definition at line 1268 of file StartBuildRequest.h.

◆ WithRegistryCredentialOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithRegistryCredentialOverride ( const RegistryCredential value)
inline

The credentials for access to a private registry.

Definition at line 1485 of file StartBuildRequest.h.

◆ WithRegistryCredentialOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithRegistryCredentialOverride ( RegistryCredential &&  value)
inline

The credentials for access to a private registry.

Definition at line 1490 of file StartBuildRequest.h.

◆ WithReportBuildStatusOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithReportBuildStatusOverride ( bool  value)
inline

Set to true to report to your source provider the status of a build's start and completion. If you use this option with a source provider other than GitHub, GitHub Enterprise, or Bitbucket, an invalidInputException is thrown.

The status of a build triggered by a webhook is always reported to your source provider.

Definition at line 886 of file StartBuildRequest.h.

◆ WithSecondaryArtifactsOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondaryArtifactsOverride ( const Aws::Vector< ProjectArtifacts > &  value)
inline

An array of ProjectArtifacts objects.

Definition at line 436 of file StartBuildRequest.h.

◆ WithSecondaryArtifactsOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondaryArtifactsOverride ( Aws::Vector< ProjectArtifacts > &&  value)
inline

An array of ProjectArtifacts objects.

Definition at line 441 of file StartBuildRequest.h.

◆ WithSecondarySourcesOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondarySourcesOverride ( const Aws::Vector< ProjectSource > &  value)
inline

An array of ProjectSource objects.

Definition at line 116 of file StartBuildRequest.h.

◆ WithSecondarySourcesOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondarySourcesOverride ( Aws::Vector< ProjectSource > &&  value)
inline

An array of ProjectSource objects.

Definition at line 121 of file StartBuildRequest.h.

◆ WithSecondarySourcesVersionOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondarySourcesVersionOverride ( const Aws::Vector< ProjectSourceVersion > &  value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 167 of file StartBuildRequest.h.

◆ WithSecondarySourcesVersionOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSecondarySourcesVersionOverride ( Aws::Vector< ProjectSourceVersion > &&  value)
inline

An array of ProjectSourceVersion objects that specify one or more versions of the project's secondary sources to be used for this build only.

Definition at line 174 of file StartBuildRequest.h.

◆ WithServiceRoleOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithServiceRoleOverride ( const Aws::String value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1181 of file StartBuildRequest.h.

◆ WithServiceRoleOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithServiceRoleOverride ( Aws::String &&  value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1187 of file StartBuildRequest.h.

◆ WithServiceRoleOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithServiceRoleOverride ( const char *  value)
inline

The name of a service role for this build that overrides the one specified in the build project.

Definition at line 1193 of file StartBuildRequest.h.

◆ WithSourceAuthOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceAuthOverride ( const SourceAuth value)
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 622 of file StartBuildRequest.h.

◆ WithSourceAuthOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceAuthOverride ( SourceAuth &&  value)
inline

An authorization type for this build that overrides the one defined in the build project. This override applies only if the build project's source is BitBucket or GitHub.

Definition at line 629 of file StartBuildRequest.h.

◆ WithSourceLocationOverride() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceLocationOverride ( const Aws::String value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 574 of file StartBuildRequest.h.

◆ WithSourceLocationOverride() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceLocationOverride ( Aws::String &&  value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 580 of file StartBuildRequest.h.

◆ WithSourceLocationOverride() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceLocationOverride ( const char *  value)
inline

A location that overrides, for this build, the source location for the one defined in the build project.

Definition at line 586 of file StartBuildRequest.h.

◆ WithSourceTypeOverride() [1/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceTypeOverride ( const SourceType value)
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 531 of file StartBuildRequest.h.

◆ WithSourceTypeOverride() [2/2]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceTypeOverride ( SourceType &&  value)
inline

A source input type, for this build, that overrides the source input defined in the build project.

Definition at line 537 of file StartBuildRequest.h.

◆ WithSourceVersion() [1/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceVersion ( const Aws::String value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 327 of file StartBuildRequest.h.

◆ WithSourceVersion() [2/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceVersion ( Aws::String &&  value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 350 of file StartBuildRequest.h.

◆ WithSourceVersion() [3/3]

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithSourceVersion ( const char *  value)
inline

The version of the build input to be built, for this build only. If not specified, the latest version is used. If specified, the contents depends on the source provider:

AWS CodeCommit

The commit ID, branch, or Git tag to use.

GitHub

The commit ID, pull request ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a pull request ID is specified, it must use the format pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Bitbucket

The commit ID, branch name, or tag name that corresponds to the version of the source code you want to build. If a branch name is specified, the branch's HEAD commit ID is used. If not specified, the default branch's HEAD commit ID is used.

Amazon Simple Storage Service (Amazon S3)

The version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the project level, then this sourceVersion (at the build level) takes precedence.

For more information, see Source Version Sample with CodeBuild in the AWS CodeBuild User Guide.

Definition at line 373 of file StartBuildRequest.h.

◆ WithTimeoutInMinutesOverride()

StartBuildRequest& Aws::CodeBuild::Model::StartBuildRequest::WithTimeoutInMinutesOverride ( int  value)
inline

The number of build timeout minutes, from 5 to 480 (8 hours), that overrides, for this build only, the latest setting already defined in the build project.

Definition at line 1243 of file StartBuildRequest.h.


The documentation for this class was generated from the following file: