Package software.aws.awsprototypingsdk.pipeline

Interface SonarCodeScannerConfig

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Subinterfaces:

SonarCodeScannerProps

All Known Implementing Classes:

SonarCodeScannerConfig.Jsii$Proxy, SonarCodeScannerProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-02-01T23:43:16.216Z")
@Stability(Stable)
public interface SonarCodeScannerConfig
extends software.amazon.jsii.JsiiSerializable

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method	Description
static SonarCodeScannerConfig.Builder	builder()
default String	getCdkOutDir()	directory containing the synthesized cdk resources.
default String	getCfnNagIgnorePath()	path to a file containing the cfn nag suppression rules.
default List<String>	getExcludeGlobsForScan()	glob patterns to exclude from sonar scan.
default List<String>	getIncludeGlobsForScan()	glob patterns to include from sonar scan.
default List<String>	getPreArchiveCommands()	Hook which allows custom commands to be executed before the process commences the archival process.
String	getSonarqubeAuthorizedGroup()	Group name in Sonarqube with access to administer this project.
String	getSonarqubeDefaultProfileOrGateName()	Default profile/gate name i.e: your org profile.
String	getSonarqubeEndpoint()	endpoint of the sonarqube instance i.e: https://.
String	getSonarqubeProjectName()	Name of the project to create in Sonarqube.
default String	getSonarqubeSpecificProfileOrGateName()	Specific profile/gate name i.e: language specific.
default List<String>	getSonarqubeTags()	Tags to associate with this project.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getSonarqubeAuthorizedGroup

@Stability(Stable)
@NotNull
String getSonarqubeAuthorizedGroup()

Group name in Sonarqube with access to administer this project.

getSonarqubeDefaultProfileOrGateName

@Stability(Stable)
@NotNull
String getSonarqubeDefaultProfileOrGateName()

Default profile/gate name i.e: your org profile.

Note: These need to be set up in Sonarqube manually.

getSonarqubeEndpoint

@Stability(Stable)
@NotNull
String getSonarqubeEndpoint()

endpoint of the sonarqube instance i.e: https://.

Note: Ensure a trailing '/' is not included.

getSonarqubeProjectName

@Stability(Stable)
@NotNull
String getSonarqubeProjectName()

Name of the project to create in Sonarqube.

getCdkOutDir

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

directory containing the synthesized cdk resources.

getCfnNagIgnorePath

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

path to a file containing the cfn nag suppression rules.

getExcludeGlobsForScan

@Stability(Stable)
@Nullable
default List<String> getExcludeGlobsForScan()

glob patterns to exclude from sonar scan.

getIncludeGlobsForScan

@Stability(Stable)
@Nullable
default List<String> getIncludeGlobsForScan()

glob patterns to include from sonar scan.

getPreArchiveCommands

@Stability(Stable)
@Nullable
default List<String> getPreArchiveCommands()

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

getSonarqubeSpecificProfileOrGateName

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

Specific profile/gate name i.e: language specific.

Note: These need to be set up in Sonarqube manually.

getSonarqubeTags

@Stability(Stable)
@Nullable
default List<String> getSonarqubeTags()

Tags to associate with this project.

builder

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

Returns:

a SonarCodeScannerConfig.Builder of SonarCodeScannerConfig