Class SonarCodeScanner.Builder
- java.lang.Object
-
- software.aws.awsprototypingsdk.pipeline.SonarCodeScanner.Builder
-
- All Implemented Interfaces:
software.amazon.jsii.Builder<SonarCodeScanner>
- Enclosing class:
- SonarCodeScanner
@Stability(Stable) public static final class SonarCodeScanner.Builder extends Object implements software.amazon.jsii.Builder<SonarCodeScanner>
A fluent builder forSonarCodeScanner.
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description SonarCodeScanner.BuilderartifactBucketArn(String artifactBucketArn)S3 bucket ARN containing the built artifacts from the synth build.SonarCodeScanner.BuilderartifactBucketKeyArn(String artifactBucketKeyArn)Artifact bucket key ARN used to encrypt the artifacts.SonarCodeScannerbuild()SonarCodeScanner.BuildercdkOutDir(String cdkOutDir)directory containing the synthesized cdk resources.SonarCodeScanner.BuildercfnNagIgnorePath(String cfnNagIgnorePath)path to a file containing the cfn nag suppression rules.static SonarCodeScanner.Buildercreate(software.constructs.Construct scope, String id)SonarCodeScanner.BuilderexcludeGlobsForScan(List<String> excludeGlobsForScan)glob patterns to exclude from sonar scan.SonarCodeScanner.BuilderincludeGlobsForScan(List<String> includeGlobsForScan)glob patterns to include from sonar scan.SonarCodeScanner.BuilderpreArchiveCommands(List<String> preArchiveCommands)Hook which allows custom commands to be executed before the process commences the archival process.SonarCodeScanner.BuildersonarqubeAuthorizedGroup(String sonarqubeAuthorizedGroup)Group name in Sonarqube with access to administer this project.SonarCodeScanner.BuildersonarqubeDefaultProfileOrGateName(String sonarqubeDefaultProfileOrGateName)Default profile/gate name i.e: your org profile.SonarCodeScanner.BuildersonarqubeEndpoint(String sonarqubeEndpoint)endpoint of the sonarqube instance i.e: https://. SonarCodeScanner.BuildersonarqubeProjectName(String sonarqubeProjectName)Name of the project to create in Sonarqube.SonarCodeScanner.BuildersonarqubeSpecificProfileOrGateName(String sonarqubeSpecificProfileOrGateName)Specific profile/gate name i.e: language specific.SonarCodeScanner.BuildersonarqubeTags(List<String> sonarqubeTags)Tags to associate with this project.SonarCodeScanner.BuildersynthBuildArn(String synthBuildArn)ARN for the CodeBuild task responsible for executing the synth command.
-
-
-
Method Detail
-
create
@Stability(Stable) public static SonarCodeScanner.Builder create(software.constructs.Construct scope, String id)
- Parameters:
scope- This parameter is required.id- This parameter is required.- Returns:
- a new instance of
SonarCodeScanner.Builder.
-
sonarqubeAuthorizedGroup
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeAuthorizedGroup(String sonarqubeAuthorizedGroup)
Group name in Sonarqube with access to administer this project.- Parameters:
sonarqubeAuthorizedGroup- Group name in Sonarqube with access to administer this project. This parameter is required.- Returns:
this
-
sonarqubeDefaultProfileOrGateName
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeDefaultProfileOrGateName(String sonarqubeDefaultProfileOrGateName)
Default profile/gate name i.e: your org profile.Note: These need to be set up in Sonarqube manually.
- Parameters:
sonarqubeDefaultProfileOrGateName- Default profile/gate name i.e: your org profile. This parameter is required.- Returns:
this
-
sonarqubeEndpoint
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeEndpoint(String sonarqubeEndpoint)
endpoint of the sonarqube instance i.e: https://. Note: Ensure a trailing '/' is not included.
- Parameters:
sonarqubeEndpoint- endpoint of the sonarqube instance i.e: https://. This parameter is required. - Returns:
this
-
sonarqubeProjectName
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeProjectName(String sonarqubeProjectName)
Name of the project to create in Sonarqube.- Parameters:
sonarqubeProjectName- Name of the project to create in Sonarqube. This parameter is required.- Returns:
this
-
cdkOutDir
@Stability(Stable) public SonarCodeScanner.Builder cdkOutDir(String cdkOutDir)
directory containing the synthesized cdk resources.- Parameters:
cdkOutDir- directory containing the synthesized cdk resources. This parameter is required.- Returns:
this
-
cfnNagIgnorePath
@Stability(Stable) public SonarCodeScanner.Builder cfnNagIgnorePath(String cfnNagIgnorePath)
path to a file containing the cfn nag suppression rules.- Parameters:
cfnNagIgnorePath- path to a file containing the cfn nag suppression rules. This parameter is required.- Returns:
this
-
excludeGlobsForScan
@Stability(Stable) public SonarCodeScanner.Builder excludeGlobsForScan(List<String> excludeGlobsForScan)
glob patterns to exclude from sonar scan.- Parameters:
excludeGlobsForScan- glob patterns to exclude from sonar scan. This parameter is required.- Returns:
this
-
includeGlobsForScan
@Stability(Stable) public SonarCodeScanner.Builder includeGlobsForScan(List<String> includeGlobsForScan)
glob patterns to include from sonar scan.- Parameters:
includeGlobsForScan- glob patterns to include from sonar scan. This parameter is required.- Returns:
this
-
preArchiveCommands
@Stability(Stable) public SonarCodeScanner.Builder preArchiveCommands(List<String> preArchiveCommands)
Hook which allows custom commands to be executed before the process commences the archival process.- Parameters:
preArchiveCommands- Hook which allows custom commands to be executed before the process commences the archival process. This parameter is required.- Returns:
this
-
sonarqubeSpecificProfileOrGateName
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeSpecificProfileOrGateName(String sonarqubeSpecificProfileOrGateName)
Specific profile/gate name i.e: language specific.Note: These need to be set up in Sonarqube manually.
- Parameters:
sonarqubeSpecificProfileOrGateName- Specific profile/gate name i.e: language specific. This parameter is required.- Returns:
this
-
sonarqubeTags
@Stability(Stable) public SonarCodeScanner.Builder sonarqubeTags(List<String> sonarqubeTags)
Tags to associate with this project.- Parameters:
sonarqubeTags- Tags to associate with this project. This parameter is required.- Returns:
this
-
artifactBucketArn
@Stability(Stable) public SonarCodeScanner.Builder artifactBucketArn(String artifactBucketArn)
S3 bucket ARN containing the built artifacts from the synth build.- Parameters:
artifactBucketArn- S3 bucket ARN containing the built artifacts from the synth build. This parameter is required.- Returns:
this
-
synthBuildArn
@Stability(Stable) public SonarCodeScanner.Builder synthBuildArn(String synthBuildArn)
ARN for the CodeBuild task responsible for executing the synth command.- Parameters:
synthBuildArn- ARN for the CodeBuild task responsible for executing the synth command. This parameter is required.- Returns:
this
-
artifactBucketKeyArn
@Stability(Stable) public SonarCodeScanner.Builder artifactBucketKeyArn(String artifactBucketKeyArn)
Artifact bucket key ARN used to encrypt the artifacts.- Parameters:
artifactBucketKeyArn- Artifact bucket key ARN used to encrypt the artifacts. This parameter is required.- Returns:
this
-
build
@Stability(Stable) public SonarCodeScanner build()
- Specified by:
buildin interfacesoftware.amazon.jsii.Builder<SonarCodeScanner>
-
-