Package com.pulumi.aws.imagebuilder

Class ImagePipeline

  • public class ImagePipeline
extends com.pulumi.resources.CustomResource
    Manages an Image Builder Image Pipeline. > **NOTE:** Starting with version `5.74.0`, lifecycle meta-argument `replaceTriggeredBy` must be used in order to prevent a dependency error on destroy. #### Required - `arn` (String) ARN of the Image Builder image pipeline. Using `pulumi import`, import `aws.imagebuilder.ImagePipeline` resources using the ARN. For example: ```sh $ pulumi import aws:imagebuilder/imagePipeline:ImagePipeline example arn:aws:imagebuilder:us-east-1:123456789012:image-pipeline/example ```

    • Nested Class Summary

      • Nested classes/interfaces inherited from class com.pulumi.resources.CustomResource

        com.pulumi.resources.CustomResource.CustomResourceInternal

      • Nested classes/interfaces inherited from class com.pulumi.resources.Resource

        com.pulumi.resources.Resource.LazyField<T extends java.lang.Object>, com.pulumi.resources.Resource.LazyFields, com.pulumi.resources.Resource.ResourceInternal

    • Field Summary

      • Fields inherited from class com.pulumi.resources.Resource

        childResources, remote

    • Constructor Detail

      • ImagePipeline

        public ImagePipeline​(java.lang.String name)
        Parameters:
        name - The _unique_ name of the resulting resource.

      • ImagePipeline

        public ImagePipeline​(java.lang.String name,
                     ImagePipelineArgs args)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.

      • ImagePipeline

        public ImagePipeline​(java.lang.String name,
                     ImagePipelineArgs args,
                     @Nullable
                     com.pulumi.resources.CustomResourceOptions options)
        Parameters:
        name - The _unique_ name of the resulting resource.
        args - The arguments to use to populate this resource's properties.
        options - A bag of options that control this resource's behavior.

    • Method Detail

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the image pipeline.

      • containerRecipeArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> containerRecipeArn()
        Returns:
        ARN of the container recipe.

      • dateCreated

        public com.pulumi.core.Output<java.lang.String> dateCreated()
        Returns:
        Date the image pipeline was created.

      • dateLastRun

        public com.pulumi.core.Output<java.lang.String> dateLastRun()
        Returns:
        Date the image pipeline was last run.

      • dateNextRun

        public com.pulumi.core.Output<java.lang.String> dateNextRun()
        Returns:
        Date the image pipeline will run next.

      • dateUpdated

        public com.pulumi.core.Output<java.lang.String> dateUpdated()
        Returns:
        Date the image pipeline was updated.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the image pipeline.

      • distributionConfigurationArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> distributionConfigurationArn()
        Returns:
        ARN of the Image Builder Distribution Configuration.

      • enhancedImageMetadataEnabled

        public com.pulumi.core.Output<java.util.Optional<java.lang.Boolean>> enhancedImageMetadataEnabled()
        Returns:
        Whether additional information about the image being created is collected. Defaults to `true`.

      • executionRole

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> executionRole()
        Returns:
        ARN of the service-linked role to be used by Image Builder to [execute workflows](https://docs.aws.amazon.com/imagebuilder/latest/userguide/manage-image-workflows.html).

      • imageRecipeArn

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> imageRecipeArn()
        Returns:
        ARN of the image recipe.

      • imageScanningConfiguration

        public com.pulumi.core.Output<ImagePipelineImageScanningConfiguration> imageScanningConfiguration()
        Returns:
        Configuration block with image scanning configuration. Detailed below.

      • imageTestsConfiguration

        public com.pulumi.core.Output<ImagePipelineImageTestsConfiguration> imageTestsConfiguration()
        Returns:
        Configuration block with image tests configuration. Detailed below.

      • infrastructureConfigurationArn

        public com.pulumi.core.Output<java.lang.String> infrastructureConfigurationArn()
        Returns:
        ARN of the Image Builder Infrastructure Configuration.

      • loggingConfiguration

        public com.pulumi.core.Output<java.util.Optional<ImagePipelineLoggingConfiguration>> loggingConfiguration()
        Returns:
        Configuration block with logging configuration. Detailed below.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the image pipeline. The following arguments are optional:

      • platform

        public com.pulumi.core.Output<java.lang.String> platform()
        Returns:
        Platform of the image pipeline.

      • region

        public com.pulumi.core.Output<java.lang.String> region()
        Returns:
        Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.

      • schedule

        public com.pulumi.core.Output<java.util.Optional<ImagePipelineSchedule>> schedule()
        Returns:
        Configuration block with schedule settings. Detailed below.

      • status

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> status()
        Returns:
        Status of the image pipeline. Valid values are `DISABLED` and `ENABLED`. Defaults to `ENABLED`.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Key-value map of resource tags for the image pipeline. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.

      • tagsAll

        public com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()
        Returns:
        A map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.

      • workflows

        public com.pulumi.core.Output<java.util.List<ImagePipelineWorkflow>> workflows()
        Returns:
        Configuration block with the workflow configuration. Detailed below.

      • get

        public static ImagePipeline get​(java.lang.String name,
                                com.pulumi.core.Output<java.lang.String> id,
                                @Nullable
                                ImagePipelineState state,
                                @Nullable
                                com.pulumi.resources.CustomResourceOptions options)
        Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
        Parameters:
        name - The _unique_ name of the resulting resource.
        id - The _unique_ provider ID of the resource to lookup.
        state -
        options - Optional settings to control the behavior of the CustomResource.