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

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

Overview

Information about a build project.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#artifactsTypes::ProjectArtifacts

Information about the build output artifacts for the build project.



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#badgeTypes::ProjectBadge

Information about the build badge for the build project.

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#build_batch_configTypes::ProjectBuildBatchConfig

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



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#cacheTypes::ProjectCache

Information about the cache for the build project.

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  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.

Returns:

  • (Integer)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#createdTime

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

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description that makes the build project easy to identify.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#encryption_keyString

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

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#environmentTypes::ProjectEnvironment

Information about the build environment for this build project.



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  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.



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#last_modifiedTime

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

Returns:

  • (Time)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#logs_configTypes::LogsConfig

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

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the build project.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#project_visibilityString

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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#public_project_aliasString

Contains the project identifier used with the public build APIs.

Returns:

  • (String)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#resource_access_roleString

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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_artifactsArray<Types::ProjectArtifacts>

An array of ‘ProjectArtifacts` objects.

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  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:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#secondary_sourcesArray<Types::ProjectSource>

An array of ‘ProjectSource` objects.

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#service_roleString

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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#sourceTypes::ProjectSource

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



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  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 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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<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:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#timeout_in_minutesInteger

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)


3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

Information about the VPC configuration that CodeBuild accesses.

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end

#webhookTypes::Webhook

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

Returns:



3918
3919
3920
3921
3922
3923
3924
3925
3926
3927
3928
3929
3930
3931
3932
3933
3934
3935
3936
3937
3938
3939
3940
3941
3942
3943
3944
3945
3946
3947
3948
3949
# File 'lib/aws-sdk-codebuild/types.rb', line 3918

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)
  SENSITIVE = []
  include Aws::Structure
end