Package software.aws.awsprototypingsdk.pipeline

Class SonarCodeScannerProps.Builder

java.lang.Object

software.aws.awsprototypingsdk.pipeline.SonarCodeScannerProps.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SonarCodeScannerProps>

Enclosing interface:

SonarCodeScannerProps

@Stability(Stable)
public static final class SonarCodeScannerProps.Builder
extends Object
implements software.amazon.jsii.Builder<SonarCodeScannerProps>

A builder for SonarCodeScannerProps

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
SonarCodeScannerProps.Builder	artifactBucketArn(String artifactBucketArn)	Sets the value of SonarCodeScannerProps.getArtifactBucketArn()
SonarCodeScannerProps.Builder	artifactBucketKeyArn(String artifactBucketKeyArn)	Sets the value of SonarCodeScannerProps.getArtifactBucketKeyArn()
SonarCodeScannerProps	build()	Builds the configured instance.
SonarCodeScannerProps.Builder	cdkOutDir(String cdkOutDir)	Sets the value of SonarCodeScannerConfig.getCdkOutDir()
SonarCodeScannerProps.Builder	cfnNagIgnorePath(String cfnNagIgnorePath)	Sets the value of SonarCodeScannerConfig.getCfnNagIgnorePath()
SonarCodeScannerProps.Builder	excludeGlobsForScan(List<String> excludeGlobsForScan)	Sets the value of SonarCodeScannerConfig.getExcludeGlobsForScan()
SonarCodeScannerProps.Builder	includeGlobsForScan(List<String> includeGlobsForScan)	Sets the value of SonarCodeScannerConfig.getIncludeGlobsForScan()
SonarCodeScannerProps.Builder	preArchiveCommands(List<String> preArchiveCommands)	Sets the value of SonarCodeScannerConfig.getPreArchiveCommands()
SonarCodeScannerProps.Builder	sonarqubeAuthorizedGroup(String sonarqubeAuthorizedGroup)	Sets the value of SonarCodeScannerConfig.getSonarqubeAuthorizedGroup()
SonarCodeScannerProps.Builder	sonarqubeDefaultProfileOrGateName(String sonarqubeDefaultProfileOrGateName)	Sets the value of SonarCodeScannerConfig.getSonarqubeDefaultProfileOrGateName()
SonarCodeScannerProps.Builder	sonarqubeEndpoint(String sonarqubeEndpoint)	Sets the value of SonarCodeScannerConfig.getSonarqubeEndpoint()
SonarCodeScannerProps.Builder	sonarqubeProjectName(String sonarqubeProjectName)	Sets the value of SonarCodeScannerConfig.getSonarqubeProjectName()
SonarCodeScannerProps.Builder	sonarqubeSpecificProfileOrGateName(String sonarqubeSpecificProfileOrGateName)	Sets the value of SonarCodeScannerConfig.getSonarqubeSpecificProfileOrGateName()
SonarCodeScannerProps.Builder	sonarqubeTags(List<String> sonarqubeTags)	Sets the value of SonarCodeScannerConfig.getSonarqubeTags()
SonarCodeScannerProps.Builder	synthBuildArn(String synthBuildArn)	Sets the value of SonarCodeScannerProps.getSynthBuildArn()

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

artifactBucketArn

@Stability(Stable)
public SonarCodeScannerProps.Builder artifactBucketArn(String artifactBucketArn)

Sets the value of SonarCodeScannerProps.getArtifactBucketArn()

Parameters:

artifactBucketArn - S3 bucket ARN containing the built artifacts from the synth build. This parameter is required.

Returns:

this

synthBuildArn

@Stability(Stable)
public SonarCodeScannerProps.Builder synthBuildArn(String synthBuildArn)

Sets the value of SonarCodeScannerProps.getSynthBuildArn()

Parameters:

synthBuildArn - ARN for the CodeBuild task responsible for executing the synth command. This parameter is required.

Returns:

this

artifactBucketKeyArn

@Stability(Stable)
public SonarCodeScannerProps.Builder artifactBucketKeyArn(String artifactBucketKeyArn)

