Options
All
  • Public
  • Public/Protected
  • All
Menu

AWS ConfigRule configuration

Hierarchy

  • ConfigRule

Implements

Index

Constructors

Properties

complianceResourceTypes: string[] = []

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

customRule: { configurationChanges: boolean; lambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string; timeout: number }; 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; timeout: number }
    • handler: string
    • rolePolicyFile: string
    • runtime: string
    • sourceFilePath: string
    • timeout: number
  • maximumExecutionFrequency: string
  • periodic: boolean
  • triggeringResources: { lookupKey: string; lookupType: string; lookupValue: never[] }
    • lookupKey: string
    • lookupType: string
    • lookupValue: never[]
description: "" = ''

A description about this AWS Config rule.

identifier: "" = ''

The identifier of the AWS managed rule.

inputParameters: {} = {}

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

Type declaration

    name: "" = ''

    A name for the AWS Config rule.

    remediation: { automatic: boolean; maximumAutomaticAttempts: number; parameters: never[]; retryAttemptSeconds: number; rolePolicyFile: string; targetAccountName: string; targetDocumentLambda: { handler: string; rolePolicyFile: string; runtime: string; sourceFilePath: string; timeout: number }; 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; timeout: number }
      • handler: string
      • rolePolicyFile: string
      • runtime: string
      • sourceFilePath: string
      • timeout: number
    • targetId: string
    • targetVersion: string
    tags: never[] = []

    Tags for the config rule

    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