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

Inherits:
Struct
  • Object
show all
Includes:
Structure
Defined in:
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
  override_artifact_name: false,
  encryption_disabled: false,
  artifact_identifier: "String",
}

Information about the build output artifacts for the build project.

See Also:

Instance Attribute Summary collapse

Instance Attribute Details

#artifact_identifier ⇒ String

An identifier for this artifact definition.

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#encryption_disabled ⇒ Boolean

Set to true if you do not want your output artifacts encrypted. This option is valid only if your artifacts type is Amazon Simple Storage Service (Amazon S3). If this is set with another artifacts type, an invalidInputException is thrown.

Returns:

  • (Boolean) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#location ⇒ String

Information about the build output artifact location:

  • If ‘type` is set to `CODEPIPELINE`, AWS CodePipeline ignores 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`, this value is ignored if specified, because no build output is produced.

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

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#name ⇒ String

Along with ‘path` and `namespaceType`, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If ‘type` is set to `CODEPIPELINE`, AWS CodePipeline ignores 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`, this value is ignored if specified, because no build output is produced.

  • If ‘type` is set to `S3`, this is the name of the output artifact object. If you set the name to be a forward slash (“/”), the artifact is stored in the root of the output bucket.

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 is stored in `MyArtifacts/build-ID/MyArtifact.zip`.

  • If ‘path` is empty, `namespaceType` is set to `NONE`, and `name` is set to “`/`”, the output artifact is stored in the root of the output bucket.

  • If ‘path` is set to `MyArtifacts`, `namespaceType` is set to `BUILD_ID`, and `name` is set to “`/`”, the output artifact is stored in `MyArtifacts/build-ID `.

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#namespace_type ⇒ String

Along with ‘path` and `name`, the pattern that AWS CodeBuild uses to determine the name and location to store the output artifact:

  • If ‘type` is set to `CODEPIPELINE`, AWS CodePipeline ignores 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`, this value is ignored if specified, because no build output is produced.

  • If ‘type` is set to `S3`, 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`, the output artifact is stored in `MyArtifacts/build-ID/MyArtifact.zip`.

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#override_artifact_name ⇒ Boolean

If this flag is set, a name specified in the build spec file overrides the artifact name. The name specified in a build spec file is calculated at build time and uses the Shell Command Language. For example, you can append a date and time to your artifact name so that it is always unique.

Returns:

  • (Boolean) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#packaging ⇒ String

The type of build output artifact to create:

  • If ‘type` is set to `CODEPIPELINE`, AWS CodePipeline ignores 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`, this value is ignored if specified, because no build output is produced.

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

    • ‘NONE`: AWS CodeBuild creates in the output bucket a folder that contains the build output. This is the default if `packaging` is not specified.

    • ‘ZIP`: AWS CodeBuild creates in the output bucket a ZIP file that contains the build output.

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#path ⇒ String

Along with ‘namespaceType` and `name`, the pattern that AWS CodeBuild uses to name and store the output artifact:

  • If ‘type` is set to `CODEPIPELINE`, AWS CodePipeline ignores 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`, this value is ignored if specified, because no build output is produced.

  • If ‘type` is set to `S3`, this is the path to the output artifact. If `path` is not specified, `path` is not used.

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

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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

#type ⇒ String

The type of build output artifact. Valid values include:

  • ‘CODEPIPELINE`: The build project has build output generated through AWS CodePipeline.

  • ‘NO_ARTIFACTS`: The build project does not produce any build output.

  • ‘S3`: The build project stores build output in Amazon Simple Storage Service (Amazon S3).

Returns:

  • (String) 


1705
1706
1707
1708
1709
1710
1711
1712
1713
1714
1715
1716
 
# File 'lib/aws-sdk-codebuild/types.rb', line 1705

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