Package com.pulumi.aws.backup

Class ReportPlan

  • public class ReportPlan
extends com.pulumi.resources.CustomResource
    Provides an AWS Backup Report 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.ReportPlan;
 import com.pulumi.aws.backup.ReportPlanArgs;
 import com.pulumi.aws.backup.inputs.ReportPlanReportDeliveryChannelArgs;
 import com.pulumi.aws.backup.inputs.ReportPlanReportSettingArgs;
 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 ReportPlan("example", ReportPlanArgs.builder()
             .reportDeliveryChannel(ReportPlanReportDeliveryChannelArgs.builder()
                 .formats(                
                     "CSV",
                     "JSON")
                 .s3BucketName("example-bucket-name")
                 .build())
             .reportSetting(ReportPlanReportSettingArgs.builder()
                 .reportTemplate("RESTORE_JOB_REPORT")
                 .build())
             .name("example_name")
             .description("example description")
             .tags(Map.of("Name", "Example Report Plan"))
             .build());
 
     }
 }
    ## Import Using `pulumi import`, import Backup Report Plan using the `id` which corresponds to the name of the Backup Report Plan. For example: ```sh $ pulumi import aws:backup/reportPlan:ReportPlan test <id> ```

    • 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> arn()  
      com.pulumi.core.Output<java.lang.String> creationTime()  
      com.pulumi.core.Output<java.lang.String> deploymentStatus()  
      com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()  
      static ReportPlan get​(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, ReportPlanState 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<ReportPlanReportDeliveryChannel> reportDeliveryChannel()  
      com.pulumi.core.Output<ReportPlanReportSetting> reportSetting()  
      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

      • ReportPlan

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

      • ReportPlan

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

      • ReportPlan

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

      • arn

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

      • creationTime

        public com.pulumi.core.Output<java.lang.String> creationTime()
        Returns:
        Date and time that a report plan is created, in Unix format and Coordinated Universal Time (UTC).

      • deploymentStatus

        public com.pulumi.core.Output<java.lang.String> deploymentStatus()
        Returns:
        Deployment status of a report plan. The statuses are: `CREATE_IN_PROGRESS` | `UPDATE_IN_PROGRESS` | `DELETE_IN_PROGRESS` | `COMPLETED`.

      • description

        public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
        Returns:
        Description of the report plan with a maximum of 1,024 characters.

      • name

        public com.pulumi.core.Output<java.lang.String> name()
        Returns:
        Unique name of the report plan. The name must be between 1 and 256 characters, starting with a letter, and consisting of letters, numbers, and underscores.

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

      • reportDeliveryChannel

        public com.pulumi.core.Output<ReportPlanReportDeliveryChannel> reportDeliveryChannel()
        Returns:
        Object that contains information about where and how to deliver your reports, specifically your Amazon S3 bucket name, S3 key prefix, and the formats of your reports. Detailed below.

      • reportSetting

        public com.pulumi.core.Output<ReportPlanReportSetting> reportSetting()
        Returns:
        Object that identifies the report template for the report. Reports are built using a report template. 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 report 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.

      • get

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