software.amazon.awscdk.services.codebuild

Class S3ArtifactsProps.Builder

java.lang.Object

software.amazon.awscdk.services.codebuild.S3ArtifactsProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<S3ArtifactsProps>

Enclosing interface:

S3ArtifactsProps

@Stability(value=Experimental)
public static final class S3ArtifactsProps.Builder
extends Object
implements software.amazon.jsii.Builder<S3ArtifactsProps>

A builder for S3ArtifactsProps

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
S3ArtifactsProps.Builder	bucket(IBucket bucket) Sets the value of S3ArtifactsProps.getBucket()
S3ArtifactsProps	build() Builds the configured instance.
S3ArtifactsProps.Builder	encryption(Boolean encryption) Sets the value of S3ArtifactsProps.getEncryption()
S3ArtifactsProps.Builder	identifier(String identifier) Sets the value of ArtifactsProps.getIdentifier()
S3ArtifactsProps.Builder	includeBuildId(Boolean includeBuildId) Sets the value of S3ArtifactsProps.getIncludeBuildId()
S3ArtifactsProps.Builder	name(String name) Sets the value of S3ArtifactsProps.getName()
S3ArtifactsProps.Builder	packageZip(Boolean packageZip) Sets the value of S3ArtifactsProps.getPackageZip()
S3ArtifactsProps.Builder	path(String path) Sets the value of S3ArtifactsProps.getPath()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Builder

public Builder()

Method Detail

bucket

@Stability(value=Experimental)
public S3ArtifactsProps.Builder bucket(IBucket bucket)

Sets the value of S3ArtifactsProps.getBucket()

Parameters:

bucket - The name of the output bucket. This parameter is required.

Returns:

this

encryption

@Stability(value=Experimental)
public S3ArtifactsProps.Builder encryption(Boolean encryption)

Sets the value of S3ArtifactsProps.getEncryption()

Parameters:

encryption - 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

Returns:

this

includeBuildId

@Stability(value=Experimental)
public S3ArtifactsProps.Builder includeBuildId(Boolean includeBuildId)

Sets the value of S3ArtifactsProps.getIncludeBuildId()

Parameters:

includeBuildId - 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 "//".

Returns:

this

name

@Stability(value=Experimental)
public S3ArtifactsProps.Builder name(String name)

Sets the value of S3ArtifactsProps.getName()

Parameters:

name - The name of the build output ZIP file or folder inside the bucket. The full S3 object key will be "//" 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.

Returns:

this

packageZip

@Stability(value=Experimental)
public S3ArtifactsProps.Builder packageZip(Boolean packageZip)

Sets the value of S3ArtifactsProps.getPackageZip()

Parameters:

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

Returns:

this

path

@Stability(value=Experimental)
public S3ArtifactsProps.Builder path(String path)

Sets the value of S3ArtifactsProps.getPath()

Parameters:

path - 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 directory if `includeBuildId` is set to true).

Returns:

this

identifier

@Stability(value=Experimental)
public S3ArtifactsProps.Builder identifier(String identifier)

Sets the value of ArtifactsProps.getIdentifier()

Parameters:

identifier - The artifact identifier. This property is required on secondary artifacts.

Returns:

this

build

@Stability(value=Experimental)
public S3ArtifactsProps build()

Builds the configured instance.

Specified by:

build in interface software.amazon.jsii.Builder<S3ArtifactsProps>

Returns:

a new instance of S3ArtifactsProps

Throws:

NullPointerException - if any required attribute was not provided