Interface CfnImageProps
- All Superinterfaces:
software.amazon.jsii.JsiiSerializable
- All Known Implementing Classes:
CfnImageProps.Jsii$Proxy
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)",
date="2024-04-18T17:54:18.171Z")
@Stability(Stable)
public interface CfnImageProps
extends software.amazon.jsii.JsiiSerializable
Properties for defining a
CfnImage
.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import software.amazon.awscdk.services.imagebuilder.*; CfnImageProps cfnImageProps = CfnImageProps.builder() .infrastructureConfigurationArn("infrastructureConfigurationArn") // the properties below are optional .containerRecipeArn("containerRecipeArn") .distributionConfigurationArn("distributionConfigurationArn") .enhancedImageMetadataEnabled(false) .executionRole("executionRole") .imageRecipeArn("imageRecipeArn") .imageScanningConfiguration(ImageScanningConfigurationProperty.builder() .ecrConfiguration(EcrConfigurationProperty.builder() .containerTags(List.of("containerTags")) .repositoryName("repositoryName") .build()) .imageScanningEnabled(false) .build()) .imageTestsConfiguration(ImageTestsConfigurationProperty.builder() .imageTestsEnabled(false) .timeoutMinutes(123) .build()) .tags(Map.of( "tagsKey", "tags")) .workflows(List.of(WorkflowConfigurationProperty.builder() .onFailure("onFailure") .parallelGroup("parallelGroup") .parameters(List.of(WorkflowParameterProperty.builder() .name("name") .value(List.of("value")) .build())) .workflowArn("workflowArn") .build())) .build();
- See Also:
-
Nested Class Summary
Modifier and TypeInterfaceDescriptionstatic final class
A builder forCfnImageProps
static final class
An implementation forCfnImageProps
-
Method Summary
Modifier and TypeMethodDescriptionstatic CfnImageProps.Builder
builder()
default String
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.default String
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.default Object
Collects additional information about the image being created, including the operating system (OS) version and package list.default String
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.default String
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.default Object
Contains settings for vulnerability scans.default Object
The image tests configuration of the image.The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.getTags()
The tags of the image.default Object
Contains an array of workflow configuration objects.Methods inherited from interface software.amazon.jsii.JsiiSerializable
$jsii$toJson
-
Method Details
-
getInfrastructureConfigurationArn
The Amazon Resource Name (ARN) of the infrastructure configuration that defines the environment in which your image will be built and tested.- See Also:
-
getContainerRecipeArn
The Amazon Resource Name (ARN) of the container recipe that defines how images are configured and tested.- See Also:
-
getDistributionConfigurationArn
The Amazon Resource Name (ARN) of the distribution configuration that defines and configures the outputs of your pipeline.- See Also:
-
getEnhancedImageMetadataEnabled
Collects additional information about the image being created, including the operating system (OS) version and package list.This information is used to enhance the overall experience of using EC2 Image Builder. Enabled by default.
- See Also:
-
getExecutionRole
The name or Amazon Resource Name (ARN) for the IAM role you create that grants Image Builder access to perform workflow actions.- See Also:
-
getImageRecipeArn
The Amazon Resource Name (ARN) of the image recipe that defines how images are configured, tested, and assessed.- See Also:
-
getImageScanningConfiguration
Contains settings for vulnerability scans.- See Also:
-
getImageTestsConfiguration
The image tests configuration of the image.- See Also:
-
getTags
The tags of the image.- See Also:
-
getWorkflows
Contains an array of workflow configuration objects.- See Also:
-
builder
- Returns:
- a
CfnImageProps.Builder
ofCfnImageProps
-