Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Documentation

data OrganizationCustomPolicyRuleMetadata

An object that specifies metadata for your organization's Config Custom Policy rule. The metadata includes the runtime system in use, which accounts have debug logging enabled, and other custom rule metadata, such as resource type, resource ID of Amazon Web Services resource, and organization trigger types that initiate Config to evaluate Amazon Web Services resources against a rule.

See: newOrganizationCustomPolicyRuleMetadata smart constructor.

Constructors

OrganizationCustomPolicyRuleMetadata'

Fields

• debugLogDeliveryAccounts :: Maybe [Text]

  A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

• description :: Maybe Text

  The description that you provide for your organization Config Custom Policy rule.

• inputParameters :: Maybe Text

  A string, in JSON format, that is passed to your organization Config Custom Policy rule.

• maximumExecutionFrequency :: Maybe MaximumExecutionFrequency

  The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

• organizationConfigRuleTriggerTypes :: Maybe [OrganizationConfigRuleTriggerTypeNoSN]

  The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

  • ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.
  • OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.
• resourceIdScope :: Maybe Text

  The ID of the Amazon Web Services resource that was evaluated.

• resourceTypesScope :: Maybe [Text]

  The type of the Amazon Web Services resource that was evaluated.

• tagKeyScope :: Maybe Text

  One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

• tagValueScope :: Maybe Text

  The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

• policyRuntime :: Text

  The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

• policyText :: Text

  The policy definition containing the logic for your organization Config Custom Policy rule.

Instances

ToJSON OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

toJSON :: OrganizationCustomPolicyRuleMetadata -> Value

toEncoding :: OrganizationCustomPolicyRuleMetadata -> Encoding

toJSONList :: [OrganizationCustomPolicyRuleMetadata] -> Value

toEncodingList :: [OrganizationCustomPolicyRuleMetadata] -> Encoding

Generic OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Associated Types

type Rep OrganizationCustomPolicyRuleMetadata :: Type -> Type

Methods

from :: OrganizationCustomPolicyRuleMetadata -> Rep OrganizationCustomPolicyRuleMetadata x

to :: Rep OrganizationCustomPolicyRuleMetadata x -> OrganizationCustomPolicyRuleMetadata

Read OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

readsPrec :: Int -> ReadS OrganizationCustomPolicyRuleMetadata

readList :: ReadS [OrganizationCustomPolicyRuleMetadata]

readPrec :: ReadPrec OrganizationCustomPolicyRuleMetadata

readListPrec :: ReadPrec [OrganizationCustomPolicyRuleMetadata]

Show OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

showsPrec :: Int -> OrganizationCustomPolicyRuleMetadata -> ShowS

show :: OrganizationCustomPolicyRuleMetadata -> String

showList :: [OrganizationCustomPolicyRuleMetadata] -> ShowS

NFData OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

rnf :: OrganizationCustomPolicyRuleMetadata -> ()

Eq OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

(==) :: OrganizationCustomPolicyRuleMetadata -> OrganizationCustomPolicyRuleMetadata -> Bool

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

Hashable OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

Methods

hashWithSalt :: Int -> OrganizationCustomPolicyRuleMetadata -> Int

hash :: OrganizationCustomPolicyRuleMetadata -> Int

type Rep OrganizationCustomPolicyRuleMetadata

Defined in Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata

type Rep OrganizationCustomPolicyRuleMetadata = D1 ('MetaData "OrganizationCustomPolicyRuleMetadata" "Amazonka.Config.Types.OrganizationCustomPolicyRuleMetadata" "amazonka-config-2.0-7GF0fBbVw65uROwJwpcE3" 'False) (C1 ('MetaCons "OrganizationCustomPolicyRuleMetadata'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "debugLogDeliveryAccounts") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :*: (S1 ('MetaSel ('Just "inputParameters") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "maximumExecutionFrequency") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe MaximumExecutionFrequency)) :*: S1 ('MetaSel ('Just "organizationConfigRuleTriggerTypes") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [OrganizationConfigRuleTriggerTypeNoSN]))))) :*: ((S1 ('MetaSel ('Just "resourceIdScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "resourceTypesScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe [Text])) :*: S1 ('MetaSel ('Just "tagKeyScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)))) :*: (S1 ('MetaSel ('Just "tagValueScope") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :*: (S1 ('MetaSel ('Just "policyRuntime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "policyText") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text))))))

