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

Class: Aws::CodeBuild::Types::ProjectArtifacts

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

Overview

Note:

When making an API call, you may pass ProjectArtifacts data as a hash:

{
  type: "CODEPIPELINE", # required, accepts CODEPIPELINE, S3, NO_ARTIFACTS
  location: "String",
  path: "String",
  namespace_type: "NONE", # accepts NONE, BUILD_ID
  name: "String",
  packaging: "NONE", # accepts NONE, ZIP
}

Information about the build output artifacts for the build project.

Instance Attribute Summary collapse

Instance Attribute Details

#locationString

Information about the build output artifact location, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output locations instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output bucket.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end

#nameString

Along with path and namespaceType, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the name of the output artifact object.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end

#namespace_typeString

Along with path and name, the pattern that AWS CodeBuild will use to determine the name and location to store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, then valid values include:

    • BUILD_ID: Include the build ID in the location of the build output artifact.

    • NONE: Do not include the build ID. This is the default if namespaceType is not specified.

For example, if path is set to MyArtifacts, namespaceType is set to BUILD_ID, and name is set to MyArtifact.zip, then the output artifact would be stored in MyArtifacts/build-ID/MyArtifact.zip.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end

#packagingString

The type of build output artifact to create, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output artifacts instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, valid values include:

    • NONE: AWS CodeBuild will create in the output bucket a folder containing the build output. This is the default if packaging is not specified.

    • ZIP: AWS CodeBuild will create in the output bucket a ZIP file containing the build output.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end

#pathString

Along with namespaceType and name, the pattern that AWS CodeBuild will use to name and store the output artifact, as follows:

  • If type is set to CODEPIPELINE, then AWS CodePipeline will ignore this value if specified. This is because AWS CodePipeline manages its build output names instead of AWS CodeBuild.

  • If type is set to NO_ARTIFACTS, then this value will be ignored if specified, because no build output will be produced.

  • If type is set to S3, this is the path to the output artifact. If path is not specified, then path will not be used.

For example, if path is set to MyArtifacts, namespaceType is set to NONE, and name is set to MyArtifact.zip, then the output artifact would be stored in the output bucket at MyArtifacts/MyArtifact.zip.

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end

#typeString

The type of build output artifact. Valid values include:

  • CODEPIPELINE: The build project will have build output generated through AWS CodePipeline.

  • NO_ARTIFACTS: The build project will not produce any build output.

  • S3: The build project will store build output in Amazon Simple Storage Service (Amazon S3).

Returns:

  • (String)


1127
1128
1129
1130
1131
1132
1133
1134
1135
# File 'gems/aws-sdk-codebuild/lib/aws-sdk-codebuild/types.rb', line 1127

class ProjectArtifacts < Struct.new(
  :type,
  :location,
  :path,
  :namespace_type,
  :name,
  :packaging)
  include Aws::Structure
end