Skip to main content

Create a protection group​

Creates a new protection group by specifying object filters. Appearance in datasources/protection-groups read/listing is asynchronous and may take a few seconds to minutes at most. As a result, the protection group won't be protectable via /policies/assignments until it appears in the /datasources/protection-groups endpoint. Additionally, to create a protection group in the context of another Organizational Unit, refer to the Getting Started documentation.

Request Body required
  • bucket_rule string

    The following table describes the possible conditions for a bucket to be automatically added to a protection group.

    FieldRule ConditionDescription
    aws_tag$eqDenotes the AWS tag(s) to conditionalize on {"aws_tag":{"$eq":{"key":"Environment", "value":"Prod"}}}
    account_native_id$eqDenotes the AWS account to conditionalize on {"account_native_id":{"$eq":"111111111111"}}
    aws_region$eqDenotes the AWS region to conditionalize on {"aws_region":{"$eq":"us-west-2"}}
  • description string

    The user-assigned description of the protection group.

  • name string required

    The user-assigned name of the protection group.

  • object_filter object required

    ObjectFilter defines which objects will be backed up.

  • exclude_prefix_expressions string[]

    A list of desired object prefixes to exclude in this protection group's backups. An object that matches any of these prefixes will not be in the backup, even if it matches an include expression. A wildcard * can be used to match any number of characters, except for the / character that is used as a folder separator, and must be matched explicitly. If an asterisk * needs to be matched explicitly, escape the asterisk with \*.

  • include_prefix_expressions string[]

    A list of desired object prefixes to include in this protection group's backups. If this input is non-empty, an object must match one of the given prefixes to be included in the backup. A wildcard * can be used to match any number of characters, except for the / character that is used as a folder separator, and must be matched explicitly. If an asterisk * needs to be matched explicitly, escape the asterisk with \*.

  • latest_version_only boolean

    Whether to back up only the latest object version.

  • prefix_filters object[]

    DEPRECATED: Please use the new include_prefix_expressions and exclude_prefix_expressions fields to specify all desired prefix constraints. Any prefix filters here will be converted to the new expression fields.

  • excluded_sub_prefixes string[]

    List of subprefixes to exclude from the prefix.

  • prefix string

    Prefix to include.

  • storage_classes string[] required

    Storage class to include in the backup. If not specified, then all objects across all storage classes will be backed up. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, and S3 One Zone-IA.

Responses

Success

Schema
  • _embedded object

    Embedded responses related to the resource.

  • _links object

    URLs to pages related to the resource.

  • _self object

    The HATEOAS link to this resource.

  • href string

    The URI for the referenced operation.

  • templated boolean

    Determines whether the "href" link is a URI template. If set to true, the "href" link is a URI template.

  • type string

    The HTTP method to be used with the "href" link for the referenced operation.

  • backup_target_aws_region string

    The backup target AWS region associated with the protection group, empty if in-region or not configured.

  • backup_tier_stats object[]

    TotalBackedUpSizeBytes, TotalBackedUpObjectCount for each backup tier

  • backup_tier string

    The backup tier name.

  • total_backed_up_object_count int64

    Cumulative count of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • total_backed_up_size_bytes int64

    Cumulative size of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • bucket_count int64

    Number of buckets

  • bucket_rule string

    The following table describes the possible conditions for a bucket to be automatically added to a protection group.

    FieldRule ConditionDescription
    aws_tag$eqDenotes the AWS tag(s) to conditionalize on {"aws_tag":{"$eq":{"key":"Environment", "value":"Prod"}}}
    account_native_id$eqDenotes the AWS account to conditionalize on {"account_native_id":{"$eq":"111111111111"}}
    aws_region$eqDenotes the AWS region to conditionalize on {"aws_region":{"$eq":"us-west-2"}}
  • created_timestamp string

    Creation time of the protection group in RFC-3339 format.

  • description string

    The user-assigned description of the protection group.

  • id string

    The Clumio-assigned ID of the protection group.

  • is_backup_target_region_configured boolean

    Whether the protection group already has a backup target configured by a policy, or is open to be protected by an in-region or out-of-region S3 policy.

  • is_deleted boolean

    Determines whether the protection group is active or has been deleted. Deleted protection groups may be purged after some time once there are no active backups associated with it.

  • last_backup_timestamp string

    Time of the last backup in RFC-3339 format.

  • last_continuous_backup_timestamp string

    Time of the last successful continuous backup in RFC-3339 format.

  • modified_timestamp string

    Modified time of the protection group in RFC-3339 format.

  • name string

    The user-assigned name of the protection group.

  • object_filter object

    ObjectFilter defines which objects will be backed up.

  • exclude_prefix_expressions string[]

    A list of desired object prefixes to exclude in this protection group's backups. An object that matches any of these prefixes will not be in the backup, even if it matches an include expression. A wildcard * can be used to match any number of characters, except for the / character that is used as a folder separator, and must be matched explicitly. If an asterisk * needs to be matched explicitly, escape the asterisk with \*.

  • include_prefix_expressions string[]

    A list of desired object prefixes to include in this protection group's backups. If this input is non-empty, an object must match one of the given prefixes to be included in the backup. A wildcard * can be used to match any number of characters, except for the / character that is used as a folder separator, and must be matched explicitly. If an asterisk * needs to be matched explicitly, escape the asterisk with \*.

  • latest_version_only boolean

    Whether to back up only the latest object version.

  • prefix_filters object[]

    DEPRECATED: Please use the new include_prefix_expressions and exclude_prefix_expressions fields to specify all desired prefix constraints. Any prefix filters here will be converted to the new expression fields.

  • excluded_sub_prefixes string[]

    List of subprefixes to exclude from the prefix.

  • prefix string

    Prefix to include.

  • storage_classes string[]

    Storage class to include in the backup. If not specified, then all objects across all storage classes will be backed up. Valid values are: S3 Standard, S3 Standard-IA, S3 Intelligent-Tiering, and S3 One Zone-IA.

  • organizational_unit_id string

    The Clumio-assigned ID of the organizational unit associated with the Protection Group.

  • total_backed_up_object_count int64

    Cumulative count of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • total_backed_up_size_bytes int64

    Cumulative size of all unexpired objects in each backup (any new or updated since the last backup) that have been backed up as part of this protection group

  • version int64

    Version of the protection group. The version number is incremented every time a change is made to the protection group.

Loading...