newOrganizationCustomPolicyRuleMetadata

Arguments

:: Text

$sel:policyRuntime:OrganizationCustomPolicyRuleMetadata'

-> Text

$sel:policyText:OrganizationCustomPolicyRuleMetadata'

-> OrganizationCustomPolicyRuleMetadata

Create a value of OrganizationCustomPolicyRuleMetadata 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:debugLogDeliveryAccounts:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_debugLogDeliveryAccounts - A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

$sel:description:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_description - The description that you provide for your organization Config Custom Policy rule.

$sel:inputParameters:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_inputParameters - A string, in JSON format, that is passed to your organization Config Custom Policy rule.

$sel:maximumExecutionFrequency:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_maximumExecutionFrequency - The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

$sel:organizationConfigRuleTriggerTypes:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_organizationConfigRuleTriggerTypes - The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

• ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.
• OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

$sel:resourceIdScope:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_resourceIdScope - The ID of the Amazon Web Services resource that was evaluated.

$sel:resourceTypesScope:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_resourceTypesScope - The type of the Amazon Web Services resource that was evaluated.

$sel:tagKeyScope:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_tagKeyScope - One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

$sel:tagValueScope:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_tagValueScope - The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

$sel:policyRuntime:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_policyRuntime - The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

$sel:policyText:OrganizationCustomPolicyRuleMetadata', organizationCustomPolicyRuleMetadata_policyText - The policy definition containing the logic for your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadata_debugLogDeliveryAccounts :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [Text])

A list of accounts that you can enable debug logging for your organization Config Custom Policy rule. List is null when debug logging is enabled for all accounts.

organizationCustomPolicyRuleMetadata_description :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text)

The description that you provide for your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadata_inputParameters :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text)

A string, in JSON format, that is passed to your organization Config Custom Policy rule.

organizationCustomPolicyRuleMetadata_maximumExecutionFrequency :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe MaximumExecutionFrequency)

The maximum frequency with which Config runs evaluations for a rule. Your Config Custom Policy rule is triggered when Config delivers the configuration snapshot. For more information, see ConfigSnapshotDeliveryProperties.

organizationCustomPolicyRuleMetadata_organizationConfigRuleTriggerTypes :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [OrganizationConfigRuleTriggerTypeNoSN])

The type of notification that initiates Config to run an evaluation for a rule. For Config Custom Policy rules, Config supports change-initiated notification types:

• ConfigurationItemChangeNotification - Initiates an evaluation when Config delivers a configuration item as a result of a resource change.
• OversizedConfigurationItemChangeNotification - Initiates an evaluation when Config delivers an oversized configuration item. Config may generate this notification type when a resource changes and the notification exceeds the maximum size allowed by Amazon SNS.

organizationCustomPolicyRuleMetadata_resourceIdScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text)

The ID of the Amazon Web Services resource that was evaluated.

organizationCustomPolicyRuleMetadata_resourceTypesScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe [Text])

The type of the Amazon Web Services resource that was evaluated.

organizationCustomPolicyRuleMetadata_tagKeyScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text)

One part of a key-value pair that make up a tag. A key is a general label that acts like a category for more specific tag values.

organizationCustomPolicyRuleMetadata_tagValueScope :: Lens' OrganizationCustomPolicyRuleMetadata (Maybe Text)

The optional part of a key-value pair that make up a tag. A value acts as a descriptor within a tag category (key).

organizationCustomPolicyRuleMetadata_policyRuntime :: Lens' OrganizationCustomPolicyRuleMetadata Text

The runtime system for your organization Config Custom Policy rules. Guard is a policy-as-code language that allows you to write policies that are enforced by Config Custom Policy rules. For more information about Guard, see the Guard GitHub Repository.

organizationCustomPolicyRuleMetadata_policyText :: Lens' OrganizationCustomPolicyRuleMetadata Text

The policy definition containing the logic for your organization Config Custom Policy rule.