Interface CreateScanRequest.Builder
- All Superinterfaces:
AwsRequest.Builder
,Buildable
,CodeGuruSecurityRequest.Builder
,CopyableBuilder<CreateScanRequest.Builder,
,CreateScanRequest> SdkBuilder<CreateScanRequest.Builder,
,CreateScanRequest> SdkPojo
,SdkRequest.Builder
- Enclosing class:
CreateScanRequest
-
Method Summary
Modifier and TypeMethodDescriptionanalysisType
(String analysisType) The type of analysis you want CodeGuru Security to perform in the scan, eitherSecurity
orAll
.analysisType
(AnalysisType analysisType) The type of analysis you want CodeGuru Security to perform in the scan, eitherSecurity
orAll
.clientToken
(String clientToken) The idempotency token for the request.overrideConfiguration
(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Add an optional request override configuration.overrideConfiguration
(AwsRequestOverrideConfiguration overrideConfiguration) Add an optional request override configuration.default CreateScanRequest.Builder
resourceId
(Consumer<ResourceId.Builder> resourceId) The identifier for an input resource used to create a scan.resourceId
(ResourceId resourceId) The identifier for an input resource used to create a scan.The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource.The type of scan, eitherStandard
orExpress
.The type of scan, eitherStandard
orExpress
.An array of key-value pairs used to tag a scan.Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.services.codegurusecurity.model.CodeGuruSecurityRequest.Builder
build
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
Method Details
-
analysisType
The type of analysis you want CodeGuru Security to perform in the scan, either
Security
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings. Defaults toSecurity
type if missing.- Parameters:
analysisType
- The type of analysis you want CodeGuru Security to perform in the scan, eitherSecurity
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings. Defaults toSecurity
type if missing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
analysisType
The type of analysis you want CodeGuru Security to perform in the scan, either
Security
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings. Defaults toSecurity
type if missing.- Parameters:
analysisType
- The type of analysis you want CodeGuru Security to perform in the scan, eitherSecurity
orAll
. TheSecurity
type only generates findings related to security. TheAll
type generates both security findings and quality findings. Defaults toSecurity
type if missing.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
clientToken
The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.
- Parameters:
clientToken
- The idempotency token for the request. Amazon CodeGuru Security uses this value to prevent the accidental creation of duplicate scans if there are failures and retries.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceId
The identifier for an input resource used to create a scan.
- Parameters:
resourceId
- The identifier for an input resource used to create a scan.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
resourceId
The identifier for an input resource used to create a scan.
This is a convenience method that creates an instance of theResourceId.Builder
avoiding the need to create one manually viaResourceId.builder()
.When the
Consumer
completes,SdkBuilder.build()
is called immediately and its result is passed toresourceId(ResourceId)
.- Parameters:
resourceId
- a consumer that will call methods onResourceId.Builder
- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scanName
The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a
STANDARD
scan type. If not specified, it will be auto generated.- Parameters:
scanName
- The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for aSTANDARD
scan type. If not specified, it will be auto generated.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
scanType
The type of scan, either
Standard
orExpress
. Defaults toStandard
type if missing.Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time.Standard
scans have standard resource limits and use the full set of detectors to analyze your code.- Parameters:
scanType
- The type of scan, eitherStandard
orExpress
. Defaults toStandard
type if missing.Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time.Standard
scans have standard resource limits and use the full set of detectors to analyze your code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
scanType
The type of scan, either
Standard
orExpress
. Defaults toStandard
type if missing.Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time.Standard
scans have standard resource limits and use the full set of detectors to analyze your code.- Parameters:
scanType
- The type of scan, eitherStandard
orExpress
. Defaults toStandard
type if missing.Express
scans run on limited resources and use a limited set of detectors to analyze your code in near-real time.Standard
scans have standard resource limits and use the full set of detectors to analyze your code.- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
-
tags
An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:
-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
- Parameters:
tags
- An array of key-value pairs used to tag a scan. A tag is a custom attribute label with two parts:-
A tag key. For example,
CostCenter
,Environment
, orSecret
. Tag keys are case sensitive. -
An optional tag value field. For example,
111122223333
,Production
, or a team name. Omitting the tag value is the same as using an empty string. Tag values are case sensitive.
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
overrideConfiguration
CreateScanRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
overrideConfiguration
- The override configuration.- Returns:
- This object for method chaining.
-
overrideConfiguration
CreateScanRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer) Description copied from interface:AwsRequest.Builder
Add an optional request override configuration.- Specified by:
overrideConfiguration
in interfaceAwsRequest.Builder
- Parameters:
builderConsumer
- AConsumer
to which an emptyAwsRequestOverrideConfiguration.Builder
will be given.- Returns:
- This object for method chaining.
-