Class CfnConfigRule.ScopeProperty

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

Inheritance

object

CfnConfigRule.ScopeProperty

Implements

CfnConfigRule.IScopeProperty

Inherited Members

object.GetType()

object.MemberwiseClone()

object.ToString()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Namespace: Amazon.CDK.AWS.Config

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnConfigRule.ScopeProperty : CfnConfigRule.IScopeProperty

Syntax (vb)

Public Class CfnConfigRule.ScopeProperty Implements CfnConfigRule.IScopeProperty

Remarks

The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Config;

             var scopeProperty = new ScopeProperty {
                 ComplianceResourceId = "complianceResourceId",
                 ComplianceResourceTypes = new [] { "complianceResourceTypes" },
                 TagKey = "tagKey",
                 TagValue = "tagValue"
             };

Synopsis

Constructors

ScopeProperty()

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

Properties

ComplianceResourceId	The ID of the only AWS resource that you want to trigger an evaluation for the rule.
ComplianceResourceTypes	The resource types of only those AWS resources that you want to trigger an evaluation for the rule.
TagKey	The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.
TagValue	The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

Constructors

ScopeProperty()

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

public ScopeProperty()

Remarks

The scope can include one or more resource types, a combination of a tag key and value, or a combination of one resource type and one resource ID. Specify a scope to constrain which resources trigger an evaluation for a rule. Otherwise, evaluations for the rule are triggered when any resource in your recording group changes in configuration.

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html

ExampleMetadata: fixture=_generated

Examples

// The code below shows an example of how to instantiate this type.
             // The values are placeholders you should change.
             using Amazon.CDK.AWS.Config;

             var scopeProperty = new ScopeProperty {
                 ComplianceResourceId = "complianceResourceId",
                 ComplianceResourceTypes = new [] { "complianceResourceTypes" },
                 TagKey = "tagKey",
                 TagValue = "tagValue"
             };

Properties

ComplianceResourceId

The ID of the only AWS resource that you want to trigger an evaluation for the rule.

public string? ComplianceResourceId { get; set; }

Property Value

string

Remarks

If you specify a resource ID, you must specify one resource type for ComplianceResourceTypes .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourceid

ComplianceResourceTypes

The resource types of only those AWS resources that you want to trigger an evaluation for the rule.

public string[]? ComplianceResourceTypes { get; set; }

Property Value

string[]

Remarks

You can only specify one type if you also specify a resource ID for ComplianceResourceId .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-complianceresourcetypes

TagKey

The tag key that is applied to only those AWS resources that you want to trigger an evaluation for the rule.

public string? TagKey { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagkey

TagValue

The tag value applied to only those AWS resources that you want to trigger an evaluation for the rule.

public string? TagValue { get; set; }

Property Value

string

Remarks

If you specify a value for TagValue , you must also specify a value for TagKey .

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-config-configrule-scope.html#cfn-config-configrule-scope-tagvalue

Implements

CfnConfigRule.IScopeProperty