Package software.amazon.awscdk.services.imagebuilder.alpha

Class ImagePipelineProps.Jsii$Proxy

java.lang.Object
software.amazon.jsii.JsiiObject
software.amazon.awscdk.services.imagebuilder.alpha.ImagePipelineProps.Jsii$Proxy
All Implemented Interfaces:
ImagePipelineProps, software.amazon.jsii.JsiiSerializable
Enclosing interface:
ImagePipelineProps
@Stability(Experimental) @Internal public static final class ImagePipelineProps.Jsii$Proxy extends software.amazon.jsii.JsiiObject implements ImagePipelineProps
An implementation for ImagePipelineProps

  • Constructor Details

    • Jsii$Proxy

      protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
      Constructor that initializes the object based on values retrieved from the JsiiObject.
      Parameters:
      objRef - Reference to the JSII managed object.

    • Jsii$Proxy

      protected Jsii$Proxy(ImagePipelineProps.Builder builder)
      Constructor that initializes the object based on literal property values passed by the ImagePipelineProps.Builder.

  • Method Details

    • getRecipe

      public final IRecipeBase getRecipe()
      Description copied from interface: ImagePipelineProps
      (experimental) The recipe that defines the base image, components, and customizations used to build the image.

      This can either be an image recipe, or a container recipe.

      Specified by:
      getRecipe in interface ImagePipelineProps

    • getDescription

      public final String getDescription()
      Description copied from interface: ImagePipelineProps
      (experimental) The description of the image pipeline.

      Default: None

      Specified by:
      getDescription in interface ImagePipelineProps

    • getDistributionConfiguration

      public final IDistributionConfiguration getDistributionConfiguration()
      Description copied from interface: ImagePipelineProps
      (experimental) The distribution configuration used for distributing the image.

      Default: None

      Specified by:
      getDistributionConfiguration in interface ImagePipelineProps

    • getEnhancedImageMetadataEnabled

      public final Boolean getEnhancedImageMetadataEnabled()
      Description copied from interface: ImagePipelineProps
      (experimental) If enabled, collects additional information about the image being created, including the operating system (OS) version and package list for the AMI.

      Default: true

      Specified by:
      getEnhancedImageMetadataEnabled in interface ImagePipelineProps

    • getExecutionRole

      public final IRole getExecutionRole()
      Description copied from interface: ImagePipelineProps
      (experimental) The execution role used to perform workflow actions to build this image.

      By default, the Image Builder Service Linked Role (SLR) will be created automatically and used as the execution role. However, when providing a custom set of image workflows for the pipeline, an execution role will be generated with the minimal permissions needed to execute the workflows.

      Default: - Image Builder will use the SLR if possible. Otherwise, an execution role will be generated

      Specified by:
      getExecutionRole in interface ImagePipelineProps

    • getImageLogGroup

      public final ILogGroup getImageLogGroup()
      Description copied from interface: ImagePipelineProps
      (experimental) The log group to use for images created from the image pipeline.

      By default, a log group will be created with the format /aws/imagebuilder/<image-name>.

      Default: - a log group will be created

      Specified by:
      getImageLogGroup in interface ImagePipelineProps

    • getImagePipelineLogGroup

      public final ILogGroup getImagePipelineLogGroup()
      Description copied from interface: ImagePipelineProps
      (experimental) The log group to use for the image pipeline.

      By default, a log group will be created with the format /aws/imagebuilder/pipeline/<pipeline-name>

      Default: - a log group will be created

      Specified by:
      getImagePipelineLogGroup in interface ImagePipelineProps

    • getImagePipelineName

      public final String getImagePipelineName()
      Description copied from interface: ImagePipelineProps
      (experimental) The name of the image pipeline.

      Default: - a name is generated

      Specified by:
      getImagePipelineName in interface ImagePipelineProps

    • getImageScanningEcrRepository

      public final IRepository getImageScanningEcrRepository()
      Description copied from interface: ImagePipelineProps
      (experimental) The container repository that Amazon Inspector scans to identify findings for your container images.

      If a repository is not provided, Image Builder creates a repository named image-builder-image-scanning-repository for vulnerability scanning.

      Default: - if scanning is enabled, a repository will be created by Image Builder if one is not provided

      Specified by:
      getImageScanningEcrRepository in interface ImagePipelineProps

    • getImageScanningEcrTags

      public final List<String> getImageScanningEcrTags()
      Description copied from interface: ImagePipelineProps
      (experimental) The tags for Image Builder to apply to the output container image that Amazon Inspector scans.

      Default: None

      Specified by:
      getImageScanningEcrTags in interface ImagePipelineProps

    • getImageScanningEnabled

      public final Boolean getImageScanningEnabled()
      Description copied from interface: ImagePipelineProps
      (experimental) Indicates whether Image Builder keeps a snapshot of the vulnerability scans that Amazon Inspector runs against the build instance when you create a new image.

      Default: false

      Specified by:
      getImageScanningEnabled in interface ImagePipelineProps

    • getImageTestsEnabled

      public final Boolean getImageTestsEnabled()
      Description copied from interface: ImagePipelineProps
      (experimental) Whether to run tests after building an image.

      Default: true

      Specified by:
      getImageTestsEnabled in interface ImagePipelineProps

    • getInfrastructureConfiguration

      public final IInfrastructureConfiguration getInfrastructureConfiguration()
      Description copied from interface: ImagePipelineProps
      (experimental) The infrastructure configuration used for building the image.

      A default infrastructure configuration will be used if one is not provided.

      The default configuration will create an instance profile and role with minimal permissions needed to build the image, attached to the EC2 instance.

      Default: - an infrastructure configuration will be created with the default settings

      Specified by:
      getInfrastructureConfiguration in interface ImagePipelineProps

    • getSchedule

      public final ImagePipelineSchedule getSchedule()
      Description copied from interface: ImagePipelineProps
      (experimental) The schedule of the image pipeline.

      This configures how often and when a pipeline automatically creates a new image.

      Default: - none, a manual image pipeline will be created

      Specified by:
      getSchedule in interface ImagePipelineProps

    • getStatus

      public final ImagePipelineStatus getStatus()
      Description copied from interface: ImagePipelineProps
      (experimental) Indicates whether the pipeline is enabled to be triggered by the provided schedule.

      Default: ImagePipelineStatus.ENABLED

      Specified by:
      getStatus in interface ImagePipelineProps

    • getTags

      public final Map<String,String> getTags()
      Description copied from interface: ImagePipelineProps
      (experimental) The tags to apply to the image pipeline.

      Default: None

      Specified by:
      getTags in interface ImagePipelineProps

    • getWorkflows

      public final List<WorkflowConfiguration> getWorkflows()
      Description copied from interface: ImagePipelineProps
      (experimental) The list of workflow configurations used to build the image.

      Default: - Image Builder will use a default set of workflows for the build to build, test, and distribute the image

      Specified by:
      getWorkflows in interface ImagePipelineProps

    • $jsii$toJson

      @Internal public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
      Specified by:
      $jsii$toJson in interface software.amazon.jsii.JsiiSerializable

    • equals

      public final boolean equals(Object o)
      Overrides:
      equals in class Object

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object