Amazonka.Backup.Types.Framework

Documentation

data Framework

Contains detailed information about a framework. Frameworks contain controls, which evaluate and report on your backup events and resources. Frameworks generate daily compliance results.

See: newFramework smart constructor.

Constructors

Framework'

Fields

• creationTime :: Maybe POSIX

  The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

• deploymentStatus :: Maybe Text

  The deployment status of a framework. The statuses are:

  CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

• frameworkArn :: Maybe Text

  An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

• frameworkDescription :: Maybe Text

  An optional description of the framework with a maximum 1,024 characters.

• frameworkName :: Maybe Text

  The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

• numberOfControls :: Maybe Int

  The number of controls contained by the framework.

Instances

FromJSON Framework

Defined in Amazonka.Backup.Types.Framework

Methods

parseJSON :: Value -> Parser Framework

parseJSONList :: Value -> Parser [Framework]

Generic Framework

Defined in Amazonka.Backup.Types.Framework

Associated Types

type Rep Framework :: Type -> Type

Methods

from :: Framework -> Rep Framework x

to :: Rep Framework x -> Framework

Read Framework

Defined in Amazonka.Backup.Types.Framework

Methods

readsPrec :: Int -> ReadS Framework

readList :: ReadS [Framework]

readPrec :: ReadPrec Framework

readListPrec :: ReadPrec [Framework]

Show Framework

Defined in Amazonka.Backup.Types.Framework

Methods

showsPrec :: Int -> Framework -> ShowS

show :: Framework -> String

showList :: [Framework] -> ShowS

NFData Framework

Defined in Amazonka.Backup.Types.Framework

Methods

rnf :: Framework -> ()

Eq Framework

Defined in Amazonka.Backup.Types.Framework

Methods

(==) :: Framework -> Framework -> Bool

(/=) :: Framework -> Framework -> Bool

Hashable Framework

Defined in Amazonka.Backup.Types.Framework

Methods

hashWithSalt :: Int -> Framework -> Int

hash :: Framework -> Int

type Rep Framework

Defined in Amazonka.Backup.Types.Framework

type Rep Framework = D1 ('MetaData "Framework" "Amazonka.Backup.Types.Framework" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "Framework'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "creationTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :*: (S1 ('MetaSel ('Just "deploymentStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "frameworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "frameworkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "numberOfControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int))))))

newFramework :: Framework

Create a value of Framework with all optional fields omitted.

Use generic-lens or optics to modify other optional fields.

The following record fields are available, with the corresponding lenses provided for backwards compatibility:

$sel:creationTime:Framework', framework_creationTime - The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

$sel:deploymentStatus:Framework', framework_deploymentStatus - The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

$sel:frameworkArn:Framework', framework_frameworkArn - An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

$sel:frameworkDescription:Framework', framework_frameworkDescription - An optional description of the framework with a maximum 1,024 characters.

$sel:frameworkName:Framework', framework_frameworkName - The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

$sel:numberOfControls:Framework', framework_numberOfControls - The number of controls contained by the framework.

framework_creationTime :: Lens' Framework (Maybe UTCTime)

The date and time that a framework is created, in ISO 8601 representation. The value of CreationTime is accurate to milliseconds. For example, 2020-07-10T15:00:00.000-08:00 represents the 10th of July 2020 at 3:00 PM 8 hours behind UTC.

framework_deploymentStatus :: Lens' Framework (Maybe Text)

The deployment status of a framework. The statuses are:

CREATE_IN_PROGRESS | UPDATE_IN_PROGRESS | DELETE_IN_PROGRESS | COMPLETED | FAILED

framework_frameworkArn :: Lens' Framework (Maybe Text)

An Amazon Resource Name (ARN) that uniquely identifies a resource. The format of the ARN depends on the resource type.

framework_frameworkDescription :: Lens' Framework (Maybe Text)

An optional description of the framework with a maximum 1,024 characters.

framework_frameworkName :: Lens' Framework (Maybe Text)

The unique name of a framework. This name is between 1 and 256 characters, starting with a letter, and consisting of letters (a-z, A-Z), numbers (0-9), and underscores (_).

framework_numberOfControls :: Lens' Framework (Maybe Int)

The number of controls contained by the framework.