Amazonka.Config.Types.Scope

Documentation

data Scope

Defines which resources trigger an evaluation for an Config rule. The 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. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

See: newScope smart constructor.

Constructors

Scope'

Fields

• complianceResourceId :: Maybe Text

  The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

• complianceResourceTypes :: Maybe [Text]

  The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

• tagKey :: Maybe Text

  The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

• tagValue :: Maybe Text

  The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

Instances

FromJSON Scope

Defined in Amazonka.Config.Types.Scope

Methods

parseJSON :: Value -> Parser Scope

parseJSONList :: Value -> Parser [Scope]

ToJSON Scope

Defined in Amazonka.Config.Types.Scope

Methods

toJSON :: Scope -> Value

toEncoding :: Scope -> Encoding

toJSONList :: [Scope] -> Value

toEncodingList :: [Scope] -> Encoding

Generic Scope

Defined in Amazonka.Config.Types.Scope

Associated Types

type Rep Scope :: Type -> Type

Methods

from :: Scope -> Rep Scope x

to :: Rep Scope x -> Scope

Read Scope

Defined in Amazonka.Config.Types.Scope

Methods

readsPrec :: Int -> ReadS Scope

readList :: ReadS [Scope]

readPrec :: ReadPrec Scope

readListPrec :: ReadPrec [Scope]

Show Scope

Defined in Amazonka.Config.Types.Scope

Methods

showsPrec :: Int -> Scope -> ShowS

show :: Scope -> String

showList :: [Scope] -> ShowS

NFData Scope

Defined in Amazonka.Config.Types.Scope

Methods

rnf :: Scope -> ()

Eq Scope

Defined in Amazonka.Config.Types.Scope

Methods

(==) :: Scope -> Scope -> Bool

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

Hashable Scope

Defined in Amazonka.Config.Types.Scope

Methods

hashWithSalt :: Int -> Scope -> Int

hash :: Scope -> Int

type Rep Scope

Defined in Amazonka.Config.Types.Scope

type Rep Scope = D1 ('MetaData "Scope" "Amazonka.Config.Types.Scope" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "Scope'" 'PrefixI 'True) ((S1 ('MetaSel ('Just "complianceResourceId") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "complianceResourceTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text]))) :*: (S1 ('MetaSel ('Just "tagKey") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: S1 ('MetaSel ('Just "tagValue") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))))

newScope :: Scope

Create a value of Scope 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:complianceResourceId:Scope', scope_complianceResourceId - The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

$sel:complianceResourceTypes:Scope', scope_complianceResourceTypes - The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

$sel:tagKey:Scope', scope_tagKey - The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

$sel:tagValue:Scope', scope_tagValue - The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.

scope_complianceResourceId :: Lens' Scope (Maybe Text)

The ID of the only Amazon Web Services resource that you want to trigger an evaluation for the rule. If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes.

scope_complianceResourceTypes :: Lens' Scope (Maybe [Text])

The resource types of only those Amazon Web Services resources that you want to trigger an evaluation for the rule. You can only specify one type if you also specify a resource ID for ComplianceResourceId.

scope_tagKey :: Lens' Scope (Maybe Text)

The tag key that is applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule.

scope_tagValue :: Lens' Scope (Maybe Text)

The tag value applied to only those Amazon Web Services resources that you want to trigger an evaluation for the rule. If you specify a value for TagValue, you must also specify a value for TagKey.