You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

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

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

Overview

Information about a build project.

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

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

Returns:

  • (String)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#artifactsTypes::ProjectArtifacts

Information about the build output artifacts for the build project.



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#badgeTypes::ProjectBadge

Information about the build badge for the build project.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#cacheTypes::ProjectCache

Information about the cache for the build project.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#createdTime

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

Returns:

  • (Time)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#descriptionString

A description that makes the build project easy to identify.

Returns:

  • (String)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#encryption_keyString

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

This is expressed either as the CMK's Amazon Resource Name (ARN) or, if specified, the CMK's alias (using the format alias/alias-name).

Returns:

  • (String)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#environmentTypes::ProjectEnvironment

Information about the build environment for this build project.



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#last_modifiedTime

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

Returns:

  • (Time)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#nameString

The name of the build project.

Returns:

  • (String)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#service_roleString

The ARN of the AWS Identity and Access Management (IAM) role that enables AWS CodeBuild to interact with dependent AWS services on behalf of the AWS account.

Returns:

  • (String)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#sourceTypes::ProjectSource

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



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#tagsArray<Types::Tag>

The tags for this build project.

These tags are available for use by AWS services that support AWS CodeBuild build project tags.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#timeout_in_minutesInteger

How long, in minutes, from 5 to 480 (8 hours), for AWS CodeBuild to wait before timing out any related build that did not get marked as completed. The default is 60 minutes.

Returns:

  • (Integer)


1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#vpc_configTypes::VpcConfig

Information about the VPC configuration that AWS CodeBuild will access.

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end

#webhookTypes::Webhook

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

Returns:



1105
1106
1107
1108
1109
1110
1111
1112
1113
1114
1115
1116
1117
1118
1119
1120
1121
1122
1123
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1105

class Project < Struct.new(
  :name,
  :arn,
  :description,
  :source,
  :artifacts,
  :cache,
  :environment,
  :service_role,
  :timeout_in_minutes,
  :encryption_key,
  :tags,
  :created,
  :last_modified,
  :webhook,
  :vpc_config,
  :badge)
  include Aws::Structure
end