Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConfigRule

AWS ConfigRule configuration

Hierarchy

  • ConfigRule

Implements

Index

Constructors

Properties

Constructors

constructor

Properties

Readonly complianceResourceTypes

complianceResourceTypes: string[] = []

Defines which resources trigger an evaluation for an AWS Config rule.

Readonly customRule

customRule: { configurationChanges: boolean; lambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string }; maximumExecutionFrequency: string; periodic: boolean; triggeringResources: { lookupKey: string; lookupType: string; lookupValue: never[] } } = ...

A custom config rule is backed by AWS Lambda function. This is required when creating custom config rule.

Type declaration

  • configurationChanges: boolean
  • lambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string }
    • handler: string
    • rolePolicyFile: string
    • runtime: string
    • sourceFilePath: string
  • maximumExecutionFrequency: string
  • periodic: boolean
  • triggeringResources: { lookupKey: string; lookupType: string; lookupValue: never[] }
    • lookupKey: string
    • lookupType: string
    • lookupValue: never[]

Readonly description

description: "" = ''

A description about this AWS Config rule.

Readonly identifier

identifier: "" = ''

The identifier of the AWS managed rule.

Readonly inputParameters

inputParameters: {} = {}

Input parameter values that are passed to the AWS Config rule.

Type declaration

    Readonly name

    name: "" = ''

    A name for the AWS Config rule.

    Readonly remediation

    remediation: { automatic: boolean; maximumAutomaticAttempts: number; parameters: never[]; retryAttemptSeconds: number; rolePolicyFile: string; targetAccountName: string; targetDocumentLambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string }; targetId: string; targetVersion: string } = ...

    A remediation for the config rule, auto remediation to automatically remediate noncompliant resources.

    Type declaration

    • automatic: boolean
    • maximumAutomaticAttempts: number
    • parameters: never[]
    • retryAttemptSeconds: number
    • rolePolicyFile: string
    • targetAccountName: string
    • targetDocumentLambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string }
      • handler: string
      • rolePolicyFile: string
      • runtime: string
      • sourceFilePath: string
    • targetId: string
    • targetVersion: string

    Readonly type

    type: "" = ''

    Config rule type Managed or Custom. For custom config rule, this parameter value is Custom, when creating managed config rule this parameter value can be undefined or empty string

    Generated using TypeDoc