Struct CreateScanInput

#[non_exhaustive]
pub struct CreateScanInput {
    pub client_token: Option<String>,
    pub resource_id: Option<ResourceId>,
    pub scan_name: Option<String>,
    pub scan_type: Option<ScanType>,
    pub analysis_type: Option<AnalysisType>,
    pub tags: Option<HashMap<String, String>>,
}

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

client_token: Option<String>

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.

resource_id: Option<ResourceId>

The identifier for the resource object to be scanned.

scan_name: Option<String>

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

scan_type: Option<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.

analysis_type: Option<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.

tags: Option<HashMap<String, String>>

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.

Implementations

impl CreateScanInput

pub fn client_token(&self) -> Option<&str>

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.

pub fn resource_id(&self) -> Option<&ResourceId>

The identifier for the resource object to be scanned.

pub fn scan_name(&self) -> Option<&str>

The unique name that CodeGuru Security uses to track revisions across multiple scans of the same resource. Only allowed for a STANDARD scan type.

pub fn scan_type(&self) -> Option<&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.

pub fn analysis_type(&self) -> Option<&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.

pub fn tags(&self) -> Option<&HashMap<String, String>>

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.

impl CreateScanInput

pub fn builder() -> CreateScanInputBuilder

Creates a new builder-style object to manufacture CreateScanInput.

Trait Implementations

impl Clone for CreateScanInput

fn clone(&self) -> CreateScanInput

Returns a duplicate of the value.

const fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for CreateScanInput

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for CreateScanInput

fn eq(&self, other: &CreateScanInput) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for CreateScanInput