Class: Aws::CodeBuild::Types::UpdateProjectInput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb

Overview

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#artifactsTypes::ProjectArtifacts

Information to be changed about the build output artifacts for the build project.



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#badge_enabledBoolean

Set this to true to generate a publicly accessible URL for your project's build badge.

Returns:

  • (Boolean)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#build_batch_configTypes::ProjectBuildBatchConfig

Contains configuration information about a batch build project.



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#cacheTypes::ProjectCache

Stores recently used information so that it can be quickly accessed at a later time.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#concurrent_build_limitInteger

The maximum number of concurrent builds that are allowed for this project.

New builds are only started if the current number of builds is less than or equal to this limit. If the current build count meets this limit, new builds are throttled and are not run.

To remove this limit, set this value to -1.

Returns:

  • (Integer)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A new or replacement description of the build project.

Returns:

  • (String)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_keyString

The Key Management Service customer master key (CMK) to be used for encrypting 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>).

Returns:

  • (String)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#environmentTypes::ProjectEnvironment

Information to be changed about the build environment for the build project.



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#file_system_locationsArray<Types::ProjectFileSystemLocation>

An array of ProjectFileSystemLocation objects for a CodeBuild build project. A ProjectFileSystemLocation object specifies the identifier, location, mountOptions, mountPoint, and type of a file system created using Amazon Elastic File System.



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#logs_configTypes::LogsConfig

Information about logs for the build project. A project can create logs in CloudWatch Logs, logs in an S3 bucket, or both.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the build project.

You cannot change a build project's name.

Returns:

  • (String)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#queued_timeout_in_minutesInteger

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

Returns:

  • (Integer)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_artifactsArray<Types::ProjectArtifacts>

An array of ProjectArtifact objects.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_source_versionsArray<Types::ProjectSourceVersion>

An array of ProjectSourceVersion objects. If secondarySourceVersions is specified at the build level, then they take over these secondarySourceVersions (at the project level).

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_sourcesArray<Types::ProjectSource>

An array of ProjectSource objects.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#service_roleString

The replacement ARN of the IAM role that enables CodeBuild to interact with dependent Amazon Web Services services on behalf of the Amazon Web Services account.

Returns:

  • (String)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#sourceTypes::ProjectSource

Information to be changed about the build input source code for the build project.



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#source_versionString

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

  • For CodeCommit: the commit ID, branch, or Git tag 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 is used. If not specified, the default branch's HEAD commit ID is 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 is used. If not specified, the default branch's HEAD commit ID is used.

  • For Amazon S3: the version ID of the object that represents the build input ZIP file to use.

If sourceVersion is specified at the build level, then that version takes precedence over this sourceVersion (at the project level).

For more information, see Source Version Sample with CodeBuild in the CodeBuild User Guide.

Returns:

  • (String)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

An updated list of tag key and value pairs associated with this build project.

These tags are available for use by Amazon Web Services services that support CodeBuild build project tags.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutesInteger

The replacement value in minutes, from 5 to 480 (8 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.

Returns:

  • (Integer)


6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

Returns:



6559
6560
6561
6562
6563
6564
6565
6566
6567
6568
6569
6570
6571
6572
6573
6574
6575
6576
6577
6578
6579
6580
6581
6582
6583
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 6559

class UpdateProjectInput < Struct.new(
  :name,
  :description,
  :source,
  :secondary_sources,
  :source_version,
  :secondary_source_versions,
  :artifacts,
  :secondary_artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :queued_timeout_in_minutes,
  :encryption_key,
  :tags,
  :vpc_config,
  :badge_enabled,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit)
  SENSITIVE = []
  include Aws::Structure
end