BuildBatch ¶

class BuildBatch(TypedDict, closed=True):
    id: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the batch build.</p>"""
    arn: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The ARN of the batch build.</p>"""
    start_time: NotRequired["capo_codebuild.types.timestamp.Timestamp"]
    """<p>The date and time that the batch build started.</p>"""
    end_time: NotRequired["capo_codebuild.types.timestamp.Timestamp"]
    """<p>The date and time that the batch build ended.</p>"""
    current_phase: NotRequired["capo_codebuild.types.string.String"]
    """<p>The current phase of the batch build.</p>"""
    build_batch_status: NotRequired["capo_codebuild.types.status_type.StatusType"]
    """<p>The status of the batch build.</p>"""
    source_version: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The identifier of the version of the source code to be built.</p>"""
    resolved_source_version: NotRequired[
        "capo_codebuild.types.non_empty_string.NonEmptyString"
    ]
    """<p>The identifier of the resolved version of this batch build's source code.</p> <ul> <li> <p>For CodeCommit, GitHub, GitHub Enterprise, and BitBucket, the commit ID.</p> </li> <li> <p>For CodePipeline, the source revision provided by CodePipeline.</p> </li> <li> <p>For Amazon S3, this does not apply.</p> </li> </ul>"""
    project_name: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The name of the batch build project.</p>"""
    phases: NotRequired["capo_codebuild.types.build_batch_phases.BuildBatchPhases"]
    """<p>An array of <code>BuildBatchPhase</code> objects the specify the phases of the batch build.</p>"""
    source: NotRequired["capo_codebuild.types.project_source.ProjectSource"]
    secondary_sources: NotRequired[
        "capo_codebuild.types.project_sources.ProjectSources"
    ]
    """<p>An array of <code>ProjectSource</code> objects that define the sources for the batch build.</p>"""
    secondary_source_versions: NotRequired[
        "capo_codebuild.types.project_secondary_source_versions.ProjectSecondarySourceVersions"
    ]
    """<p>An array of <code>ProjectSourceVersion</code> objects. Each <code>ProjectSourceVersion</code> must be one of: </p> <ul> <li> <p>For CodeCommit: the commit ID, branch, or Git tag to use.</p> </li> <li> <p>For 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 <code>pr/pull-request-ID</code> (for example, <code>pr/25</code>). 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.</p> </li> <li> <p>For 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.</p> </li> <li> <p>For Amazon S3: the version ID of the object that represents the build input ZIP file to use.</p> </li> </ul>"""
    artifacts: NotRequired["capo_codebuild.types.build_artifacts.BuildArtifacts"]
    """<p>A <code>BuildArtifacts</code> object the defines the build artifacts for this batch build.</p>"""
    secondary_artifacts: NotRequired[
        "capo_codebuild.types.build_artifacts_list.BuildArtifactsList"
    ]
    """<p>An array of <code>BuildArtifacts</code> objects the define the build artifacts for this batch build.</p>"""
    cache: NotRequired["capo_codebuild.types.project_cache.ProjectCache"]
    environment: NotRequired[
        "capo_codebuild.types.project_environment.ProjectEnvironment"
    ]
    service_role: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The name of a service role used for builds in the batch.</p>"""
    log_config: NotRequired["capo_codebuild.types.logs_config.LogsConfig"]
    build_timeout_in_minutes: NotRequired["capo_codebuild.types.wrapper_int.WrapperInt"]
    """<p>Specifies the maximum amount of time, in minutes, that the build in a batch must be completed in.</p>"""
    queued_timeout_in_minutes: NotRequired[
        "capo_codebuild.types.wrapper_int.WrapperInt"
    ]
    """<p>Specifies the amount of time, in minutes, that the batch build is allowed to be queued before it times out.</p>"""
    complete: "capo_codebuild.types.boolean.Boolean"
    """<p>Indicates if the batch build is complete.</p>"""
    initiator: NotRequired["capo_codebuild.types.string.String"]
    """<p>The entity that started the batch build. Valid values include:</p> <ul> <li> <p>If CodePipeline started the build, the pipeline's name (for example, <code>codepipeline/my-demo-pipeline</code>).</p> </li> <li> <p>If a user started the build, the user's name.</p> </li> <li> <p>If the Jenkins plugin for CodeBuild started the build, the string <code>CodeBuild-Jenkins-Plugin</code>.</p> </li> </ul>"""
    vpc_config: NotRequired["capo_codebuild.types.vpc_config.VpcConfig"]
    encryption_key: NotRequired["capo_codebuild.types.non_empty_string.NonEmptyString"]
    """<p>The Key Management Service customer master key (CMK) to be used for encrypting the batch build output artifacts.</p> <note> <p>You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key. </p> </note> <p>You can specify either the Amazon Resource Name (ARN) of the CMK or, if available, the CMK's alias (using the format <code>alias/<alias-name></code>).</p>"""
    build_batch_number: NotRequired["capo_codebuild.types.wrapper_long.WrapperLong"]
    """<p>The number of the batch build. For each project, the <code>buildBatchNumber</code> of its first batch build is <code>1</code>. The <code>buildBatchNumber</code> of each subsequent batch build is incremented by <code>1</code>. If a batch build is deleted, the <code>buildBatchNumber</code> of other batch builds does not change.</p>"""
    file_system_locations: NotRequired[
        "capo_codebuild.types.project_file_system_locations.ProjectFileSystemLocations"
    ]
    """<p>An array of <code>ProjectFileSystemLocation</code> objects for the batch build project. A <code>ProjectFileSystemLocation</code> object specifies the <code>identifier</code>, <code>location</code>, <code>mountOptions</code>, <code>mountPoint</code>, and <code>type</code> of a file system created using Amazon Elastic File System. </p>"""
    build_batch_config: NotRequired[
        "capo_codebuild.types.project_build_batch_config.ProjectBuildBatchConfig"
    ]
    build_groups: NotRequired["capo_codebuild.types.build_groups.BuildGroups"]
    """<p>An array of <code>BuildGroup</code> objects that define the build groups for the batch build.</p>"""
    debug_session_enabled: NotRequired[
        "capo_codebuild.types.wrapper_boolean.WrapperBoolean"
    ]
    """<p>Specifies if session debugging is enabled for this batch build. For more information, see <a href="https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html">Viewing a running build in Session Manager</a>. Batch session debugging is not supported for matrix batch builds.</p>"""
    report_arns: NotRequired["capo_codebuild.types.build_report_arns.BuildReportArns"]
    """<p>An array that contains the ARNs of reports created by merging reports from builds associated with this batch build.</p>"""