Class: Aws::CodeBuild::Types::Project

Inherits:

Struct

Object
Struct
Aws::CodeBuild::Types::Project

show all

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

Overview

Information about a build project.

Constant Summary collapse

SENSITIVE =

[]

Instance Attribute Summary collapse

#arn ⇒ String
The Amazon Resource Name (ARN) of the build project.
#artifacts ⇒ Types::ProjectArtifacts
Information about the build output artifacts for the build project.
#auto_retry_limit ⇒ Integer
The maximum number of additional automatic retries after a failed build.
#badge ⇒ Types::ProjectBadge
Information about the build badge for the build project.
#build_batch_config ⇒ Types::ProjectBuildBatchConfig
A ProjectBuildBatchConfig object that defines the batch build options for the project.
#cache ⇒ Types::ProjectCache
Information about the cache for the build project.
#concurrent_build_limit ⇒ Integer
The maximum number of concurrent builds that are allowed for this project.
#created ⇒ Time
When the build project was created, expressed in Unix time format.
#description ⇒ String
A description that makes the build project easy to identify.
#encryption_key ⇒ String
The Key Management Service customer master key (CMK) to be used for encrypting the build output artifacts.
#environment ⇒ Types::ProjectEnvironment
Information about the build environment for this build project.
#file_system_locations ⇒ Array<Types::ProjectFileSystemLocation>
An array of ProjectFileSystemLocation objects for a CodeBuild build project.
#last_modified ⇒ Time
When the build project's settings were last modified, expressed in Unix time format.
#logs_config ⇒ Types::LogsConfig
Information about logs for the build project.
#name ⇒ String
The name of the build project.
#project_visibility ⇒ String
Specifies the visibility of the project's builds.
#public_project_alias ⇒ String
Contains the project identifier used with the public build APIs.
#queued_timeout_in_minutes ⇒ Integer
The number of minutes a build is allowed to be queued before it times out.
#resource_access_role ⇒ String
The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.
#secondary_artifacts ⇒ Array<Types::ProjectArtifacts>
An array of ProjectArtifacts 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 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 about the build input source code for this build project.
#source_version ⇒ String
A version of the build input to be built for this project.
#tags ⇒ Array<Types::Tag>
A list of tag key and value pairs associated with this build project.
#timeout_in_minutes ⇒ Integer
How long, 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
Information about the VPC configuration that CodeBuild accesses.
#webhook ⇒ Types::Webhook
Information about a webhook that connects repository events to a build project in CodeBuild.

Instance Attribute Details

#arn ⇒ `String`

The Amazon Resource Name (ARN) of the build project.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#artifacts ⇒ `Types::ProjectArtifacts`

Information about the build output artifacts for the build project.

Returns:

(Types::ProjectArtifacts)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#auto_retry_limit ⇒ `Integer`

The maximum number of additional automatic retries after a failed build. For example, if the auto-retry limit is set to 2, CodeBuild will call the RetryBuild API to automatically retry your build for up to 2 additional times.

Returns:

(Integer)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#badge ⇒ `Types::ProjectBadge`

Information about the build badge for the build project.

Returns:

(Types::ProjectBadge)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#build_batch_config ⇒ `Types::ProjectBuildBatchConfig`

A ProjectBuildBatchConfig object that defines the batch build options for the project.

Returns:

(Types::ProjectBuildBatchConfig)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#cache ⇒ `Types::ProjectCache`

Information about the cache for the build project.

Returns:

(Types::ProjectCache)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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.

Returns:

(Integer)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#created ⇒ `Time`

When the build project was created, expressed in Unix time format.

Returns:

(Time)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#description ⇒ `String`

A description that makes the build project easy to identify.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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.

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>). If you don't specify a value, CodeBuild uses the managed CMK for Amazon Simple Storage Service (Amazon S3).

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#environment ⇒ `Types::ProjectEnvironment`

Information about the build environment for this build project.

