Class Vault


  • public class Vault
    extends com.pulumi.resources.CustomResource
    Provides a Glacier Vault Resource. You can refer to the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/working-with-vaults.html) for a full explanation of the Glacier Vault functionality > **NOTE:** When removing a Glacier Vault, the Vault must be empty. ## Example Usage
     
     package generated_program;
     
     import com.pulumi.Context;
     import com.pulumi.Pulumi;
     import com.pulumi.core.Output;
     import com.pulumi.aws.sns.Topic;
     import com.pulumi.aws.sns.TopicArgs;
     import com.pulumi.aws.iam.IamFunctions;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementArgs;
     import com.pulumi.aws.iam.inputs.GetPolicyDocumentStatementPrincipalArgs;
     import com.pulumi.aws.glacier.Vault;
     import com.pulumi.aws.glacier.VaultArgs;
     import com.pulumi.aws.glacier.inputs.VaultNotificationArgs;
     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 awsSnsTopic = new Topic("awsSnsTopic", TopicArgs.builder()
                 .name("glacier-sns-topic")
                 .build());
     
             final var myArchive = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
                 .statements(GetPolicyDocumentStatementArgs.builder()
                     .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                         .type("*")
                         .identifiers("*")
                         .build())
                     .sid("add-read-only-perm")
                     .effect("Allow")
                     .actions(                
                         "glacier:InitiateJob",
                         "glacier:GetJobOutput")
                     .resources("arn:aws:glacier:eu-west-1:432981146916:vaults/MyArchive")
                     .build())
                 .build());
     
             var myArchiveVault = new Vault("myArchiveVault", VaultArgs.builder()
                 .notification(VaultNotificationArgs.builder()
                     .snsTopic(awsSnsTopic.arn())
                     .events(                
                         "ArchiveRetrievalCompleted",
                         "InventoryRetrievalCompleted")
                     .build())
                 .name("MyArchive")
                 .accessPolicy(myArchive.json())
                 .tags(Map.of("Test", "MyArchive"))
                 .build());
     
         }
     }
     
     
    ## Import Using `pulumi import`, import Glacier Vaults using the `name`. For example: ```sh $ pulumi import aws:glacier/vault:Vault archive my_archive ```
    • 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
      Vault​(java.lang.String name)  
      Vault​(java.lang.String name, VaultArgs args)  
      Vault​(java.lang.String name, VaultArgs args, com.pulumi.resources.CustomResourceOptions options)  
    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessPolicy()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static Vault get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VaultState 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.String> location()  
      com.pulumi.core.Output<java.lang.String> name()  
      com.pulumi.core.Output<java.util.Optional<VaultNotification>> notification()  
      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()  
      • 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

      • Vault

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

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

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

      • accessPolicy

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> accessPolicy()
        Returns:
        Policy document. This is a JSON formatted string. The heredoc syntax or `file` function is helpful here. Use the [Glacier Developer Guide](https://docs.aws.amazon.com/amazonglacier/latest/dev/vault-access-policy.html) for more information on Glacier Vault Policy
      • arn

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

        public com.pulumi.core.Output<java.lang.String> location()
        Returns:
        URI of the vault that was created.
      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Name of the Vault. Names can be between 1 and 255 characters long and the valid characters are a-z, A-Z, 0-9, '_' (underscore), '-' (hyphen), and '.' (period).
      • notification

        public com.pulumi.core.Output<java.util.Optional<VaultNotification>> notification()
        Returns:
        Notifications for the Vault. See 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.
      • 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 the 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.
      • get

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