libZSservicesZSamazonka-configZSamazonka-config
Copyright(c) 2013-2021 Brendan Hay
LicenseMozilla Public License, v. 2.0.
MaintainerBrendan Hay <brendan.g.hay+amazonka@gmail.com>
Stabilityauto-generated
Portabilitynon-portable (GHC extensions)
Safe HaskellNone

Amazonka.Config.Types.Scope

Description

 
Synopsis

Documentation

data Scope Source #

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

  • 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.

  • 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.

  • 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.

  • 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.

Instances

Instances details
Eq Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

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

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

Read Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

readsPrec :: Int -> ReadS Scope #

readList :: ReadS [Scope] #

readPrec :: ReadPrec Scope #

readListPrec :: ReadPrec [Scope] #

Show Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

showsPrec :: Int -> Scope -> ShowS #

show :: Scope -> String #

showList :: [Scope] -> ShowS #

Generic Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Associated Types

type Rep Scope :: Type -> Type #

Methods

from :: Scope -> Rep Scope x #

to :: Rep Scope x -> Scope #

NFData Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

rnf :: Scope -> () #

Hashable Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

hashWithSalt :: Int -> Scope -> Int #

hash :: Scope -> Int #

ToJSON Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

toJSON :: Scope -> Value #

toEncoding :: Scope -> Encoding #

toJSONList :: [Scope] -> Value #

toEncodingList :: [Scope] -> Encoding #

FromJSON Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

Methods

parseJSON :: Value -> Parser Scope #

parseJSONList :: Value -> Parser [Scope] #

type Rep Scope Source # 
Instance details

Defined in Amazonka.Config.Types.Scope

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

newScope :: Scope Source #

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: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: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: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.

$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.

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

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_complianceResourceId :: Lens' Scope (Maybe Text) Source #

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_tagValue :: Lens' Scope (Maybe Text) Source #

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_tagKey :: Lens' Scope (Maybe Text) Source #

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