Package com.pulumi.aws.ec2

Class AllowedImagesSettings

  • public class AllowedImagesSettings
extends com.pulumi.resources.CustomResource
    Provides EC2 allowed images settings for an AWS account. This feature allows you to control which AMIs can be used to launch EC2 instances in your account based on specified criteria. For more information about the image criteria that can be set, see the [AWS documentation on Allowed AMIs JSON configuration](https://docs.aws.amazon.com/AWSEC2/latest/UserGuide/ec2-allowed-amis.html#allowed-amis-json-configuration). > **NOTE:** The AWS API does not delete this resource. When you run `destroy`, the provider will attempt to disable the setting. > **NOTE:** There is only one allowed images settings configuration per AWS account and region. Creating this resource will configure the account-level settings. ## Example Usage ### Enable with Amazon AMIs only 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.AllowedImagesSettings;
 import com.pulumi.aws.ec2.AllowedImagesSettingsArgs;
 import com.pulumi.aws.ec2.inputs.AllowedImagesSettingsImageCriterionArgs;
 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 AllowedImagesSettings("example", AllowedImagesSettingsArgs.builder()
             .imageCriterions(AllowedImagesSettingsImageCriterionArgs.builder()
                 .imageProviders("amazon")
                 .build())
             .state("enabled")
             .build());
 
     }
 }
    ### Enable audit mode with specific account IDs 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.ec2.AllowedImagesSettings;
 import com.pulumi.aws.ec2.AllowedImagesSettingsArgs;
 import com.pulumi.aws.ec2.inputs.AllowedImagesSettingsImageCriterionArgs;
 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 AllowedImagesSettings("example", AllowedImagesSettingsArgs.builder()
             .imageCriterions(AllowedImagesSettingsImageCriterionArgs.builder()
                 .imageProviders(                
                     "amazon",
                     "123456789012")
                 .build())
             .state("audit-mode")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import EC2 allowed images settings. For example: ```sh $ pulumi import aws:ec2/allowedImagesSettings:AllowedImagesSettings example us-east-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

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static AllowedImagesSettings get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AllowedImagesSettingsState state, 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.
      com.pulumi.core.Output<java.util.Optional<java.util.List<AllowedImagesSettingsImageCriterion>>> imageCriterions()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.lang.String> state()  

      • Methods inherited from class com.pulumi.resources.CustomResource

        getId, id, idFuture

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

        getChildResources, getResourceName, getResourceType, getUrn, pulumiChildResources, pulumiResourceName, pulumiResourceType, urn

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Constructor Detail

      • AllowedImagesSettings

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

      • AllowedImagesSettings

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

      • AllowedImagesSettings

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

      • imageCriterions

        public com.pulumi.core.Output<java.util.Optional<java.util.List<AllowedImagesSettingsImageCriterion>>> imageCriterions()
        Returns:
        List of image criteria. Maximum of 10 criterion blocks allowed. See `imageCriterion` below.

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

      • state

        public com.pulumi.core.Output<java.lang.String> state()
        Returns:
        State of the allowed images settings. Valid values are `enabled` or `audit-mode`.

      • get

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