Skip to main content

Create AWS Protection Policy​

API to create AWS protection policy

Path Parameters
  • accountId int64 required

    Cloud Rewind account ID.

  • projectId string required

    Cloud Rewind project ID.

  • cloudAssemblyId int64 required

    AWS cloud assembly ID.

Request Body required
  • policyTemplateId int64

    ID of the AWS policy template to be used for the protection policy.
    This is optional. If provided, it must be a valid identifier for the policy template. No other details are required for the Policy Create request except policy activation.

  • name string

    Possible values: >= 3 and <= 50, Value must match regular expression ^[a-zA-Z][a-zA-Z0-9-]*$

    Name of the policy template.
    Constraints: It must begin with a letter and may include only letters, numbers, and hyphens.

  • description string

    Possible values: <= 1000

    Description of the policy template.

  • frequencyType string

    Possible values: [fifteen-minutes, thirty-minutes, hourly, two-hours, three-hours, four-hours, six-hours, eight-hours, twelve-hours, daily, weekly, monthly, yearly]

    Frequency type for the policy.

    ValueDescription
    fifteen-minutesThis defines a protection schedule that occurs every 15 minutes.
    thirty-minutesThis defines a protection schedule that occurs every 30 minutes.
    hourlyThis defines a protection schedule that occurs every hour.
    two-hoursThis defines a protection schedule that occurs every 2 hours.
    three-hoursThis defines a protection schedule that occurs every 3 hours.
    four-hoursThis defines a protection schedule that occurs every 4 hours.
    six-hoursThis defines a protection schedule that occurs every 6 hours.
    eight-hoursThis defines a protection schedule that occurs every 8 hours.
    twelve-hoursThis defines a protection schedule that occurs every 12 hours.
    dailyThis defines a protection schedule that occurs every day.
    weeklyThis defines a protection schedule that occurs every week.
    monthlyThis defines a protection schedule that occurs every month.
    yearlyThis defines a protection schedule that occurs every year.
  • timeZone string

    Specifies the time zone to be used in interpreting schedule.
    The value of this field must be a time zone name from the Tz database
    Example: "America/New_York"

  • frequencyDetails object
  • daysOfWeek string[]

    Possible values: [MONDAY, TUESDAY, WEDNESDAY, THURSDAY, FRIDAY, SATURDAY, SUNDAY]

    Days of the week (e.g., SUNDAY, MONDAY).

  • months string[]

    Possible values: [JANUARY, FEBRUARY, MARCH, APRIL, MAY, JUNE, JULY, AUGUST, SEPTEMBER, OCTOBER, NOVEMBER, DECEMBER]

    Months of the year (e.g., JANUARY, FEBRUARY).

  • daysOfMonth int32[]

    Days of the month (1 to 31).

  • hours int32[]

    Hours of the day (0 to 23).

  • offset int32

    Delays the defined scheduled execution time (in minutes), increasing in 5-minute steps from 0 to 55.

  • retentionCount int32

    Possible values: >= 3 and <= 3500

    Specifies the number of protections to retain.

  • replicaRetentionCount int32

    Possible values: >= 3 and <= 3500

    Specifies the number of replications to retain.

  • policyActivation string required

    Possible values: [immediate, by-policy]

    Activation option for the protection policy.

    ValueDescription
    immediateOnce the policy is created, it is activated immediately and triggers one protection run right away.
    by-policyThe scheduled policy triggers at the specified date and time.
Responses

Created

Schema
  • accountId int64

    Cloud Rewind account ID.

  • projectId string

    Cloud Rewind project ID.

  • id int64

    Unique identifier for the protection policy

  • name string

    Name of the protection policy

  • description string

    Description of the protection policy

  • frequencyType string

    AWS resource type for the protection policy

  • timeZone string

    Time zone for the protection policy schedule

  • frequencyDetails object

    Details about the frequency configuration of the policy template

  • daysOfWeek string[]

    Days of the week

  • months string[]

    Months of the year

  • daysOfMonth int32[]

    Days of the month

  • hours int32[]

    Hours of the day

  • offset int32

    Delays the defined scheduled execution time (in minutes)

  • status string

    Possible values: [enabled, disabled, paused, error, schedule-create-failed, delete-pending, delete-in-progress, delete-snapshots, delete-resources, delete-failed]

    Status of the policy.

    ValueDescription
    enabledThe policy is enabled.
    disabledThe policy is disabled.
    pausedThe policy is paused.
    errorThe policy is in error state.
    schedule-create-failedThe policy scheduler creation failed.
    delete-pendingThe policy delete process is pending.
    delete-in-progressThe policy delete process is in progress.
    delete-snapshotsThe policy delete process is deleting snapshots.
    delete-resourcesThe policy delete process is deleting resources.
    delete-failedThe policy delete process failed.
  • createdAt date-time

    Timestamp indicating when the protection policy was created

  • retentionCount int32

    Number of backups to retain

  • replicationPolicies object[]

    List of replication policies associated with the protection policy

  • cloudConnectionId int64

    AWS replication policy configured cloud connection Id

  • region string

    AWS replication policy configured region

  • status string

    Possible values: [enabled, disabled, paused, error, schedule-create-failed, delete-pending, delete-in-progress, delete-snapshots, delete-resources, delete-failed]

    Status of the policy.

    ValueDescription
    enabledThe policy is enabled.
    disabledThe policy is disabled.
    pausedThe policy is paused.
    errorThe policy is in error state.
    schedule-create-failedThe policy scheduler creation failed.
    delete-pendingThe policy delete process is pending.
    delete-in-progressThe policy delete process is in progress.
    delete-snapshotsThe policy delete process is deleting snapshots.
    delete-resourcesThe policy delete process is deleting resources.
    delete-failedThe policy delete process failed.
  • replicaRetentionCount int32

    Number of replica backups to retain in the configured region

  • policyActivation string

    Activation status of the protection policy

Loading...