Package com.pulumi.aws.backup

Class VaultNotifications

  • public class VaultNotifications
extends com.pulumi.resources.CustomResource
    Provides an AWS Backup vault notifications resource. ## 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.sns.TopicPolicy;
 import com.pulumi.aws.sns.TopicPolicyArgs;
 import com.pulumi.aws.backup.VaultNotifications;
 import com.pulumi.aws.backup.VaultNotificationsArgs;
 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 testTopic = new Topic("testTopic", TopicArgs.builder()
             .name("backup-vault-events")
             .build());
 
         final var test = IamFunctions.getPolicyDocument(GetPolicyDocumentArgs.builder()
             .statements(GetPolicyDocumentStatementArgs.builder()
                 .principals(GetPolicyDocumentStatementPrincipalArgs.builder()
                     .type("Service")
                     .identifiers("backup.amazonaws.com")
                     .build())
                 .actions("SNS:Publish")
                 .effect("Allow")
                 .resources(testTopic.arn())
                 .sid("__default_statement_ID")
                 .build())
             .policyId("__default_policy_ID")
             .build());
 
         var testTopicPolicy = new TopicPolicy("testTopicPolicy", TopicPolicyArgs.builder()
             .arn(testTopic.arn())
             .policy(test.applyValue(_test -> _test.json()))
             .build());
 
         var testVaultNotifications = new VaultNotifications("testVaultNotifications", VaultNotificationsArgs.builder()
             .backupVaultName("example_backup_vault")
             .snsTopicArn(testTopic.arn())
             .backupVaultEvents(            
                 "BACKUP_JOB_STARTED",
                 "RESTORE_JOB_COMPLETED")
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Backup vault notifications using the `name`. For example: ```sh $ pulumi import aws:backup/vaultNotifications:VaultNotifications test TestVault ```

    • 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> backupVaultArn()  
      com.pulumi.core.Output<java.util.List<java.lang.String>> backupVaultEvents()  
      com.pulumi.core.Output<java.lang.String> backupVaultName()  
      static VaultNotifications get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, VaultNotificationsState 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> region()  
      com.pulumi.core.Output<java.lang.String> snsTopicArn()  

      • 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

      • VaultNotifications

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

      • VaultNotifications

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

      • VaultNotifications

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

      • backupVaultArn

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

      • backupVaultEvents

        public com.pulumi.core.Output<java.util.List<java.lang.String>> backupVaultEvents()
        Returns:
        Array of events that indicate the status of jobs to back up resources to the backup vault.

      • backupVaultName

        public com.pulumi.core.Output<java.lang.String> backupVaultName()
        Returns:
        Name of the backup vault to add notifications for.

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

      • snsTopicArn

        public com.pulumi.core.Output<java.lang.String> snsTopicArn()
        Returns:
        ARN that specifies the topic for a backup vault’s events

      • get

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