/ 
Paws-0.38
River stage two • 9 direct dependents • 11 total dependents
/ Paws::CodeBuild::StartBuild

NAME

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

DESCRIPTION

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

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

SYNOPSIS

my $codebuild = Paws->service('CodeBuild');
my $StartBuildOutput = $codebuild->StartBuild(
  ProjectName       => 'MyNonEmptyString',
  ArtifactsOverride => {
    type     => 'CODEPIPELINE',    # values: CODEPIPELINE, S3, NO_ARTIFACTS
    location => 'MyString',        # OPTIONAL
    name     => 'MyString',        # OPTIONAL
    namespaceType => 'NONE',       # values: NONE, BUILD_ID; OPTIONAL
    packaging     => 'NONE',       # values: NONE, ZIP; OPTIONAL
    path          => 'MyString',   # OPTIONAL
  },    # OPTIONAL
  BuildspecOverride => 'MyString',    # OPTIONAL
  CacheOverride     => {
    type     => 'NO_CACHE',           # values: NO_CACHE, S3
    location => 'MyString',           # OPTIONAL
  },    # OPTIONAL
  CertificateOverride          => 'MyString',                # OPTIONAL
  ComputeTypeOverride          => 'BUILD_GENERAL1_SMALL',    # OPTIONAL
  EnvironmentTypeOverride      => 'WINDOWS_CONTAINER',       # OPTIONAL
  EnvironmentVariablesOverride => [
    {
      name  => 'MyNonEmptyString',                           # min: 1,
      value => 'MyString',                                   # OPTIONAL
      type => 'PLAINTEXT',    # values: PLAINTEXT, PARAMETER_STORE; OPTIONAL
    },
    ...
  ],                          # OPTIONAL
  GitCloneDepthOverride  => 1,                     # OPTIONAL
  IdempotencyToken       => 'MyString',            # OPTIONAL
  ImageOverride          => 'MyNonEmptyString',    # OPTIONAL
  InsecureSslOverride    => 1,                     # OPTIONAL
  PrivilegedModeOverride => 1,                     # OPTIONAL
  ServiceRoleOverride    => 'MyNonEmptyString',    # OPTIONAL
  SourceAuthOverride     => {
    type     => 'OAUTH',                           # values: OAUTH
    resource => 'MyString',                        # OPTIONAL
  },    # OPTIONAL
  SourceLocationOverride   => 'MyString',      # OPTIONAL
  SourceTypeOverride       => 'CODECOMMIT',    # OPTIONAL
  SourceVersion            => 'MyString',      # OPTIONAL
  TimeoutInMinutesOverride => 1,               # OPTIONAL
);

# Results:
my $Build = $StartBuildOutput->Build;

# Returns a L<Paws::CodeBuild::StartBuildOutput> 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/StartBuild

ATTRIBUTES

ArtifactsOverride => Paws::CodeBuild::ProjectArtifacts

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

BuildspecOverride => Str

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

CacheOverride => Paws::CodeBuild::ProjectCache

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

CertificateOverride => Str

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

ComputeTypeOverride => Str

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

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

EnvironmentTypeOverride => Str

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

Valid values are: "WINDOWS_CONTAINER", "LINUX_CONTAINER"

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

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

GitCloneDepthOverride => Int

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.

IdempotencyToken => Str

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 12 hours. If you repeat the StartBuild request with the same token, but change a parameter, AWS CodeBuild returns a parameter mismatch error.

ImageOverride => Str

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

InsecureSslOverride => Bool

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.

PrivilegedModeOverride => Bool

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

REQUIRED ProjectName => Str

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

ServiceRoleOverride => Str

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

SourceAuthOverride => Paws::CodeBuild::SourceAuth

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.

SourceLocationOverride => Str

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

SourceTypeOverride => Str

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

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

SourceVersion => Str

A version of the build input to be built, for this build only. If not specified, the latest version will be used. If specified, must be one of:

  • For AWS CodeCommit: the commit ID to use.

  • 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 pr/pull-request-ID (for example pr/25). If a branch name is specified, the branch's HEAD commit ID will be used. If not specified, the default branch's HEAD commit ID will be used.

  • 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 will be used. If not specified, the default branch's HEAD commit ID will be used.

  • For Amazon Simple Storage Service (Amazon S3): the version ID of the object representing the build input ZIP file to use.

TimeoutInMinutesOverride => Int

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.

SEE ALSO

This class forms part of Paws, documenting arguments for method StartBuild in Paws::CodeBuild

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