software.amazon.awscdk.services.config

Class RuleScope

java.lang.Object

software.amazon.jsii.JsiiObject

software.amazon.awscdk.services.config.RuleScope

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:50.798Z")
public class RuleScope
extends software.amazon.jsii.JsiiObject

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

Example:

 Function evalComplianceFn;
 ManagedRule sshRule = ManagedRule.Builder.create(this, "SSH")
         .identifier(ManagedRuleIdentifiers.EC2_SECURITY_GROUPS_INCOMING_SSH_DISABLED)
         .ruleScope(RuleScope.fromResource(ResourceType.EC2_SECURITY_GROUP, "sg-1234567890abcdefgh"))
         .build();
 CustomRule customRule = CustomRule.Builder.create(this, "Lambda")
         .lambdaFunction(evalComplianceFn)
         .configurationChanges(true)
         .ruleScope(RuleScope.fromResources(List.of(ResourceType.CLOUDFORMATION_STACK, ResourceType.S3_BUCKET)))
         .build();
 CustomRule tagRule = CustomRule.Builder.create(this, "CostCenterTagRule")
         .lambdaFunction(evalComplianceFn)
         .configurationChanges(true)
         .ruleScope(RuleScope.fromTag("Cost Center", "MyApp"))
         .build();
 

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	RuleScope(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	RuleScope(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
static RuleScope	fromResource(ResourceType resourceType) restricts scope of changes to a specific resource type or resource identifier.
static RuleScope	fromResource(ResourceType resourceType, java.lang.String resourceId) restricts scope of changes to a specific resource type or resource identifier.
static RuleScope	fromResources(java.util.List<? extends ResourceType> resourceTypes) restricts scope of changes to specific resource types.
static RuleScope	fromTag(java.lang.String key) restricts scope of changes to a specific tag.
static RuleScope	fromTag(java.lang.String key, java.lang.String value) restricts scope of changes to a specific tag.
java.lang.String	getKey() tag key applied to resources that will trigger evaluation of a rule.
java.lang.String	getResourceId() ID of the only AWS resource that will trigger evaluation of a rule.
java.util.List<ResourceType>	getResourceTypes() Resource types that will trigger evaluation of a rule.
java.lang.String	getValue() tag value applied to resources that will trigger evaluation of a rule.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

RuleScope

protected RuleScope(software.amazon.jsii.JsiiObjectRef objRef)

RuleScope

protected RuleScope(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

Method Detail

fromResource

public static RuleScope fromResource(ResourceType resourceType,
                                     java.lang.String resourceId)

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

Parameters:

resourceType - This parameter is required.

resourceId -

fromResource

public static RuleScope fromResource(ResourceType resourceType)

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

Parameters:

resourceType - This parameter is required.

fromResources

public static RuleScope fromResources(java.util.List<? extends ResourceType> resourceTypes)

restricts scope of changes to specific resource types.

Parameters:

resourceTypes - This parameter is required.

fromTag

public static RuleScope fromTag(java.lang.String key,
                                java.lang.String value)

restricts scope of changes to a specific tag.

Parameters:

key - This parameter is required.

value -

fromTag

public static RuleScope fromTag(java.lang.String key)

restricts scope of changes to a specific tag.

Parameters:

key - This parameter is required.

getKey

public java.lang.String getKey()

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

getResourceId

public java.lang.String getResourceId()

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

getResourceTypes

public java.util.List<ResourceType> getResourceTypes()

Resource types that will trigger evaluation of a rule.

getValue

public java.lang.String getValue()

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