Sets the value of SonarCodeScannerProps.getArtifactBucketKeyArn()

Parameters:

artifactBucketKeyArn - Artifact bucket key ARN used to encrypt the artifacts.

Returns:

this

sonarqubeAuthorizedGroup

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeAuthorizedGroup(String sonarqubeAuthorizedGroup)

Sets the value of SonarCodeScannerConfig.getSonarqubeAuthorizedGroup()

Parameters:

sonarqubeAuthorizedGroup - Group name in Sonarqube with access to administer this project. This parameter is required.

Returns:

this

sonarqubeDefaultProfileOrGateName

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeDefaultProfileOrGateName(String sonarqubeDefaultProfileOrGateName)

Sets the value of SonarCodeScannerConfig.getSonarqubeDefaultProfileOrGateName()

Parameters:

sonarqubeDefaultProfileOrGateName - Default profile/gate name i.e: your org profile. This parameter is required. Note: These need to be set up in Sonarqube manually.

Returns:

this

sonarqubeEndpoint

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeEndpoint(String sonarqubeEndpoint)

Sets the value of SonarCodeScannerConfig.getSonarqubeEndpoint()

Parameters:

sonarqubeEndpoint - endpoint of the sonarqube instance i.e: https://. This parameter is required. Note: Ensure a trailing '/' is not included.

Returns:

this

sonarqubeProjectName

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeProjectName(String sonarqubeProjectName)

Sets the value of SonarCodeScannerConfig.getSonarqubeProjectName()

Parameters:

sonarqubeProjectName - Name of the project to create in Sonarqube. This parameter is required.

Returns:

this

cdkOutDir

@Stability(Stable)
public SonarCodeScannerProps.Builder cdkOutDir(String cdkOutDir)

Sets the value of SonarCodeScannerConfig.getCdkOutDir()

Parameters:

cdkOutDir - directory containing the synthesized cdk resources.

Returns:

this

cfnNagIgnorePath

@Stability(Stable)
public SonarCodeScannerProps.Builder cfnNagIgnorePath(String cfnNagIgnorePath)

Sets the value of SonarCodeScannerConfig.getCfnNagIgnorePath()

Parameters:

cfnNagIgnorePath - path to a file containing the cfn nag suppression rules.

Returns:

this

excludeGlobsForScan

@Stability(Stable)
public SonarCodeScannerProps.Builder excludeGlobsForScan(List<String> excludeGlobsForScan)

Sets the value of SonarCodeScannerConfig.getExcludeGlobsForScan()

Parameters:

excludeGlobsForScan - glob patterns to exclude from sonar scan.

Returns:

this

includeGlobsForScan

@Stability(Stable)
public SonarCodeScannerProps.Builder includeGlobsForScan(List<String> includeGlobsForScan)

Sets the value of SonarCodeScannerConfig.getIncludeGlobsForScan()

Parameters:

includeGlobsForScan - glob patterns to include from sonar scan.

Returns:

this

preArchiveCommands

@Stability(Stable)
public SonarCodeScannerProps.Builder preArchiveCommands(List<String> preArchiveCommands)

Sets the value of SonarCodeScannerConfig.getPreArchiveCommands()

Parameters:

preArchiveCommands - Hook which allows custom commands to be executed before the process commences the archival process.

Returns:

this

sonarqubeSpecificProfileOrGateName

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeSpecificProfileOrGateName(String sonarqubeSpecificProfileOrGateName)

Sets the value of SonarCodeScannerConfig.getSonarqubeSpecificProfileOrGateName()

Parameters:

sonarqubeSpecificProfileOrGateName - Specific profile/gate name i.e: language specific. Note: These need to be set up in Sonarqube manually.

Returns:

this

sonarqubeTags

@Stability(Stable)
public SonarCodeScannerProps.Builder sonarqubeTags(List<String> sonarqubeTags)

Sets the value of SonarCodeScannerConfig.getSonarqubeTags()

Parameters:

sonarqubeTags - Tags to associate with this project.

Returns:

this

build

@Stability(Stable)
public SonarCodeScannerProps build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SonarCodeScannerProps

Throws:

NullPointerException - if any required attribute was not provided