Note:

You are viewing the documentation for an older major version of the AWS CLI (version 1). To view this page for the AWS CLI version 2, click here.

We announced the upcoming end-of-support for the AWS CLI v1. For dates, additional details, and information on how to migrate, please refer to the linked announcement. For more information see the AWS CLI version 2 installation instructions and migration guide.

[ aws . resiliencehubv2 ]

update-policy

Description

Updates an existing resilience policy.

See also: AWS API Documentation

Synopsis

  update-policy
--policy-arn <value>
[--description <value>]
[--availability-slo <value>]
[--multi-az <value>]
[--multi-region <value>]
[--data-recovery <value>]
[--cli-input-json <value>]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--v2-debug]

Options

--policy-arn (string)

ARN identifier.

--description (string)

Resource description for services and policies.

--availability-slo (structure)

The updated availability SLO for the policy.

target -> (double)

The target availability percentage, expressed as a value between 0 and 100.

Shorthand Syntax:

target=double

JSON Syntax:

{
  "target": double
}

--multi-az (structure)

The updated multi-AZ disaster recovery targets for the policy.

rtoInMinutes -> (integer)

The recovery time objective (RTO) target for multi-AZ, in minutes.

rpoInMinutes -> (integer)

The recovery point objective (RPO) target for multi-AZ, in minutes.

disasterRecoveryApproach -> (string)

The disaster recovery approach for multi-AZ.

Shorthand Syntax:

rtoInMinutes=integer,rpoInMinutes=integer,disasterRecoveryApproach=string

JSON Syntax:

{
  "rtoInMinutes": integer,
  "rpoInMinutes": integer,
  "disasterRecoveryApproach": "ACTIVE_ACTIVE"|"HOT_STANDBY"|"WARM_STANDBY"|"PILOT_LIGHT"|"BACKUP_AND_RESTORE"
}

--multi-region (structure)

The updated multi-Region disaster recovery targets for the policy.

rtoInMinutes -> (integer)

The recovery time objective (RTO) target for multi-Region, in minutes.

rpoInMinutes -> (integer)

The recovery point objective (RPO) target for multi-Region, in minutes.

disasterRecoveryApproach -> (string)

The disaster recovery approach for multi-Region.

Shorthand Syntax:

rtoInMinutes=integer,rpoInMinutes=integer,disasterRecoveryApproach=string

JSON Syntax:

{
  "rtoInMinutes": integer,
  "rpoInMinutes": integer,
  "disasterRecoveryApproach": "ACTIVE_ACTIVE"|"HOT_STANDBY"|"WARM_STANDBY"|"PILOT_LIGHT"|"BACKUP_AND_RESTORE"
}

--data-recovery (structure)

The updated data recovery targets for the policy.

timeBetweenBackupsInMinutes -> (integer)

The target time between backups, in minutes.

Shorthand Syntax:

timeBetweenBackupsInMinutes=integer

JSON Syntax:

{
  "timeBetweenBackupsInMinutes": integer
}

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

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.

--output (string)

The formatting style for command output.

• json
• text
• table

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

• on
• off
• auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--v2-debug (boolean)

Enable AWS CLI v2 migration assistance. Prints warnings if the command would face a breaking change after swapping AWS CLI v1 for AWS CLI v2 in the current environment. Prints one warning for each breaking change detected.

Output

policy -> (structure)

The updated policy.

policyArn -> (string)

ARN identifier.

name -> (string)

Resource name (used in ARN — no spaces allowed).

description -> (string)

Resource description for services and policies.

availabilitySlo -> (structure)

The availability SLO defined in the policy.

target -> (double)

The target availability percentage, expressed as a value between 0 and 100.

multiAz -> (structure)

The multi-AZ disaster recovery targets defined in the policy.

rtoInMinutes -> (integer)

The recovery time objective (RTO) target for multi-AZ, in minutes.

rpoInMinutes -> (integer)

The recovery point objective (RPO) target for multi-AZ, in minutes.

disasterRecoveryApproach -> (string)

The disaster recovery approach for multi-AZ.

multiRegion -> (structure)

The multi-Region disaster recovery targets defined in the policy.

rtoInMinutes -> (integer)

The recovery time objective (RTO) target for multi-Region, in minutes.

rpoInMinutes -> (integer)

The recovery point objective (RPO) target for multi-Region, in minutes.

disasterRecoveryApproach -> (string)

The disaster recovery approach for multi-Region.

dataRecovery -> (structure)

The data recovery targets defined in the policy.

timeBetweenBackupsInMinutes -> (integer)

The target time between backups, in minutes.

kmsKeyId -> (string)

KMS key identifier — accepts key ID, key ARN, alias name, or alias ARN.

tags -> (map)

Resource tags.

key -> (string)

Tag key.

value -> (string)

Tag value.

associatedServiceCount -> (integer)

The number of services associated with this policy.

createdAt -> (timestamp)

The timestamp when the policy was created.

updatedAt -> (timestamp)

The timestamp when the policy was last updated.