Table Of Contents

Feedback

User Guide

First time using the AWS CLI? See the User Guide for help getting started.

Note: You are viewing the documentation for an older major version of the AWS CLI (version 1).

AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . efs ]

put-backup-policy

Description

Updates the file system's backup policy. Use this action to start or stop automatic backups of the file system.

See also: AWS API Documentation

See 'aws help' for descriptions of global parameters.

Synopsis

  put-backup-policy
--file-system-id <value>
--backup-policy <value>
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]

Options

--file-system-id (string)

Specifies which EFS file system to update the backup policy for.

--backup-policy (structure)

The backup policy included in the PutBackupPolicy request.

Status -> (string)

Describes the status of the file system's backup policy.

  • **ENABLED ** - EFS is automatically backing up the file system.
  • **ENABLING ** - EFS is turning on automatic backups for the file system.
  • **DISABLED ** - automatic back ups are turned off for the file system.
  • **DISABLING ** - EFS is turning off automatic backups for the file system.

Shorthand Syntax:

Status=string

JSON Syntax:

{
  "Status": "ENABLED"|"ENABLING"|"DISABLED"|"DISABLING"
}

--cli-input-json (string) Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, the CLI values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See 'aws help' for descriptions of global parameters.

Output

BackupPolicy -> (structure)

Describes the file system's backup policy, indicating whether automatic backups are turned on or off..

Status -> (string)

Describes the status of the file system's backup policy.

  • **ENABLED ** - EFS is automatically backing up the file system.
  • **ENABLING ** - EFS is turning on automatic backups for the file system.
  • **DISABLED ** - automatic back ups are turned off for the file system.
  • **DISABLING ** - EFS is turning off automatic backups for the file system.