startBuild method

Future<StartBuildOutput> startBuild({
  1. required String projectName,
  2. ProjectArtifacts? artifactsOverride,
  3. BuildStatusConfig? buildStatusConfigOverride,
  4. String? buildspecOverride,
  5. ProjectCache? cacheOverride,
  6. String? certificateOverride,
  7. ComputeType? computeTypeOverride,
  8. bool? debugSessionEnabled,
  9. String? encryptionKeyOverride,
  10. EnvironmentType? environmentTypeOverride,
  11. List<EnvironmentVariable>? environmentVariablesOverride,
  12. int? gitCloneDepthOverride,
  13. GitSubmodulesConfig? gitSubmodulesConfigOverride,
  14. String? idempotencyToken,
  15. String? imageOverride,
  16. ImagePullCredentialsType? imagePullCredentialsTypeOverride,
  17. bool? insecureSslOverride,
  18. LogsConfig? logsConfigOverride,
  19. bool? privilegedModeOverride,
  20. int? queuedTimeoutInMinutesOverride,
  21. RegistryCredential? registryCredentialOverride,
  22. bool? reportBuildStatusOverride,
  23. List<ProjectArtifacts>? secondaryArtifactsOverride,
  24. List<ProjectSource>? secondarySourcesOverride,
  25. List<ProjectSourceVersion>? secondarySourcesVersionOverride,
  26. String? serviceRoleOverride,
  27. SourceAuth? sourceAuthOverride,
  28. String? sourceLocationOverride,
  29. SourceType? sourceTypeOverride,
  30. String? sourceVersion,
  31. int? timeoutInMinutesOverride,
})

Starts running a build.

May throw InvalidInputException. May throw ResourceNotFoundException. May throw AccountLimitExceededException.

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

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

Parameter buildStatusConfigOverride : 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.

Parameter buildspecOverride : 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.

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

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

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

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

Parameter encryptionKeyOverride : 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 specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format alias/<alias-name>).

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

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

Parameter gitCloneDepthOverride : 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.

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

Parameter idempotencyToken : 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.

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

Parameter imagePullCredentialsTypeOverride : 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.

Parameter insecureSslOverride : 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.

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

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

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

Parameter registryCredentialOverride : The credentials for access to a private registry.

Parameter reportBuildStatusOverride : 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.

Parameter secondaryArtifactsOverride : An array of ProjectArtifacts objects.

Parameter secondarySourcesOverride : An array of ProjectSource objects.

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

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

Parameter sourceAuthOverride : 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.

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

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

Parameter sourceVersion : 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.

Parameter timeoutInMinutesOverride : 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.

Implementation

