Class ImageScanningConfiguration
- All Implemented Interfaces:
Serializable,SdkPojo,ToCopyableBuilder<ImageScanningConfiguration.Builder,ImageScanningConfiguration>
Contains settings for Image Builder image resource and container image scans.
- See Also:
-
Nested Class Summary
Nested Classes -
Method Summary
Modifier and TypeMethodDescriptionbuilder()final EcrConfigurationContains Amazon ECR settings for vulnerability scans.final booleanfinal booleanequalsBySdkFields(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz) final inthashCode()final booleanFor responses, this returns true if the service returned a value for the ImageScanningTypes property.final BooleanSpecifies whether Amazon Inspector scans for vulnerabilities when you create a new image.final List<ImageScanningType> The type of vulnerability scan that Image Builder runs for AMI output whenimageScanningEnabledistrue.The type of vulnerability scan that Image Builder runs for AMI output whenimageScanningEnabledistrue.final ScanResultConditionThe condition that the output AMI's scan results must meet for the image to pass.static Class<? extends ImageScanningConfiguration.Builder> Take this object and create a builder that contains all of the current property values of this object.final StringtoString()Returns a string representation of this object.Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
imageScanningEnabled
Specifies whether Amazon Inspector scans for vulnerabilities when you create a new image. You must also enable image tests. For AMI output,
imageScanningTypessets whether Amazon Inspector scans the test instance or the output AMI. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository from yourecrConfigurationsettings.To use container image scans, you must activate Amazon Inspector for Amazon ECR scanning in the account and Amazon Web Services Region where the build runs. Amazon Inspector activation is Regional. The Image Builder
ListImageScanFindingsoperation returns the findings of these scans.- Returns:
- Specifies whether Amazon Inspector scans for vulnerabilities when you create a new image. You must also
enable image tests. For AMI output,
imageScanningTypessets whether Amazon Inspector scans the test instance or the output AMI. For container output, Amazon Inspector scans the container image that Image Builder pushes to the Amazon ECR repository from yourecrConfigurationsettings.To use container image scans, you must activate Amazon Inspector for Amazon ECR scanning in the account and Amazon Web Services Region where the build runs. Amazon Inspector activation is Regional. The Image Builder
ListImageScanFindingsoperation returns the findings of these scans.
-
ecrConfiguration
Contains Amazon ECR settings for vulnerability scans.
- Returns:
- Contains Amazon ECR settings for vulnerability scans.
-
imageScanningTypes
The type of vulnerability scan that Image Builder runs for AMI output when
imageScanningEnabledistrue. Specify a single value. If you omitimageScanningTypes, Image Builder usesTEST_INSTANCE_CVE. The scan types work as follows:-
With
TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this scan, you must activate Amazon Inspector for Amazon EC2 scanning in the account and Amazon Web Services Region where the build runs. The Image BuilderListImageScanFindingsoperation returns the findings. -
With
ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output AMI during image tests. To use this scan, you must build from an image recipe, but you do not need to activate Amazon Inspector in your account. The Amazon EC2 GetImageFindings operation returns the findings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasImageScanningTypes()method.- Returns:
- The type of vulnerability scan that Image Builder runs for AMI output when
imageScanningEnabledistrue. Specify a single value. If you omitimageScanningTypes, Image Builder usesTEST_INSTANCE_CVE. The scan types work as follows:-
With
TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this scan, you must activate Amazon Inspector for Amazon EC2 scanning in the account and Amazon Web Services Region where the build runs. The Image BuilderListImageScanFindingsoperation returns the findings. -
With
ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output AMI during image tests. To use this scan, you must build from an image recipe, but you do not need to activate Amazon Inspector in your account. The Amazon EC2 GetImageFindings operation returns the findings.
-
-
-
hasImageScanningTypes
public final boolean hasImageScanningTypes()For responses, this returns true if the service returned a value for the ImageScanningTypes property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified. -
imageScanningTypesAsStrings
The type of vulnerability scan that Image Builder runs for AMI output when
imageScanningEnabledistrue. Specify a single value. If you omitimageScanningTypes, Image Builder usesTEST_INSTANCE_CVE. The scan types work as follows:-
With
TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this scan, you must activate Amazon Inspector for Amazon EC2 scanning in the account and Amazon Web Services Region where the build runs. The Image BuilderListImageScanFindingsoperation returns the findings. -
With
ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output AMI during image tests. To use this scan, you must build from an image recipe, but you do not need to activate Amazon Inspector in your account. The Amazon EC2 GetImageFindings operation returns the findings.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasImageScanningTypes()method.- Returns:
- The type of vulnerability scan that Image Builder runs for AMI output when
imageScanningEnabledistrue. Specify a single value. If you omitimageScanningTypes, Image Builder usesTEST_INSTANCE_CVE. The scan types work as follows:-
With
TEST_INSTANCE_CVE, Amazon Inspector scans the test instance during image tests. To use this scan, you must activate Amazon Inspector for Amazon EC2 scanning in the account and Amazon Web Services Region where the build runs. The Image BuilderListImageScanFindingsoperation returns the findings. -
With
ON_DEMAND_AMI_CVE, Amazon Inspector starts an on-demand scan of the output AMI during image tests. To use this scan, you must build from an image recipe, but you do not need to activate Amazon Inspector in your account. The Amazon EC2 GetImageFindings operation returns the findings.
-
-
-
scanResultCondition
The condition that the output AMI's scan results must meet for the image to pass. You can set
scanResultConditiononly whenimageScanningTypesisON_DEMAND_AMI_CVE. If you omit it, Image Builder starts the scan but does not wait for it or use its results to pass or fail the image.When you set
scanResultCondition, the test phase waits for the scan to finish. Then Image Builder checks the findings against the condition. By default, Image Builder counts only findings that have a fix available. To count every finding, setfixAvailabletofalse. If a counted finding exceedsmaximumSeverityLabel, Image Builder fails the image in the test phase and does not distribute the AMI.- Returns:
- The condition that the output AMI's scan results must meet for the image to pass. You can set
scanResultConditiononly whenimageScanningTypesisON_DEMAND_AMI_CVE. If you omit it, Image Builder starts the scan but does not wait for it or use its results to pass or fail the image.When you set
scanResultCondition, the test phase waits for the scan to finish. Then Image Builder checks the findings against the condition. By default, Image Builder counts only findings that have a fix available. To count every finding, setfixAvailabletofalse. If a counted finding exceedsmaximumSeverityLabel, Image Builder fails the image in the test phase and does not distribute the AMI.
-
toBuilder
Description copied from interface:ToCopyableBuilderTake this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilderin interfaceToCopyableBuilder<ImageScanningConfiguration.Builder,ImageScanningConfiguration> - Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
-
equals
-
equalsBySdkFields
Description copied from interface:SdkPojoIndicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojoclass, and is generated based on a service model.If an
SdkPojoclass does not have any inherited fields,equalsBySdkFieldsandequalsare essentially the same.- Specified by:
equalsBySdkFieldsin interfaceSdkPojo- Parameters:
obj- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
toString
-
getValueForField
-
sdkFields
-
sdkFieldNameToField
- Specified by:
sdkFieldNameToFieldin interfaceSdkPojo- Returns:
- The mapping between the field name and its corresponding field.
-