Package com.pulumi.aws.backup

Class Plan

  • public class Plan
extends com.pulumi.resources.CustomResource
    Provides an AWS Backup plan resource. ## Example Usage 
     
 package generated_program;
 
 import com.pulumi.Context;
 import com.pulumi.Pulumi;
 import com.pulumi.core.Output;
 import com.pulumi.aws.backup.Plan;
 import com.pulumi.aws.backup.PlanArgs;
 import com.pulumi.aws.backup.inputs.PlanAdvancedBackupSettingArgs;
 import com.pulumi.aws.backup.inputs.PlanRuleArgs;
 import com.pulumi.aws.backup.inputs.PlanRuleLifecycleArgs;
 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 Plan("example", PlanArgs.builder()
             .advancedBackupSettings(PlanAdvancedBackupSettingArgs.builder()
                 .backupOptions(Map.of("WindowsVSS", "enabled"))
                 .resourceType("EC2")
                 .build())
             .rules(PlanRuleArgs.builder()
                 .lifecycle(PlanRuleLifecycleArgs.builder()
                     .deleteAfter(14)
                     .build())
                 .ruleName("my_example_backup_rule")
                 .targetVaultName(test.name())
                 .schedule("cron(0 12 * * ? *)")
                 .build())
             .name("my_example_backup_plan")
             .build());
 
     }
 }
    ## Import ### Identity Schema #### Required * `id` (String) Backup Plan ID. #### Optional * `accountId` (String) AWS Account where this resource is managed. * `region` (String) Region where this resource is managed. Using `pulumi import`, import Backup Plan using the `id`. For example: ```sh $ pulumi import aws:backup/plan:Plan example abc123 ```

    • 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
      Plan​(java.lang.String name)  
      Plan​(java.lang.String name, PlanArgs args)  
      Plan​(java.lang.String name, PlanArgs 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.util.List<PlanAdvancedBackupSetting>>> advancedBackupSettings()  
      com.pulumi.core.Output<java.lang.String> arn()  
      static Plan get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, PlanState 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> name()  
      com.pulumi.core.Output<java.lang.String> region()  
      com.pulumi.core.Output<java.util.List<PlanRule>> rules()  
      com.pulumi.core.Output<java.util.Optional<java.util.List<PlanScanSetting>>> scanSettings()  
      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.String> 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

      • Plan

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

      • Plan

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

      • Plan

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

      • advancedBackupSettings

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanAdvancedBackupSetting>>> advancedBackupSettings()
        Returns:
        Object that specifies backup options for each resource type. Detailed below.

      • arn

        public com.pulumi.core.Output<java.lang.String> arn()
        Returns:
        ARN of the backup plan.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Display name of a backup plan.

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

      • rules

        public com.pulumi.core.Output<java.util.List<PlanRule>> rules()
        Returns:
        Rule that specifies a scheduled task used to back up a selection of resources. Detailed below.

      • scanSettings

        public com.pulumi.core.Output<java.util.Optional<java.util.List<PlanScanSetting>>> scanSettings()
        Returns:
        Block for scanning configuration for the backup rule and includes the malware scanner, and scan mode of either full or incremental. Detailed below.

      • tags

        public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,​java.lang.String>>> tags()
        Returns:
        Metadata that you can assign to help organize the plans you create. .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.String> version()
        Returns:
        Unique, randomly generated, Unicode, UTF-8 encoded string that serves as the version ID of the backup plan.

      • get

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