Class ManagedPrefixList


  • public class ManagedPrefixList
    extends com.pulumi.resources.CustomResource
    Provides a managed prefix list resource. > **NOTE on Managed Prefix Lists and Managed Prefix List Entries:** The provider currently provides both a standalone Managed Prefix List Entry resource (a single entry), and a Managed Prefix List resource with entries defined in-line. At this time you cannot use a Managed Prefix List with in-line rules in conjunction with any Managed Prefix List Entry resources. Doing so will cause a conflict of entries and will overwrite entries. > **NOTE on `maxEntries`:** When you reference a Prefix List in a resource, the maximum number of entries for the prefix lists counts as the same number of rules or entries for the resource. For example, if you create a prefix list with a maximum of 20 entries and you reference that prefix list in a security group rule, this counts as 20 rules for the security group. ## Example Usage Basic usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.ec2.ManagedPrefixList;
     import com.pulumi.aws.ec2.ManagedPrefixListArgs;
     import com.pulumi.aws.ec2.inputs.ManagedPrefixListEntryArgs;
     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 ManagedPrefixList("example", ManagedPrefixListArgs.builder()
                 .entries(            
                     ManagedPrefixListEntryArgs.builder()
                         .cidr(exampleAwsVpc.cidrBlock())
                         .description("Primary")
                         .build(),
                     ManagedPrefixListEntryArgs.builder()
                         .cidr(exampleAwsVpcIpv4CidrBlockAssociation.cidrBlock())
                         .description("Secondary")
                         .build())
                 .name("All VPC CIDR-s")
                 .addressFamily("IPv4")
                 .maxEntries(5)
                 .tags(Map.of("Env", "live"))
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Prefix Lists using the `id`. For example: ```sh $ pulumi import aws:ec2/managedPrefixList:ManagedPrefixList default pl-0570a1d2d725c16be ```
    • 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
      com.pulumi.core.Output<java.lang.String> addressFamily()  
      com.pulumi.core.Output<java.lang.String> arn()  
      com.pulumi.core.Output<java.util.List<ManagedPrefixListEntry>> entries()  
      static ManagedPrefixList get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ManagedPrefixListState 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.lang.Integer> maxEntries()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.lang.String> ownerId()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()  
      com.pulumi.core.Output<java.util.Map<java.lang.String,​java.lang.String>> tagsAll()  
      com.pulumi.core.Output<java.lang.Integer> version()  
      • 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

      • ManagedPrefixList

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

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

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

      • addressFamily

        public com.pulumi.core.Output<java.lang.String> addressFamily()
        Returns:
        Address family (`IPv4` or `IPv6`) of this prefix list.
      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the prefix list.
      • entries

        public com.pulumi.core.Output<java.util.List<ManagedPrefixListEntry>> entries()
        Returns:
        Configuration block for prefix list entry. Detailed below. Different entries may have overlapping CIDR blocks, but a particular CIDR should not be duplicated.
      • maxEntries

        public com.pulumi.core.Output<java.lang.Integer> maxEntries()
        Returns:
        Maximum number of entries that this prefix list can contain.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of this resource. The name must not start with `com.amazonaws`.
      • ownerId

        public com.pulumi.core.Output<java.lang.String> ownerId()
        Returns:
        ID of the AWS account that owns this prefix list.
      • 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:
        Map of tags to assign to this resource. 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:
        Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
      • version

        public com.pulumi.core.Output<java.lang.Integer> version()
        Returns:
        Latest version of this prefix list.
      • get

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