Package software.amazon.awssdk.services.codegurusecurity.model

Interface CreateScanRequest.Builder

    • Method Detail

      • analysisType

        CreateScanRequest.Builder analysisType​(String analysisType)

        The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.

        Parameters:
        analysisType - The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisType, AnalysisType

      • analysisType

        CreateScanRequest.Builder analysisType​(AnalysisType analysisType)

        The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.

        Parameters:
        analysisType - The type of analysis you want CodeGuru Security to perform in the scan, either Security or All. The Security type only generates findings related to security. The All type generates both security findings and quality findings. Defaults to Security type if missing.
        Returns:
        Returns a reference to this object so that method calls can be chained together.
        See Also:
        AnalysisType, AnalysisType

      • clientToken

        CreateScanRequest.Builder clientToken​(String 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

        CreateScanRequest.Builder resourceId​(ResourceId 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.

      • scanName

        CreateScanRequest.Builder scanName​(String 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 a STANDARD 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

        CreateScanRequest.Builder scanType​(String scanType)

        The type of scan, either Standard or Express. Defaults to Standard 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, either Standard or Express. Defaults to Standard 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, ScanType

      • scanType

        CreateScanRequest.Builder scanType​(ScanType scanType)

        The type of scan, either Standard or Express. Defaults to Standard 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, either Standard or Express. Defaults to Standard 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, ScanType

      • tags

        CreateScanRequest.Builder tags​(Map<String,​String> 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, or Secret. 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, or Secret. 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.