awscc.backup_framework

Filters

  • event

  • reduce

  • value

Actions

delete

Parent base class for filters and actions.

properties:
  type:
    enum:
    - delete
required:
- type

Permissions - backup:DeleteFramework, backup:DescribeFramework

update

Parent base class for filters and actions.

definitions:
  ControlInputParameter:
    additionalProperties: false
    properties:
      ParameterName:
        type: string
      ParameterValue:
        type: string
    required:
    - ParameterName
    - ParameterValue
    type: object
  FrameworkControl:
    additionalProperties: false
    properties:
      ControlInputParameters:
        description: A list of ParameterName and ParameterValue pairs.
        insertionOrder: false
        items:
          additionalProperties: false
          properties:
            ParameterName:
              type: string
            ParameterValue:
              type: string
          required:
          - ParameterName
          - ParameterValue
          type: object
        type: array
        uniqueItems: true
      ControlName:
        description: The name of a control. This name is between 1 and 256 characters.
        type: string
      ControlScope:
        additionalProperties: false
        description: 'The scope of a control. The control scope defines what the control
          will evaluate. Three examples of control scopes are: a specific backup plan,
          all backup plans with a specific tag, or all backup plans.'
        properties:
          ComplianceResourceIds:
            description: The ID of the only AWS resource that you want your control
              scope to contain.
            insertionOrder: false
            items:
              type: string
            type: array
          ComplianceResourceTypes:
            description: Describes whether the control scope includes one or more
              types of resources, such as `EFS` or `RDS`.
            insertionOrder: false
            items:
              type: string
            type: array
          Tags:
            description: Describes whether the control scope includes resources with
              one or more tags. Each tag is a key-value pair.
            insertionOrder: false
            items:
              additionalProperties: false
              description: A key-value pair to associate with a resource.
              properties:
                Key:
                  description: 'The key name of the tag. You can specify a value that
                    is 1 to 128 Unicode characters in length and cannot be prefixed
                    with aws:. You can use any of the following characters: the set
                    of Unicode letters, digits, whitespace, _, ., /, =, +, and -.'
                  maxLength: 128
                  minLength: 1
                  type: string
                Value:
                  description: 'The value for the tag. You can specify a value that
                    is 0 to 256 Unicode characters in length and cannot be prefixed
                    with aws:. You can use any of the following characters: the set
                    of Unicode letters, digits, whitespace, _, ., /, =, +, and -.'
                  maxLength: 256
                  minLength: 0
                  type: string
              required:
              - Key
              - Value
              type: object
            type: array
        type: object
    required:
    - ControlName
    type: object
  Tag:
    additionalProperties: false
    description: A key-value pair to associate with a resource.
    properties:
      Key:
        description: 'The key name of the tag. You can specify a value that is 1 to
          128 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 128
        minLength: 1
        type: string
      Value:
        description: 'The value for the tag. You can specify a value that is 0 to
          256 Unicode characters in length and cannot be prefixed with aws:. You can
          use any of the following characters: the set of Unicode letters, digits,
          whitespace, _, ., /, =, +, and -.'
        maxLength: 256
        minLength: 0
        type: string
    required:
    - Key
    - Value
    type: object
properties:
  FrameworkControls:
    description: Contains detailed information about all of the controls of a framework.
      Each framework must contain at least one control.
    insertionOrder: false
    items:
      additionalProperties: false
      properties:
        ControlInputParameters:
          description: A list of ParameterName and ParameterValue pairs.
          insertionOrder: false
          items:
            additionalProperties: false
            properties:
              ParameterName:
                type: string
              ParameterValue:
                type: string
            required:
            - ParameterName
            - ParameterValue
            type: object
          type: array
          uniqueItems: true
        ControlName:
          description: The name of a control. This name is between 1 and 256 characters.
          type: string
        ControlScope:
          additionalProperties: false
          description: 'The scope of a control. The control scope defines what the
            control will evaluate. Three examples of control scopes are: a specific
            backup plan, all backup plans with a specific tag, or all backup plans.'
          properties:
            ComplianceResourceIds:
              description: The ID of the only AWS resource that you want your control
                scope to contain.
              insertionOrder: false
              items:
                type: string
              type: array
            ComplianceResourceTypes:
              description: Describes whether the control scope includes one or more
                types of resources, such as `EFS` or `RDS`.
              insertionOrder: false
              items:
                type: string
              type: array
            Tags:
              description: Describes whether the control scope includes resources
                with one or more tags. Each tag is a key-value pair.
              insertionOrder: false
              items:
                additionalProperties: false
                description: A key-value pair to associate with a resource.
                properties:
                  Key:
                    description: 'The key name of the tag. You can specify a value
                      that is 1 to 128 Unicode characters in length and cannot be
                      prefixed with aws:. You can use any of the following characters:
                      the set of Unicode letters, digits, whitespace, _, ., /, =,
                      +, and -.'
                    maxLength: 128
                    minLength: 1
                    type: string
                  Value:
                    description: 'The value for the tag. You can specify a value that
                      is 0 to 256 Unicode characters in length and cannot be prefixed
                      with aws:. You can use any of the following characters: the
                      set of Unicode letters, digits, whitespace, _, ., /, =, +, and
                      -.'
                    maxLength: 256
                    minLength: 0
                    type: string
                required:
                - Key
                - Value
                type: object
              type: array
          type: object
      required:
      - ControlName
      type: object
    type: array
    uniqueItems: true
  FrameworkDescription:
    description: An optional description of the framework with a maximum 1,024 characters.
    maxLength: 1024
    minLength: 0
    type: string
  FrameworkTags:
    description: Metadata that you can assign to help organize the frameworks that
      you create. Each tag is a key-value pair.
    insertionOrder: false
    items:
      additionalProperties: false
      description: A key-value pair to associate with a resource.
      properties:
        Key:
          description: 'The key name of the tag. You can specify a value that is 1
            to 128 Unicode characters in length and cannot be prefixed with aws:.
            You can use any of the following characters: the set of Unicode letters,
            digits, whitespace, _, ., /, =, +, and -.'
          maxLength: 128
          minLength: 1
          type: string
        Value:
          description: 'The value for the tag. You can specify a value that is 0 to
            256 Unicode characters in length and cannot be prefixed with aws:. You
            can use any of the following characters: the set of Unicode letters, digits,
            whitespace, _, ., /, =, +, and -.'
          maxLength: 256
          minLength: 0
          type: string
      required:
      - Key
      - Value
      type: object
    type: array
  type:
    enum:
    - update

Permissions - backup:UpdateFramework, backup:ListTags, backup:TagResource, backup:UntagResource