Class CloudFormationStackDriftDetectionCheckProps
Construction properties for a CloudFormationStackDriftDetectionCheck.
Inheritance
Namespace: Amazon.CDK.AWS.Config
Assembly: Amazon.CDK.AWS.Config.dll
Syntax (csharp)
public class CloudFormationStackDriftDetectionCheckProps : Object, ICloudFormationStackDriftDetectionCheckProps, IRuleProps
Syntax (vb)
Public Class CloudFormationStackDriftDetectionCheckProps
Inherits Object
Implements ICloudFormationStackDriftDetectionCheckProps, IRuleProps
Remarks
ExampleMetadata: infused
Examples
// compliant if stack's status is 'IN_SYNC'
// non-compliant if the stack's drift status is 'DRIFTED'
// compliant if stack's status is 'IN_SYNC'
// non-compliant if the stack's drift status is 'DRIFTED'
new CloudFormationStackDriftDetectionCheck(this, "Drift", new CloudFormationStackDriftDetectionCheckProps {
OwnStackOnly = true
});
Synopsis
Constructors
CloudFormationStackDriftDetectionCheckProps() |
Properties
ConfigRuleName | A name for the AWS Config rule. |
Description | A description about this AWS Config rule. |
InputParameters | Input parameter values that are passed to the AWS Config rule. |
MaximumExecutionFrequency | The maximum frequency at which the AWS Config rule runs evaluations. |
OwnStackOnly | Whether to check only the stack where this rule is deployed. |
Role | The IAM role to use for this rule. |
RuleScope | Defines which resources trigger an evaluation for an AWS Config rule. |
Constructors
CloudFormationStackDriftDetectionCheckProps()
public CloudFormationStackDriftDetectionCheckProps()
Properties
ConfigRuleName
A name for the AWS Config rule.
public string ConfigRuleName { get; set; }
Property Value
System.String
Remarks
Default: - CloudFormation generated name
Description
A description about this AWS Config rule.
public string Description { get; set; }
Property Value
System.String
Remarks
Default: - No description
InputParameters
Input parameter values that are passed to the AWS Config rule.
public IDictionary<string, object> InputParameters { get; set; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Remarks
Default: - No input parameters
MaximumExecutionFrequency
The maximum frequency at which the AWS Config rule runs evaluations.
public Nullable<MaximumExecutionFrequency> MaximumExecutionFrequency { get; set; }
Property Value
System.Nullable<MaximumExecutionFrequency>
Remarks
Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
OwnStackOnly
Whether to check only the stack where this rule is deployed.
public Nullable<bool> OwnStackOnly { get; set; }
Property Value
System.Nullable<System.Boolean>
Remarks
Default: false
Role
The IAM role to use for this rule.
public IRole Role { get; set; }
Property Value
Remarks
It must have permissions to detect drift
for AWS CloudFormation stacks. Ensure to attach config.amazonaws.com
trusted
permissions and ReadOnlyAccess
policy permissions. For specific policy permissions,
refer to https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/using-cfn-stack-drift.html.
Default: - A role will be created
RuleScope
Defines which resources trigger an evaluation for an AWS Config rule.
public RuleScope RuleScope { get; set; }
Property Value
Remarks
Default: - evaluations for the rule are triggered when any resource in the recording group changes.