Sign In to the Console
AWS CloudFormation
User Guide (API Version 2010-05-15)

AWS Documentation » AWS CloudFormation » User Guide » Template Reference » AWS Resource and Property Types Reference » AWS CodeBuild Resource Types Reference » AWS::CodeBuild::Project » AWS CodeBuild Project Artifacts

AWS CodeBuild Project Artifacts

Artifacts is a property of the AWS::CodeBuild::Project resource that specifies output settings for artifacts generated by an AWS CodeBuild build.

Syntax

To declare this entity in your AWS CloudFormation template, use the following syntax:

JSON

{
  "ArtifactIdentifier" : String,
  "EncryptionDisabled" : Boolean,
  "Location" : String,
  "Name" : String,
  "NamespaceType" : String,
  "OverrideArtifactName" : Boolean,
  "Packaging" : String,
  "Path" : String,
  "Type" : String
}

YAML

ArtifactIdentifier: String
EncryptionDisabled: Boolean
Location: String
Name: String
NamespaceType: String
OverrideArtifactName: Boolean
Packaging: String
Path: String
Type: String

Properties

ArtifactIdentifier

An identifier for this artifact.

Required: No

Type: String

EncryptionDisabled

If set to true, then the build output artifacts are not encrypted. This option is only valid if your artifacts type is Amazon S3. If this is set with another artifacts type, an invalidInputException will be thrown.

Required: No

Type: Boolean

Location

The location where AWS CodeBuild saves the build output artifacts. For valid values, see the artifacts-location field in the AWS CodeBuild User Guide.

Required: Conditional. If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property.

Type: String

Name

The name of the build output folder where AWS CodeBuild saves the build output artifacts. For .zip packages, the name of the build output .zip file that contains the build output artifacts.

Required: Conditional. If you specify CODEPIPELINE or NO_ARTIFACTS for the Type property, don't specify this property. For all of the other types, you must specify this property.

Type: String

NamespaceType

The information AWS CodeBuild adds to the build output path, such as a build ID. For more information, see the namespaceType field in the AWS CodeBuild User Guide.

Required: No

Type: String

OverrideArtifactName

If set to true a name specified in the buildspec file overrides the artifact name. The name specified in a buildspec 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.

Required: No

Type: Boolean

Packaging

Indicates how AWS CodeBuild packages the build output artifacts. For valid values, see the packaging field in the AWS CodeBuild User Guide.

Required: No

Type: String

Path

The path to the build output folder where AWS CodeBuild saves the build output artifacts.

Required: No

Type: String

Type

The type of build output artifact. For valid values, see the artifacts-type field in the AWS CodeBuild User Guide.

Required: Yes

Type: String

On this page: