Copyright	(c) 2013-2023 Brendan Hay
License	Mozilla Public License, v. 2.0.
Maintainer	Brendan Hay
Stability	auto-generated
Portability	non-portable (GHC extensions)
Safe Haskell	Safe-Inferred
Language	Haskell2010

Amazonka.Backup.Types.ControlScope

Description

Synopsis

data ControlScope = ControlScope' {
- complianceResourceIds :: Maybe (NonEmpty Text)
- complianceResourceTypes :: Maybe [Text]
- tags :: Maybe (HashMap Text Text)
}
newControlScope :: ControlScope
controlScope_complianceResourceIds :: Lens' ControlScope (Maybe (NonEmpty Text))
controlScope_complianceResourceTypes :: Lens' ControlScope (Maybe [Text])
controlScope_tags :: Lens' ControlScope (Maybe (HashMap Text Text))

Documentation

data ControlScope Source #

A framework consists of one or more controls. Each control has its own control scope. The control scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. If no scope is specified, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

To set a control scope that includes all of a particular resource, leave the ControlScope empty or do not pass it when calling CreateFramework.

See: newControlScope smart constructor.

Constructors

ControlScope'

Fields

complianceResourceIds :: Maybe (NonEmpty Text)
The ID of the only Amazon Web Services resource that you want your control scope to contain.
complianceResourceTypes :: Maybe [Text]
Describes whether the control scope includes one or more types of resources, such as EFS or RDS.
tags :: Maybe (HashMap Text Text)
The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].

Instances

Instances details

FromJSON ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods parseJSON :: Value -> Parser ControlScope # parseJSONList :: Value -> Parser [ControlScope] #
ToJSON ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods toJSON :: ControlScope -> Value # toEncoding :: ControlScope -> Encoding # toJSONList :: [ControlScope] -> Value # toEncodingList :: [ControlScope] -> Encoding #
Generic ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Associated Types type Rep ControlScope :: Type -> Type # Methods from :: ControlScope -> Rep ControlScope x # to :: Rep ControlScope x -> ControlScope #
Read ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods readsPrec :: Int -> ReadS ControlScope # readList :: ReadS [ControlScope] # readPrec :: ReadPrec ControlScope # readListPrec :: ReadPrec [ControlScope] #
Show ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods showsPrec :: Int -> ControlScope -> ShowS # show :: ControlScope -> String # showList :: [ControlScope] -> ShowS #
NFData ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods rnf :: ControlScope -> () #
Eq ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods (==) :: ControlScope -> ControlScope -> Bool # (/=) :: ControlScope -> ControlScope -> Bool #
Hashable ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope Methods hashWithSalt :: Int -> ControlScope -> Int # hash :: ControlScope -> Int #
type Rep ControlScope Source #
Instance details Defined in Amazonka.Backup.Types.ControlScope type Rep ControlScope = D1 ('MetaData "ControlScope" "Amazonka.Backup.Types.ControlScope" "amazonka-backup-2.0-LovIt41tphM6jvgQJhTyRf" 'False) (C1 ('MetaCons "ControlScope'" 'PrefixI 'True) (S1 ('MetaSel ('Just "complianceResourceIds") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (NonEmpty Text))) :: (S1 ('MetaSel ('Just "complianceResourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :: S1 ('MetaSel ('Just "tags") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe (HashMap Text Text))))))

newControlScope :: ControlScope Source #

Create a value of ControlScope 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:complianceResourceIds:ControlScope', controlScope_complianceResourceIds - The ID of the only Amazon Web Services resource that you want your control scope to contain.

$sel:complianceResourceTypes:ControlScope', controlScope_complianceResourceTypes - Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

$sel:tags:ControlScope', controlScope_tags - The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].

controlScope_complianceResourceIds :: Lens' ControlScope (Maybe (NonEmpty Text)) Source #

The ID of the only Amazon Web Services resource that you want your control scope to contain.

controlScope_complianceResourceTypes :: Lens' ControlScope (Maybe [Text]) Source #

Describes whether the control scope includes one or more types of resources, such as EFS or RDS.

controlScope_tags :: Lens' ControlScope (Maybe (HashMap Text Text)) Source #

The tag key-value pair applied to those Amazon Web Services resources that you want to trigger an evaluation for a rule. A maximum of one key-value pair can be provided. The tag value is optional, but it cannot be an empty string. The structure to assign a tag is: [{"Key":"string","Value":"string"}].