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

Inherits:

Struct

Object
Struct
Aws::CodeBuild::Types::UpdateProjectInput

show all

Includes:: Structure

Defined in:: lib/aws-sdk-codebuild/types.rb

Overview

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#artifacts ⇒ Types::ProjectArtifacts

Information to be changed about the build output artifacts for the build project.
#badge_enabled ⇒ Boolean

Set this to true to generate a publicly accessible URL for your project’s build badge.
#build_batch_config ⇒ Types::ProjectBuildBatchConfig

Contains configuration information about a batch build project.
#cache ⇒ Types::ProjectCache

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

The maximum number of concurrent builds that are allowed for this project.
#description ⇒ String

A new or replacement description of the build project.
#encryption_key ⇒ String

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
#environment ⇒ Types::ProjectEnvironment

Information to be changed about the build environment for the build project.
#file_system_locations ⇒ Array<Types::ProjectFileSystemLocation>

An array of ‘ProjectFileSystemLocation` objects for a CodeBuild build project.
#logs_config ⇒ Types::LogsConfig

Information about logs for the build project.
#name ⇒ String

The name of the build project.
#queued_timeout_in_minutes ⇒ Integer

The number of minutes a build is allowed to be queued before it times out.
#secondary_artifacts ⇒ Array<Types::ProjectArtifacts>

An array of ‘ProjectArtifact` objects.
#secondary_source_versions ⇒ Array<Types::ProjectSourceVersion>

An array of ‘ProjectSourceVersion` objects.
#secondary_sources ⇒ Array<Types::ProjectSource>

An array of ‘ProjectSource` objects.
#service_role ⇒ String

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.
#source ⇒ Types::ProjectSource

Information to be changed about the build input source code for the build project.
#source_version ⇒ String

A version of the build input to be built for this project.
#tags ⇒ Array<Types::Tag>

An updated list of tag key and value pairs associated with this build project.
#timeout_in_minutes ⇒ Integer

The replacement value in minutes, from 5 to 2160 (36 hours), for CodeBuild to wait before timing out any related build that did not get marked as completed.
#vpc_config ⇒ Types::VpcConfig

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

Instance Attribute Details

#artifacts ⇒ `Types::ProjectArtifacts`

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

Returns:

(Types::ProjectArtifacts)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_enabled ⇒ `Boolean`

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

Returns:

(Boolean)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_config ⇒ `Types::ProjectBuildBatchConfig`

Contains configuration information about a batch build project.

Returns:

(Types::ProjectBuildBatchConfig)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

#cache ⇒ `Types::ProjectCache`

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

Returns:

(Types::ProjectCache)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_limit ⇒ `Integer`

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)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

#description ⇒ `String`

A new or replacement description of the build project.

Returns:

(String)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_key ⇒ `String`

The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.

<note markdown=“1”> You can use a cross-account KMS key to encrypt the build output artifacts if your service role has permission to that key.

</note>

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)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

#environment ⇒ `Types::ProjectEnvironment`

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

Returns:

(Types::ProjectEnvironment)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_locations ⇒ `Array<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.

Returns:

(Array<Types::ProjectFileSystemLocation>)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_config ⇒ `Types::LogsConfig`

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

Returns:

(Types::LogsConfig)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

#name ⇒ `String`

The name of the build project.

<note markdown=“1”> You cannot change a build project’s name.

</note>

Returns:

(String)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_minutes ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_artifacts ⇒ `Array<Types::ProjectArtifacts>`

An array of ‘ProjectArtifact` objects.

Returns:

(Array<Types::ProjectArtifacts>)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_versions ⇒ `Array<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:

(Array<Types::ProjectSourceVersion>)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_sources ⇒ `Array<Types::ProjectSource>`

An array of ‘ProjectSource` objects.

Returns:

(Array<Types::ProjectSource>)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_role ⇒ `String`

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)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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 ⇒ `Types::ProjectSource`

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

Returns:

(Types::ProjectSource)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_version ⇒ `String`

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 GitLab: the commit ID, branch, or Git tag to use.
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*.

[1]: docs.aws.amazon.com/codebuild/latest/userguide/sample-source-version.html

Returns:

(String)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

#tags ⇒ `Array<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:

(Array<Types::Tag>)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_minutes ⇒ `Integer`

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

Returns:

(Integer)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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_config ⇒ `Types::VpcConfig`

VpcConfig enables CodeBuild to access resources in an Amazon VPC.

Returns:

(Types::VpcConfig)

# File 'lib/aws-sdk-codebuild/types.rb', line 6712

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

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

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#artifacts ⇒ Types::ProjectArtifacts

#badge_enabled ⇒ Boolean

#build_batch_config ⇒ Types::ProjectBuildBatchConfig

#cache ⇒ Types::ProjectCache

#concurrent_build_limit ⇒ Integer

#description ⇒ String

#encryption_key ⇒ String

#environment ⇒ Types::ProjectEnvironment

#file_system_locations ⇒ Array<Types::ProjectFileSystemLocation>

#logs_config ⇒ Types::LogsConfig

#name ⇒ String

#queued_timeout_in_minutes ⇒ Integer

#secondary_artifacts ⇒ Array<Types::ProjectArtifacts>

#secondary_source_versions ⇒ Array<Types::ProjectSourceVersion>

#secondary_sources ⇒ Array<Types::ProjectSource>

#service_role ⇒ String

#source ⇒ Types::ProjectSource

#source_version ⇒ String

#tags ⇒ Array<Types::Tag>

#timeout_in_minutes ⇒ Integer

#vpc_config ⇒ Types::VpcConfig

#artifacts ⇒ `Types::ProjectArtifacts`

#badge_enabled ⇒ `Boolean`

#build_batch_config ⇒ `Types::ProjectBuildBatchConfig`

#cache ⇒ `Types::ProjectCache`

#concurrent_build_limit ⇒ `Integer`

#description ⇒ `String`

#encryption_key ⇒ `String`

#environment ⇒ `Types::ProjectEnvironment`

#file_system_locations ⇒ `Array<Types::ProjectFileSystemLocation>`

#logs_config ⇒ `Types::LogsConfig`

#name ⇒ `String`

#queued_timeout_in_minutes ⇒ `Integer`

#secondary_artifacts ⇒ `Array<Types::ProjectArtifacts>`

#secondary_source_versions ⇒ `Array<Types::ProjectSourceVersion>`

#secondary_sources ⇒ `Array<Types::ProjectSource>`

#service_role ⇒ `String`

#source ⇒ `Types::ProjectSource`

#source_version ⇒ `String`

#tags ⇒ `Array<Types::Tag>`

#timeout_in_minutes ⇒ `Integer`

#vpc_config ⇒ `Types::VpcConfig`