BackupPolicy class

Provides an Elastic File System (EFS) Backup Policy resource. Backup policies turn automatic backups on or off for an existing file system.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as aws from "@pulumi/aws";

const fs = new aws.efs.FileSystem("fs", {creationToken: "my-product"});
const policy = new aws.efs.BackupPolicy("policy", {
    backupPolicy: {
        status: "ENABLED",
    },
    fileSystemId: fs.id,
});
import pulumi
import pulumi_aws as aws

fs = aws.efs.FileSystem("fs", creation_token="my-product")
policy = aws.efs.BackupPolicy("policy",
    backup_policy={
        "status": "ENABLED",
    },
    file_system_id=fs.id)
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using Aws = Pulumi.Aws;

return await Deployment.RunAsync(() =>
{
    var fs = new Aws.Efs.FileSystem("fs", new()
    {
        CreationToken = "my-product",
    });

    var policy = new Aws.Efs.BackupPolicy("policy", new()
    {
        BackupPolicyDetails = new Aws.Efs.Inputs.BackupPolicyBackupPolicyArgs
        {
            Status = "ENABLED",
        },
        FileSystemId = fs.Id,
    });

});
package main

import (
	"github.com/pulumi/pulumi-aws/sdk/v7/go/aws/efs"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		fs, err := efs.NewFileSystem(ctx, "fs", &efs.FileSystemArgs{
			CreationToken: pulumi.String("my-product"),
		})
		if err != nil {
			return err
		}
		_, err = efs.NewBackupPolicy(ctx, "policy", &efs.BackupPolicyArgs{
			BackupPolicy: &efs.BackupPolicyBackupPolicyArgs{
				Status: pulumi.String("ENABLED"),
			},
			FileSystemId: fs.ID().ToIDOutput().ToStringOutput(),
		})
		if err != nil {
			return err
		}
		return nil
	})
}
pulumi {
  required_providers {
    aws = {
      source = "pulumi/aws"
    }
  }
}

resource "aws_efs_filesystem" "fs" {
  creation_token = "my-product"
}
resource "aws_efs_backuppolicy" "policy" {
  backup_policy = {
    status = "ENABLED"
  }
  file_system_id = aws_efs_filesystem.fs.id
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.aws.efs.FileSystem;
import com.pulumi.aws.efs.FileSystemArgs;
import com.pulumi.aws.efs.BackupPolicy;
import com.pulumi.aws.efs.BackupPolicyArgs;
import com.pulumi.aws.efs.inputs.BackupPolicyBackupPolicyArgs;
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 fs = new FileSystem("fs", FileSystemArgs.builder()
            .creationToken("my-product")
            .build());

        var policy = new BackupPolicy("policy", BackupPolicyArgs.builder()
            .backupPolicy(BackupPolicyBackupPolicyArgs.builder()
                .status("ENABLED")
                .build())
            .fileSystemId(fs.id())
            .build());

    }
}
resources:
  fs:
    type: aws:efs:FileSystem
    properties:
      creationToken: my-product
  policy:
    type: aws:efs:BackupPolicy
    properties:
      backupPolicy:
        status: ENABLED
      fileSystemId: ${fs.id}

Import

Using pulumi import, import the EFS backup policies using the id. For example:

$ pulumi import aws:efs/backupPolicy:BackupPolicy example fs-6fa144c6

Constructors

BackupPolicy(String name, {BackupPolicyArgs? args, CustomResourceOptions? options})
Creates a new BackupPolicy. name The Pulumi resource name. args Arguments used to configure this BackupPolicy. The set of arguments for BackupPolicy. options Resource options controlling this resource's behavior.
BackupPolicy.reference(String urn)
Creates a typed reference to an existing BackupPolicy resource.

Properties

backupPolicy ↔ Output<BackupPolicyBackupPolicy>
A backupPolicy object (documented below).
latefinal
childResources → Set<Resource>
finalinherited
completionSources ↔ Map<String, IOutputCompletionSource>
latefinalinherited
fileSystemId ↔ Output<String>
The ID of the EFS file system.
latefinal
hashCode → int
The hash code for this object.
no setterinherited
id ↔ Output<String>
getter/setter pairinherited
isCustom → bool
Returns whether this resource is provider-managed.
no setterinherited
isProtected → bool
Returns whether this resource is protected from deletion.
no setterinherited
isRemote → bool
Whether this resource is registered as remote.
no setterinherited
isResourceReference → bool
Whether this instance represents a resource value returned over RPC.
finalinherited
region ↔ Output<String>
Region where this resource will be managed. Defaults to the Region set in the provider configuration.
latefinal
resourceTransforms → List<ResourceTransform>
Inherited/explicit async transforms.
no setterinherited
runtimeType → Type
A representation of the runtime type of the object.
no setterinherited
transformations → List<ResourceTransformation>
Inherited/explicit legacy transformations.
no setterinherited
urn ↔ Output<String>
latefinalinherited

Methods

failId(Object error) → void
Completes this resource ID with an error when registration fails.
inherited
failOutputs(Object error) → void
Completes all output properties with error.
inherited
failUrn(Object error) → void
Completes this resource URN with an error when registration fails.
inherited
getProvider(String moduleMember) → ProviderResource?
Returns provider for moduleMember's package, if configured.
inherited
getResourceName() → String
Returns this resource's logical name.
inherited
getResourceType() → String
Returns this resource's Pulumi type token.
inherited
noSuchMethod(Invocation invocation) → dynamic
Invoked when a nonexistent method or property is accessed.
inherited
registerOutput<T>(String propertyName, {Object? decoder(Object?)?, bool isSecret = false}) → Output<T>
Registers a dynamic output property for this resource.
inherited
resolveId(String? value, {required bool isKnown}) → void
Resolves the provider-assigned ID for this resource.
inherited
resolveOutputs(Struct outputs) → void
Resolves all output properties from a monitor response payload.
inherited
resolveUrn(String value) → void
Resolves this resource's URN once assigned by the engine.
inherited
serializeProperties(Map<String, dynamic> properties) → Future<Struct>
Serializes resource properties for RPC transmission.
inherited
toString() → String
A string representation of this object.
inherited

Operators

operator ==(Object other) → bool
The equality operator.
inherited

Static Methods

get(String name, Input<String> id, {BackupPolicyState? state, CustomResourceOptions? options}) → BackupPolicy
Gets an existing BackupPolicy resource's state with the given name and id.