StartBuildBatchInput Structure Reference


                    
                    
                    _members

Declaration

Swift

public static var _members: [AWSShapeMember]


                    
                    
                    artifactsOverride

An array of ProjectArtifacts objects that contains information about the build output artifact overrides for the build project.

Declaration

Swift

public let artifactsOverride: ProjectArtifacts?


                    
                    
                    buildBatchConfigOverride

A BuildBatchConfigOverride object that contains batch build configuration overrides.

Declaration

Swift

public let buildBatchConfigOverride: ProjectBuildBatchConfig?


                    
                    
                    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.

Declaration

Swift

public let buildspecOverride: String?


                    
                    
                    buildTimeoutInMinutesOverride

Overrides the build timeout specified in the batch build project.

Declaration

Swift

public let buildTimeoutInMinutesOverride: Int?


                    
                    
                    cacheOverride

A ProjectCache object that specifies cache overrides.

Declaration

Swift

public let cacheOverride: ProjectCache?


                    
                    
                    certificateOverride

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

Declaration

Swift

public let certificateOverride: String?


                    
                    
                    computeTypeOverride

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

Declaration

Swift

public let computeTypeOverride: ComputeType?


                    
                    
                    encryptionKeyOverride

The AWS Key Management Service (AWS KMS) customer master key (CMK) that overrides the one specified in the batch 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>).

Declaration

Swift

public let encryptionKeyOverride: String?


                    
                    
                    environmentTypeOverride

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

Declaration

Swift

public let environmentTypeOverride: EnvironmentType?


                    
                    
                    environmentVariablesOverride

An array of EnvironmentVariable objects that override, or add to, the environment variables defined in the batch build project.

Declaration

Swift

public let environmentVariablesOverride: [EnvironmentVariable]?


                    
                    
                    gitCloneDepthOverride

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

Declaration

Swift

public let gitCloneDepthOverride: Int?


                    
                    
                    gitSubmodulesConfigOverride

A GitSubmodulesConfig object that overrides the Git submodules configuration for this batch build.

Declaration

Swift

public let gitSubmodulesConfigOverride: GitSubmodulesConfig?


                    
                    
                    idempotencyToken

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

Declaration

Swift

public let idempotencyToken: String?


                    
                    
                    imageOverride

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

Declaration

Swift

public let imageOverride: String?


                    
                    
                    imagePullCredentialsTypeOverride

The type of credentials AWS CodeBuild uses to pull images in your batch 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.

Declaration

Swift

public let imagePullCredentialsTypeOverride: ImagePullCredentialsType?


                    
                    
                    insecureSslOverride

Enable this flag to override the insecure SSL setting that is specified in the batch 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.

Declaration

Swift

public let insecureSslOverride: Bool?


                    
                    
                    logsConfigOverride

A LogsConfig object that override the log settings defined in the batch build project.

Declaration

Swift

public let logsConfigOverride: LogsConfig?


                    
                    
                    privilegedModeOverride

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

Declaration

Swift

public let privilegedModeOverride: Bool?


                    
                    
                    projectName

The name of the project.

Declaration

Swift

public let projectName: String


                    
                    
                    queuedTimeoutInMinutesOverride

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

Declaration

Swift

public let queuedTimeoutInMinutesOverride: Int?


                    
                    
                    registryCredentialOverride

A RegistryCredential object that overrides credentials for access to a private registry.

Declaration

Swift

public let registryCredentialOverride: RegistryCredential?


                    
                    
                    reportBuildBatchStatusOverride

Set to true to report to your source provider the status of a batch 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.

Declaration

Swift

public let reportBuildBatchStatusOverride: Bool?


                    
                    
                    secondaryArtifactsOverride

An array of ProjectArtifacts objects that override the secondary artifacts defined in the batch build project.

Declaration

Swift

public let secondaryArtifactsOverride: [ProjectArtifacts]?


                    
                    
                    secondarySourcesOverride

An array of ProjectSource objects that override the secondary sources defined in the batch build project.

Declaration

Swift

public let secondarySourcesOverride: [ProjectSource]?


                    
                    
                    secondarySourcesVersionOverride

An array of ProjectSourceVersion objects that override the secondary source versions in the batch build project.

Declaration

Swift

public let secondarySourcesVersionOverride: [ProjectSourceVersion]?


                    
                    
                    serviceRoleOverride

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

Declaration

Swift

public let serviceRoleOverride: String?


                    
                    
                    sourceAuthOverride

A SourceAuth object that overrides the one defined in the batch build project. This override applies only if the build project’s source is BitBucket or GitHub.

Declaration

Swift

public let sourceAuthOverride: SourceAuth?


                    
                    
                    sourceLocationOverride

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

Declaration

Swift

public let sourceLocationOverride: String?


                    
                    
                    sourceTypeOverride

The source input type that overrides the source input defined in the batch build project.

Declaration

Swift

public let sourceTypeOverride: SourceType?


                    
                    
                    sourceVersion

The version of the batch 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.

Declaration

Swift

public let sourceVersion: String?


                    
                    
                    init(artifactsOverride:buildBatchConfigOverride:buildspecOverride:buildTimeoutInMinutesOverride:cacheOverride:certificateOverride:computeTypeOverride:encryptionKeyOverride:environmentTypeOverride:environmentVariablesOverride:gitCloneDepthOverride:gitSubmodulesConfigOverride:idempotencyToken:imageOverride:imagePullCredentialsTypeOverride:insecureSslOverride:logsConfigOverride:privilegedModeOverride:projectName:queuedTimeoutInMinutesOverride:registryCredentialOverride:reportBuildBatchStatusOverride:secondaryArtifactsOverride:secondarySourcesOverride:secondarySourcesVersionOverride:serviceRoleOverride:sourceAuthOverride:sourceLocationOverride:sourceTypeOverride:sourceVersion:)

Undocumented

Declaration

Swift

public init(artifactsOverride: ProjectArtifacts? = nil, buildBatchConfigOverride: ProjectBuildBatchConfig? = nil, buildspecOverride: String? = nil, buildTimeoutInMinutesOverride: Int? = nil, cacheOverride: ProjectCache? = nil, certificateOverride: String? = nil, computeTypeOverride: ComputeType? = nil, encryptionKeyOverride: String? = nil, environmentTypeOverride: EnvironmentType? = nil, environmentVariablesOverride: [EnvironmentVariable]? = nil, gitCloneDepthOverride: Int? = nil, gitSubmodulesConfigOverride: GitSubmodulesConfig? = nil, idempotencyToken: String? = nil, imageOverride: String? = nil, imagePullCredentialsTypeOverride: ImagePullCredentialsType? = nil, insecureSslOverride: Bool? = nil, logsConfigOverride: LogsConfig? = nil, privilegedModeOverride: Bool? = nil, projectName: String, queuedTimeoutInMinutesOverride: Int? = nil, registryCredentialOverride: RegistryCredential? = nil, reportBuildBatchStatusOverride: Bool? = nil, secondaryArtifactsOverride: [ProjectArtifacts]? = nil, secondarySourcesOverride: [ProjectSource]? = nil, secondarySourcesVersionOverride: [ProjectSourceVersion]? = nil, serviceRoleOverride: String? = nil, sourceAuthOverride: SourceAuth? = nil, sourceLocationOverride: String? = nil, sourceTypeOverride: SourceType? = nil, sourceVersion: String? = nil)


                    
                    
                    validate(name:)

Declaration

Swift

public func validate(name: String) throws