Package com.pulumi.aws.imagebuilder

Class Image

  • public class Image
extends com.pulumi.resources.CustomResource
    Manages an Image Builder Image. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.imagebuilder.Image;
 import com.pulumi.aws.imagebuilder.ImageArgs;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Map;
 import java.io.File;
 import java.nio.file.Files;
 import java.nio.file.Paths;
 
 public class App {
     public static void main(String[] args) {
         Pulumi.run(App::stack);
     }
 
     public static void stack(Context ctx) {
         var example = new Image("example", ImageArgs.builder()
             .distributionConfigurationArn(exampleAwsImagebuilderDistributionConfiguration.arn())
             .imageRecipeArn(exampleAwsImagebuilderImageRecipe.arn())
             .infrastructureConfigurationArn(exampleAwsImagebuilderInfrastructureConfiguration.arn())
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required - `arn` (String) ARN of the Image Builder image. Using `pulumi import`, import `aws.imagebuilder.Image` resources using the ARN. For example: ```sh $ pulumi import aws:imagebuilder/image:Image example arn:aws:imagebuilder:us-east-1:123456789012:image/example/1.0.0/1 ```

    • 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 Summary

      Constructors 
      Constructor Description
      Image​(java.lang.String name)  
      Image​(java.lang.String name, ImageArgs args)  
      Image​(java.lang.String name, ImageArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Constructor Detail

      • Image

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

      • Image

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

      • Image

        public Image​(java.lang.String name,
             ImageArgs 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.

      • 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 was created.

      • 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.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<ImageImageScanningConfiguration> imageScanningConfiguration()
        Returns:
        Configuration block with image scanning configuration. Detailed below.

      • imageTestsConfiguration

        public com.pulumi.core.Output<ImageImageTestsConfiguration> 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. The following arguments are optional:

      • loggingConfiguration

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

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the AMI.

      • osVersion

        public com.pulumi.core.Output<java.lang.String> osVersion()
        Returns:
        Operating System version of the image.

      • outputResources

        public com.pulumi.core.Output<java.util.List<ImageOutputResource>> outputResources()
        Returns:
        List of objects with resources created by the image.

      • platform

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

      • 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.

      • 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 Builder Image. 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.

      • version

        public com.pulumi.core.Output<java.lang.String> version()
        Returns:
        Version of the image.

      • workflows

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

      • get

        public static Image get​(java.lang.String name,
                        com.pulumi.core.Output<java.lang.String> id,
                        @Nullable
                        ImageState 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.