Package com.pulumi.random

Class RandomPet

  • public class RandomPet
extends com.pulumi.resources.CustomResource
    The resource `random.RandomPet` generates random pet names that are intended to be used as unique identifiers for other resources. This resource can be used in conjunction with resources that have the `create_before_destroy` lifecycle flag set, to avoid conflicts with unique names during the brief period where both the old and new resources exist concurrently. ## Example Usage ```java package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.random.RandomPet; import com.pulumi.random.RandomPetArgs; import com.pulumi.aws.ec2.Instance; import com.pulumi.aws.ec2.InstanceArgs; import java.util.List; import java.util.ArrayList; 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 serverRandomPet = new RandomPet("serverRandomPet", RandomPetArgs.builder() .keepers(Map.of("ami_id", var_.ami_id())) .build()); var serverInstance = new Instance("serverInstance", InstanceArgs.builder() .tags(Map.of("Name", serverRandomPet.id().applyValue(id -> String.format("web-server-%s", id)))) .ami(serverRandomPet.keepers().applyValue(keepers -> keepers.amiId())) .build()); } } ```

    • 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
      RandomPet​(java.lang.String name)  
      RandomPet​(java.lang.String name, RandomPetArgs args)  
      RandomPet​(java.lang.String name, RandomPetArgs args, com.pulumi.resources.CustomResourceOptions options)  

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static RandomPet get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, RandomPetState 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.Map<java.lang.String,​java.lang.String>>> keepers()  
      com.pulumi.core.Output<java.lang.Integer> length()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> prefix()  
      com.pulumi.core.Output<java.lang.String> separator()  

      • 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

      • RandomPet

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

      • RandomPet

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

      • RandomPet

        public RandomPet​(java.lang.String name,
                 @Nullable
                 RandomPetArgs 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

      • keepers

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> keepers()
        Returns:
        Arbitrary map of values that, when changed, will trigger recreation of resource. See the main provider documentation for more information.

      • length

        public com.pulumi.core.Output<java.lang.Integer> length()
        Returns:
        The length (in words) of the pet name. Defaults to 2

      • prefix

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> prefix()
        Returns:
        A string to prefix the name with.

      • separator

        public com.pulumi.core.Output<java.lang.String> separator()
        Returns:
        The character to separate words in the pet name. Defaults to "-"

      • get

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