aws-cdk-lib.aws_config.RuleScope

RuleScope Class

Determines which resources trigger an evaluation of an AWS Config rule.

Source

aws-config/lib/rule.ts

Example

// Lambda function containing logic that evaluates compliance with the rule.
const evalComplianceFn = new lambda.Function(this, "CustomFunction", {
  code: lambda.AssetCode.fromInline(
    "exports.handler = (event) => console.log(event);"
  ),
  handler: "index.handler",
  runtime: lambda.Runtime.NODEJS_LATEST,
});

// A custom rule that runs on configuration changes of EC2 instances
const customRule = new config.CustomRule(this, "Custom", {
  configurationChanges: true,
  lambdaFunction: evalComplianceFn,
  ruleScope: config.RuleScope.fromResource(config.ResourceType.EC2_INSTANCE),
});

Properties

key?may be undefinedstringkey?may be undefinedstrkey?may be undefinedStringKey?may be undefinedstringKey?may be undefined*string#

tag key applied to resources that will trigger evaluation of a rule.

resourceId?may be undefinedstringresource_id?may be undefinedstrresourceId?may be undefinedStringResourceId?may be undefinedstringResourceId?may be undefined*string#

ID of the only AWS resource that will trigger evaluation of a rule.

resourceTypes?may be undefinedResourceType[]resource_types?may be undefinedtyping.List[ResourceType]resourceTypes?may be undefinedList<ResourceType>ResourceTypes?may be undefinedResourceType[]ResourceTypes?may be undefined*[]ResourceType#

Resource types that will trigger evaluation of a rule.

value?may be undefinedstringvalue?may be undefinedstrvalue?may be undefinedStringValue?may be undefinedstringValue?may be undefined*string#

tag value applied to resources that will trigger evaluation of a rule.

Methods

fromResource(resourceType: ResourceType, resourceId?: string): RuleScope // chainable@staticmethod def from_resource(resource_type: ResourceType, resource_id: typing.Optional[str] = None) -> RuleScopepublic static RuleScope fromResource(ResourceType resourceType, String resourceId)public static RuleScope FromResource(ResourceType resourceType, string? resourceId = null)func FromResource(ResourceType ResourceType, ResourceId *string) RuleScopestatic#

restricts scope of changes to a specific resource type or resource identifier.

fromResources(resourceTypes: ResourceType[]): RuleScope // chainable@staticmethod def from_resources(resource_types: typing.List[ResourceType]) -> RuleScopepublic static RuleScope fromResources(List<ResourceType> resourceTypes)public static RuleScope FromResources(ResourceType[] resourceTypes)func FromResources(ResourceTypes *[]ResourceType) RuleScopestatic#

restricts scope of changes to specific resource types.

fromTag(key: string, value?: string): RuleScope // chainable@staticmethod def from_tag(key: str, value: typing.Optional[str] = None) -> RuleScopepublic static RuleScope fromTag(String key, String value)public static RuleScope FromTag(string key, string? value = null)func FromTag(Key *string, Value *string) RuleScopestatic#

restricts scope of changes to a specific tag.