Returns:

(Types::ProjectEnvironment)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 4152

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#last_modified ⇒ `Time`

When the build project's settings were last modified, expressed in Unix time format.

Returns:

(Time)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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, an S3 bucket, or both.

Returns:

(Types::LogsConfig)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#name ⇒ `String`

The name of the build project.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#project_visibility ⇒ `String`

Specifies the visibility of the project's builds. Possible values are:

PUBLIC_READ: The project builds are visible to the public.
PRIVATE: The project builds are not visible to the public.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#public_project_alias ⇒ `String`

Contains the project identifier used with the public build APIs.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 4152

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#resource_access_role ⇒ `String`

The ARN of the IAM role that enables CodeBuild to access the CloudWatch Logs and Amazon S3 artifacts for the project's builds.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

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

An array of ProjectArtifacts objects.

Returns:

(Array<Types::ProjectArtifacts>)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 4152

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

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

An array of ProjectSource objects.

Returns:

(Array<Types::ProjectSource>)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#service_role ⇒ `String`

The 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 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 4152

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#source ⇒ `Types::ProjectSource`

Information about the build input source code for this build project.

Returns:

(Types::ProjectSource)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_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.

Returns:

(String)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

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

A 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 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 4152

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutes ⇒ `Integer`

How long, 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. The default is 60 minutes.

Returns:

(Integer)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_config ⇒ `Types::VpcConfig`

Information about the VPC configuration that CodeBuild accesses.

Returns:

(Types::VpcConfig)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

#webhook ⇒ `Types::Webhook`

Information about a webhook that connects repository events to a build project in CodeBuild.

Returns:

(Types::Webhook)

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

class Project < Struct.new(
  :name,
  :arn,
  :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,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge,
  :logs_config,
  :file_system_locations,
  :build_batch_config,
  :concurrent_build_limit,
  :project_visibility,
  :public_project_alias,
  :resource_access_role,
  :auto_retry_limit)
  SENSITIVE = []
  include Aws::Structure
end

Class: Aws::CodeBuild::Types::Project

Overview

Constant Summary collapse

Instance Attribute Summary collapse

Instance Attribute Details

#arn ⇒ String

#artifacts ⇒ Types::ProjectArtifacts

#auto_retry_limit ⇒ Integer

#badge ⇒ Types::ProjectBadge

#build_batch_config ⇒ Types::ProjectBuildBatchConfig

#cache ⇒ Types::ProjectCache

#concurrent_build_limit ⇒ Integer

#created ⇒ Time

#description ⇒ String

#encryption_key ⇒ String

#environment ⇒ Types::ProjectEnvironment

#file_system_locations ⇒ Array<Types::ProjectFileSystemLocation>

#last_modified ⇒ Time

#logs_config ⇒ Types::LogsConfig

#name ⇒ String

#project_visibility ⇒ String

#public_project_alias ⇒ String

#queued_timeout_in_minutes ⇒ Integer

#resource_access_role ⇒ String

#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

#webhook ⇒ Types::Webhook

#arn ⇒ `String`

#artifacts ⇒ `Types::ProjectArtifacts`

#auto_retry_limit ⇒ `Integer`

#badge ⇒ `Types::ProjectBadge`

#build_batch_config ⇒ `Types::ProjectBuildBatchConfig`

#cache ⇒ `Types::ProjectCache`

#concurrent_build_limit ⇒ `Integer`

#created ⇒ `Time`

#description ⇒ `String`

#encryption_key ⇒ `String`

#environment ⇒ `Types::ProjectEnvironment`

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

#last_modified ⇒ `Time`

#logs_config ⇒ `Types::LogsConfig`

#name ⇒ `String`

#project_visibility ⇒ `String`

#public_project_alias ⇒ `String`

#queued_timeout_in_minutes ⇒ `Integer`

#resource_access_role ⇒ `String`

#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`

#webhook ⇒ `Types::Webhook`