NAME

Paws::CodeBuild::StartBuildBatch - Arguments for method StartBuildBatch on Paws::CodeBuild

DESCRIPTION

This class represents the parameters used for calling the method StartBuildBatch on the AWS CodeBuild service. Use the attributes of this class as arguments to method StartBuildBatch.

You shouldn't make instances of this class. Each attribute should be used as a named argument in the call to StartBuildBatch.

SYNOPSIS

    my $codebuild = Paws->service('CodeBuild');
    my $StartBuildBatchOutput = $codebuild->StartBuildBatch(
      ProjectName       => 'MyNonEmptyString',
      ArtifactsOverride => {
        Type => 'CODEPIPELINE',    # values: CODEPIPELINE, S3, NO_ARTIFACTS
        ArtifactIdentifier   => 'MyString',   # OPTIONAL
        EncryptionDisabled   => 1,            # OPTIONAL
        Location             => 'MyString',   # OPTIONAL
        Name                 => 'MyString',   # OPTIONAL
        NamespaceType        => 'NONE',       # values: NONE, BUILD_ID; OPTIONAL
        OverrideArtifactName => 1,            # OPTIONAL
        Packaging            => 'NONE',       # values: NONE, ZIP; OPTIONAL
        Path                 => 'MyString',   # OPTIONAL
      },    # OPTIONAL
      BuildBatchConfigOverride => {
        CombineArtifacts => 1,    # OPTIONAL
        Restrictions     => {
          ComputeTypesAllowed => [
            'MyNonEmptyString', ...    # min: 1
          ],    # OPTIONAL
          MaximumBuildsAllowed => 1,    # OPTIONAL
        },    # OPTIONAL
        ServiceRole   => 'MyNonEmptyString',    # min: 1
        TimeoutInMins => 1,                     # OPTIONAL
      },    # OPTIONAL
      BuildTimeoutInMinutesOverride => 1,             # OPTIONAL
      BuildspecOverride             => 'MyString',    # OPTIONAL
      CacheOverride                 => {
        Type     => 'NO_CACHE',    # values: NO_CACHE, S3, LOCAL
        Location => 'MyString',    # OPTIONAL
        Modes    => [
          'LOCAL_DOCKER_LAYER_CACHE',
          ... # values: LOCAL_DOCKER_LAYER_CACHE, LOCAL_SOURCE_CACHE, LOCAL_CUSTOM_CACHE
        ],    # OPTIONAL
      },    # OPTIONAL
      CertificateOverride          => 'MyString',                # OPTIONAL
      ComputeTypeOverride          => 'BUILD_GENERAL1_SMALL',    # OPTIONAL
      DebugSessionEnabled          => 1,                         # OPTIONAL
      EncryptionKeyOverride        => 'MyNonEmptyString',        # OPTIONAL
      EnvironmentTypeOverride      => 'WINDOWS_CONTAINER',       # OPTIONAL
      EnvironmentVariablesOverride => [
        {
          Name  => 'MyNonEmptyString',    # min: 1
          Value => 'MyString',            # OPTIONAL
          Type  => 'PLAINTEXT'
          ,    # values: PLAINTEXT, PARAMETER_STORE, SECRETS_MANAGER; OPTIONAL
        },
        ...
      ],    # OPTIONAL
      GitCloneDepthOverride       => 1,    # OPTIONAL
      GitSubmodulesConfigOverride => {
        FetchSubmodules => 1,              # OPTIONAL
      },    # OPTIONAL
      IdempotencyToken                 => 'MyString',            # OPTIONAL
      ImageOverride                    => 'MyNonEmptyString',    # OPTIONAL
      ImagePullCredentialsTypeOverride => 'CODEBUILD',           # OPTIONAL
      InsecureSslOverride              => 1,                     # OPTIONAL
      LogsConfigOverride               => {
        CloudWatchLogs => {
          Status     => 'ENABLED',     # values: ENABLED, DISABLED
          GroupName  => 'MyString',    # OPTIONAL
          StreamName => 'MyString',    # OPTIONAL
        },    # OPTIONAL
        S3Logs => {
          Status             => 'ENABLED',     # values: ENABLED, DISABLED
          EncryptionDisabled => 1,             # OPTIONAL
          Location           => 'MyString',    # OPTIONAL
        },    # OPTIONAL
      },    # OPTIONAL
      PrivilegedModeOverride         => 1,    # OPTIONAL
      QueuedTimeoutInMinutesOverride => 1,    # OPTIONAL
      RegistryCredentialOverride     => {
        Credential         => 'MyNonEmptyString',    # min: 1
        CredentialProvider => 'SECRETS_MANAGER',     # values: SECRETS_MANAGER
      },    # OPTIONAL
      ReportBuildBatchStatusOverride => 1,    # OPTIONAL
      SecondaryArtifactsOverride     => [
        {
          Type => 'CODEPIPELINE',    # values: CODEPIPELINE, S3, NO_ARTIFACTS
          ArtifactIdentifier   => 'MyString', # OPTIONAL
          EncryptionDisabled   => 1,          # OPTIONAL
          Location             => 'MyString', # OPTIONAL
          Name                 => 'MyString', # OPTIONAL
          NamespaceType        => 'NONE',     # values: NONE, BUILD_ID; OPTIONAL
          OverrideArtifactName => 1,          # OPTIONAL
          Packaging            => 'NONE',     # values: NONE, ZIP; OPTIONAL
          Path                 => 'MyString', # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      SecondarySourcesOverride => [
        {
          Type => 'CODECOMMIT'
          , # values: CODECOMMIT, CODEPIPELINE, GITHUB, S3, BITBUCKET, GITHUB_ENTERPRISE, NO_SOURCE
          Auth => {
            Type     => 'OAUTH',       # values: OAUTH
            Resource => 'MyString',    # OPTIONAL
          },    # OPTIONAL
          BuildStatusConfig => {
            Context   => 'MyString',    # OPTIONAL
            TargetUrl => 'MyString',    # OPTIONAL
          },    # OPTIONAL
          Buildspec           => 'MyString',    # OPTIONAL
          GitCloneDepth       => 1,
          GitSubmodulesConfig => {
            FetchSubmodules => 1,               # OPTIONAL
          },
          InsecureSsl       => 1,             # OPTIONAL
          Location          => 'MyString',    # OPTIONAL
          ReportBuildStatus => 1,             # OPTIONAL
          SourceIdentifier  => 'MyString',    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      SecondarySourcesVersionOverride => [
        {
          SourceIdentifier => 'MyString',    # OPTIONAL
          SourceVersion    => 'MyString',    # OPTIONAL
        },
        ...
      ],    # OPTIONAL
      ServiceRoleOverride => 'MyNonEmptyString',    # OPTIONAL
      SourceAuthOverride  => {
        Type     => 'OAUTH',                        # values: OAUTH
        Resource => 'MyString',                     # OPTIONAL
      },    # OPTIONAL
      SourceLocationOverride => 'MyString',      # OPTIONAL
      SourceTypeOverride     => 'CODECOMMIT',    # OPTIONAL
      SourceVersion          => 'MyString',      # OPTIONAL
    );
    # Results:
    my $BuildBatch = $StartBuildBatchOutput->BuildBatch;
    # Returns a L<Paws::CodeBuild::StartBuildBatchOutput> object.

Values for attributes that are native types (Int, String, Float, etc) can passed as-is (scalar values). Values for complex Types (objects) can be passed as a HashRef. The keys and values of the hashref will be used to instance the underlying object. For the AWS API documentation, see <https://docs.aws.amazon.com/goto/WebAPI/codebuild/StartBuildBatch>

ATTRIBUTES

ArtifactsOverride => Paws::CodeBuild::ProjectArtifacts

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

BuildBatchConfigOverride => Paws::CodeBuild::ProjectBuildBatchConfig

A "BuildBatchConfigOverride" object that contains batch build configuration overrides.

BuildspecOverride => Str

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 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 (https://docs.aws.amazon.com/codebuild/latest/userguide/build-spec-ref.html#build-spec-ref-name-storage).

BuildTimeoutInMinutesOverride => Int

Overrides the build timeout specified in the batch build project.

CacheOverride => Paws::CodeBuild::ProjectCache

A "ProjectCache" object that specifies cache overrides.

CertificateOverride => Str

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

ComputeTypeOverride => Str

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

Valid values are: "BUILD_GENERAL1_SMALL", "BUILD_GENERAL1_MEDIUM", "BUILD_GENERAL1_LARGE", "BUILD_GENERAL1_2XLARGE"

DebugSessionEnabled => Bool

Specifies if session debugging is enabled for this batch build. For more information, see Viewing a running build in Session Manager (https://docs.aws.amazon.com/codebuild/latest/userguide/session-manager.html). Batch session debugging is not supported for matrix batch builds.

EncryptionKeyOverride => Str

The Key Management Service 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>").

EnvironmentTypeOverride => Str

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

Valid values are: "WINDOWS_CONTAINER", "LINUX_CONTAINER", "LINUX_GPU_CONTAINER", "ARM_CONTAINER", "WINDOWS_SERVER_2019_CONTAINER"

EnvironmentVariablesOverride => ArrayRef[Paws::CodeBuild::EnvironmentVariable]

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

GitCloneDepthOverride => Int

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.

GitSubmodulesConfigOverride => Paws::CodeBuild::GitSubmodulesConfig

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

IdempotencyToken => Str

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, CodeBuild returns a parameter mismatch error.

ImageOverride => Str

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

ImagePullCredentialsTypeOverride => Str

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

CODEBUILD: Specifies that CodeBuild uses its own credentials. This requires that you modify your ECR repository policy to trust CodeBuild's service principal.
SERVICE_ROLE: Specifies that 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 CodeBuild curated image, you must use "CODEBUILD" credentials.

Valid values are: "CODEBUILD", "SERVICE_ROLE"

InsecureSslOverride => Bool

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.

LogsConfigOverride => Paws::CodeBuild::LogsConfig

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

PrivilegedModeOverride => Bool

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

REQUIRED ProjectName => Str

The name of the project.

QueuedTimeoutInMinutesOverride => Int

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

RegistryCredentialOverride => Paws::CodeBuild::RegistryCredential

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

ReportBuildBatchStatusOverride => Bool

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.

SecondaryArtifactsOverride => ArrayRef[Paws::CodeBuild::ProjectArtifacts]

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

SecondarySourcesOverride => ArrayRef[Paws::CodeBuild::ProjectSource]

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

SecondarySourcesVersionOverride => ArrayRef[Paws::CodeBuild::ProjectSourceVersion]

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

ServiceRoleOverride => Str

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

SourceAuthOverride => Paws::CodeBuild::SourceAuth

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.

SourceLocationOverride => Str

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

SourceTypeOverride => Str

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

Valid values are: "CODECOMMIT", "CODEPIPELINE", "GITHUB", "S3", "BITBUCKET", "GITHUB_ENTERPRISE", "NO_SOURCE"

SourceVersion => Str

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:

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 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 (https://docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html) in the CodeBuild User Guide.

BUGS and CONTRIBUTIONS

The source code is located here: <https://github.com/pplu/aws-sdk-perl>

Please report bugs to: <https://github.com/pplu/aws-sdk-perl/issues>