Package software.amazon.awscdk.services.codebuild

Interface S3ArtifactsProps

All Superinterfaces:

ArtifactsProps, software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

S3ArtifactsProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.119.0 (build 1634eac)",
           date="2025-11-17T14:40:47.567Z")
@Stability(Stable)
public interface S3ArtifactsProps
extends software.amazon.jsii.JsiiSerializable, ArtifactsProps

Construction properties for S3Artifacts.

Example:

 Bucket bucket;
 Project project = Project.Builder.create(this, "MyProject")
         .buildSpec(BuildSpec.fromObject(Map.of(
                 "version", "0.2")))
         .artifacts(Artifacts.s3(S3ArtifactsProps.builder()
                 .bucket(bucket)
                 .includeBuildId(false)
                 .packageZip(true)
                 .path("another/path")
                 .identifier("AddArtifact1")
                 .build()))
         .build();
 

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static final class	S3ArtifactsProps.Builder	A builder for S3ArtifactsProps
static final class	S3ArtifactsProps.Jsii$Proxy	An implementation for S3ArtifactsProps

Method Summary

Modifier and Type	Method	Description
static S3ArtifactsProps.Builder	builder()
IBucket	getBucket()	The name of the output bucket.
default Boolean	getEncryption()	If this is false, build output will not be encrypted.
default Boolean	getIncludeBuildId()	Indicates if the build ID should be included in the path.
default String	getName()	The name of the build output ZIP file or folder inside the bucket.
default Boolean	getPackageZip()	If this is true, all build output will be packaged into a single .zip file.
default String	getPath()	The path inside of the bucket for the build output .zip file or folder.

Methods inherited from interface software.amazon.awscdk.services.codebuild.ArtifactsProps

getIdentifier

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Details

getBucket

@Stability(Stable)
@NotNull
IBucket getBucket()

The name of the output bucket.

getEncryption

@Stability(Stable)
@Nullable
default Boolean getEncryption()

If this is false, build output will not be encrypted.

This is useful if the artifact to publish a static website or sharing content with others

Default: true - output will be encrypted

getIncludeBuildId

@Stability(Stable)
@Nullable
default Boolean getIncludeBuildId()

Indicates if the build ID should be included in the path.

If this is set to true, then the build artifact will be stored in "/invalid input: '<'build-id>/".

Default: true

getName

@Stability(Stable)
@Nullable
default String getName()

The name of the build output ZIP file or folder inside the bucket.

The full S3 object key will be "/invalid input: '<'build-id>/" or "/" depending on whether includeBuildId is set to true.

If not set, overrideArtifactName will be set and the name from the buildspec will be used instead.

Default: undefined, and use the name from the buildspec

getPackageZip

@Stability(Stable)
@Nullable
default Boolean getPackageZip()

If this is true, all build output will be packaged into a single .zip file. Otherwise, all files will be uploaded to /.

Default: true - files will be archived

getPath

@Stability(Stable)
@Nullable
default String getPath()

The path inside of the bucket for the build output .zip file or folder. If a value is not specified, then build output will be stored at the root of the bucket (or under the invalid input: '<'build-id> directory if includeBuildId is set to true).

Default: the root of the bucket

builder

@Stability(Stable)
static S3ArtifactsProps.Builder builder()

Returns:

a S3ArtifactsProps.Builder of S3ArtifactsProps