Package software.aws.awsprototypingsdk.pipeline

Class SonarCodeScannerConfig.Builder

java.lang.Object

software.aws.awsprototypingsdk.pipeline.SonarCodeScannerConfig.Builder

All Implemented Interfaces:

software.amazon.jsii.Builder<SonarCodeScannerConfig>

Enclosing interface:

SonarCodeScannerConfig

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

A builder for SonarCodeScannerConfig

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

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

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

sonarqubeAuthorizedGroup

@Stability(Stable)
public SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.Builder cdkOutDir(String cdkOutDir)

Sets the value of SonarCodeScannerConfig.getCdkOutDir()

Parameters:

cdkOutDir - directory containing the synthesized cdk resources.

Returns:

this

cfnNagIgnorePath

@Stability(Stable)
public SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig.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 SonarCodeScannerConfig build()

Builds the configured instance.

Specified by:

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

Returns:

a new instance of SonarCodeScannerConfig

Throws:

NullPointerException - if any required attribute was not provided