Amazonka.Backup.CreateFramework

Creates a framework with one or more controls. A framework is a collection of controls that you can use to evaluate your backup practices. By using pre-built customizable controls to define your policies, you can evaluate whether your backup practices comply with your policies and which resources are not yet in compliance.

Creating a Request

data CreateFramework

See: newCreateFramework smart constructor.

Constructors

CreateFramework'

Fields

• frameworkDescription :: Maybe Text

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

• frameworkTags :: Maybe (HashMap Text Text)

  Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

• idempotencyToken :: Maybe Text

  A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

• frameworkName :: Text

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

• frameworkControls :: [FrameworkControl]

  A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Instances

ToJSON CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

toJSON :: CreateFramework -> Value

toEncoding :: CreateFramework -> Encoding

toJSONList :: [CreateFramework] -> Value

toEncodingList :: [CreateFramework] -> Encoding

ToHeaders CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

toHeaders :: CreateFramework -> [Header]

ToPath CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

toPath :: CreateFramework -> ByteString

ToQuery CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

toQuery :: CreateFramework -> QueryString

AWSRequest CreateFramework

Defined in Amazonka.Backup.CreateFramework

Associated Types

type AWSResponse CreateFramework

Methods

request :: (Service -> Service) -> CreateFramework -> Request CreateFramework

response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy CreateFramework -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse CreateFramework)))

Generic CreateFramework

Defined in Amazonka.Backup.CreateFramework

Associated Types

type Rep CreateFramework :: Type -> Type

Methods

from :: CreateFramework -> Rep CreateFramework x

to :: Rep CreateFramework x -> CreateFramework

Read CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

readsPrec :: Int -> ReadS CreateFramework

readList :: ReadS [CreateFramework]

readPrec :: ReadPrec CreateFramework

readListPrec :: ReadPrec [CreateFramework]

Show CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

showsPrec :: Int -> CreateFramework -> ShowS

show :: CreateFramework -> String

showList :: [CreateFramework] -> ShowS

NFData CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

rnf :: CreateFramework -> ()

Eq CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

(==) :: CreateFramework -> CreateFramework -> Bool

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

Hashable CreateFramework

Defined in Amazonka.Backup.CreateFramework

Methods

hashWithSalt :: Int -> CreateFramework -> Int

hash :: CreateFramework -> Int

type AWSResponse CreateFramework

Defined in Amazonka.Backup.CreateFramework

type AWSResponse CreateFramework = CreateFrameworkResponse

type Rep CreateFramework

Defined in Amazonka.Backup.CreateFramework

type Rep CreateFramework = D1 ('MetaData "CreateFramework" "Amazonka.Backup.CreateFramework" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "CreateFramework'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "frameworkDescription") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "frameworkTags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text)))) :*: (S1 ('MetaSel ('Just "idempotencyToken") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "frameworkControls") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 [FrameworkControl])))))

newCreateFramework

Arguments

:: Text

CreateFramework

-> CreateFramework

Create a value of CreateFramework 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:

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

$sel:frameworkTags:CreateFramework', createFramework_frameworkTags - Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

$sel:idempotencyToken:CreateFramework', createFramework_idempotencyToken - A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

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

$sel:frameworkControls:CreateFramework', createFramework_frameworkControls - A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Request Lenses

createFramework_frameworkDescription :: Lens' CreateFramework (Maybe Text)

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

createFramework_frameworkTags :: Lens' CreateFramework (Maybe (HashMap Text Text))

Metadata that you can assign to help organize the frameworks that you create. Each tag is a key-value pair.

createFramework_idempotencyToken :: Lens' CreateFramework (Maybe Text)

A customer-chosen string that you can use to distinguish between otherwise identical calls to CreateFrameworkInput. Retrying a successful request with the same idempotency token results in a success message with no action taken.

createFramework_frameworkName :: Lens' CreateFramework Text

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

createFramework_frameworkControls :: Lens' CreateFramework [FrameworkControl]

A list of the controls that make up the framework. Each control in the list has a name, input parameters, and scope.

Destructuring the Response

data CreateFrameworkResponse

See: newCreateFrameworkResponse smart constructor.

Constructors

CreateFrameworkResponse'

Fields

• frameworkArn :: Maybe Text

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

• frameworkName :: Maybe Text

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

• httpStatus :: Int

  The response's http status code.

Instances

Generic CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

Associated Types

type Rep CreateFrameworkResponse :: Type -> Type

Methods

from :: CreateFrameworkResponse -> Rep CreateFrameworkResponse x

to :: Rep CreateFrameworkResponse x -> CreateFrameworkResponse

Read CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

Methods

readsPrec :: Int -> ReadS CreateFrameworkResponse

readList :: ReadS [CreateFrameworkResponse]

readPrec :: ReadPrec CreateFrameworkResponse

readListPrec :: ReadPrec [CreateFrameworkResponse]

Show CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

Methods

showsPrec :: Int -> CreateFrameworkResponse -> ShowS

show :: CreateFrameworkResponse -> String

showList :: [CreateFrameworkResponse] -> ShowS

NFData CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

Methods

rnf :: CreateFrameworkResponse -> ()

Eq CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

Methods

(==) :: CreateFrameworkResponse -> CreateFrameworkResponse -> Bool

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

type Rep CreateFrameworkResponse

Defined in Amazonka.Backup.CreateFramework

type Rep CreateFrameworkResponse = D1 ('MetaData "CreateFrameworkResponse" "Amazonka.Backup.CreateFramework" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "CreateFrameworkResponse'" 'PrefixI 'True) (S1 ('MetaSel ('Just "frameworkArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "frameworkName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int))))

newCreateFrameworkResponse

Arguments

:: Int

$sel:httpStatus:CreateFrameworkResponse'

-> CreateFrameworkResponse

Create a value of CreateFrameworkResponse 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:

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

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

$sel:httpStatus:CreateFrameworkResponse', createFrameworkResponse_httpStatus - The response's http status code.

Response Lenses

createFrameworkResponse_frameworkArn :: Lens' CreateFrameworkResponse (Maybe Text)

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

createFrameworkResponse_frameworkName :: Lens' CreateFrameworkResponse (Maybe Text)

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

createFrameworkResponse_httpStatus :: Lens' CreateFrameworkResponse Int

The response's http status code.