Future<StartBuildOutput> startBuild({
  required String projectName,
  ProjectArtifacts? artifactsOverride,
  BuildStatusConfig? buildStatusConfigOverride,
  String? buildspecOverride,
  ProjectCache? cacheOverride,
  String? certificateOverride,
  ComputeType? computeTypeOverride,
  bool? debugSessionEnabled,
  String? encryptionKeyOverride,
  EnvironmentType? environmentTypeOverride,
  List<EnvironmentVariable>? environmentVariablesOverride,
  int? gitCloneDepthOverride,
  GitSubmodulesConfig? gitSubmodulesConfigOverride,
  String? idempotencyToken,
  String? imageOverride,
  ImagePullCredentialsType? imagePullCredentialsTypeOverride,
  bool? insecureSslOverride,
  LogsConfig? logsConfigOverride,
  bool? privilegedModeOverride,
  int? queuedTimeoutInMinutesOverride,
  RegistryCredential? registryCredentialOverride,
  bool? reportBuildStatusOverride,
  List<ProjectArtifacts>? secondaryArtifactsOverride,
  List<ProjectSource>? secondarySourcesOverride,
  List<ProjectSourceVersion>? secondarySourcesVersionOverride,
  String? serviceRoleOverride,
  SourceAuth? sourceAuthOverride,
  String? sourceLocationOverride,
  SourceType? sourceTypeOverride,
  String? sourceVersion,
  int? timeoutInMinutesOverride,
}) async {
  ArgumentError.checkNotNull(projectName, 'projectName');
  _s.validateStringLength(
    'projectName',
    projectName,
    1,
    1152921504606846976,
    isRequired: true,
  );
  _s.validateStringLength(
    'encryptionKeyOverride',
    encryptionKeyOverride,
    1,
    1152921504606846976,
  );
  _s.validateNumRange(
    'gitCloneDepthOverride',
    gitCloneDepthOverride,
    0,
    1152921504606846976,
  );
  _s.validateStringLength(
    'imageOverride',
    imageOverride,
    1,
    1152921504606846976,
  );
  _s.validateNumRange(
    'queuedTimeoutInMinutesOverride',
    queuedTimeoutInMinutesOverride,
    5,
    480,
  );
  _s.validateStringLength(
    'serviceRoleOverride',
    serviceRoleOverride,
    1,
    1152921504606846976,
  );
  _s.validateNumRange(
    'timeoutInMinutesOverride',
    timeoutInMinutesOverride,
    5,
    480,
  );
  final headers = <String, String>{
    'Content-Type': 'application/x-amz-json-1.1',
    'X-Amz-Target': 'CodeBuild_20161006.StartBuild'
  };
  final jsonResponse = await _protocol.send(
    method: 'POST',
    requestUri: '/',
    exceptionFnMap: _exceptionFns,
    // TODO queryParams
    headers: headers,
    payload: {
      'projectName': projectName,
      if (artifactsOverride != null) 'artifactsOverride': artifactsOverride,
      if (buildStatusConfigOverride != null)
        'buildStatusConfigOverride': buildStatusConfigOverride,
      if (buildspecOverride != null) 'buildspecOverride': buildspecOverride,
      if (cacheOverride != null) 'cacheOverride': cacheOverride,
      if (certificateOverride != null)
        'certificateOverride': certificateOverride,
      if (computeTypeOverride != null)
        'computeTypeOverride': computeTypeOverride.toValue(),
      if (debugSessionEnabled != null)
        'debugSessionEnabled': debugSessionEnabled,
      if (encryptionKeyOverride != null)
        'encryptionKeyOverride': encryptionKeyOverride,
      if (environmentTypeOverride != null)
        'environmentTypeOverride': environmentTypeOverride.toValue(),
      if (environmentVariablesOverride != null)
        'environmentVariablesOverride': environmentVariablesOverride,
      if (gitCloneDepthOverride != null)
        'gitCloneDepthOverride': gitCloneDepthOverride,
      if (gitSubmodulesConfigOverride != null)
        'gitSubmodulesConfigOverride': gitSubmodulesConfigOverride,
      if (idempotencyToken != null) 'idempotencyToken': idempotencyToken,
      if (imageOverride != null) 'imageOverride': imageOverride,
      if (imagePullCredentialsTypeOverride != null)
        'imagePullCredentialsTypeOverride':
            imagePullCredentialsTypeOverride.toValue(),
      if (insecureSslOverride != null)
        'insecureSslOverride': insecureSslOverride,
      if (logsConfigOverride != null)
        'logsConfigOverride': logsConfigOverride,
      if (privilegedModeOverride != null)
        'privilegedModeOverride': privilegedModeOverride,
      if (queuedTimeoutInMinutesOverride != null)
        'queuedTimeoutInMinutesOverride': queuedTimeoutInMinutesOverride,
      if (registryCredentialOverride != null)
        'registryCredentialOverride': registryCredentialOverride,
      if (reportBuildStatusOverride != null)
        'reportBuildStatusOverride': reportBuildStatusOverride,
      if (secondaryArtifactsOverride != null)
        'secondaryArtifactsOverride': secondaryArtifactsOverride,
      if (secondarySourcesOverride != null)
        'secondarySourcesOverride': secondarySourcesOverride,
      if (secondarySourcesVersionOverride != null)
        'secondarySourcesVersionOverride': secondarySourcesVersionOverride,
      if (serviceRoleOverride != null)
        'serviceRoleOverride': serviceRoleOverride,
      if (sourceAuthOverride != null)
        'sourceAuthOverride': sourceAuthOverride,
      if (sourceLocationOverride != null)
        'sourceLocationOverride': sourceLocationOverride,
      if (sourceTypeOverride != null)
        'sourceTypeOverride': sourceTypeOverride.toValue(),
      if (sourceVersion != null) 'sourceVersion': sourceVersion,
      if (timeoutInMinutesOverride != null)
        'timeoutInMinutesOverride': timeoutInMinutesOverride,
    },
  );

  return StartBuildOutput.fromJson(jsonResponse.body);
}