io.cloudshiftdev.awscdk.services.config.CloudFormationStackDriftDetectionCheck.kt Maven / Gradle / Ivy
The newest version!
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")
package io.cloudshiftdev.awscdk.services.config
import io.cloudshiftdev.awscdk.common.CdkDslMarker
import io.cloudshiftdev.awscdk.common.CdkObjectWrappers
import io.cloudshiftdev.awscdk.services.iam.IRole
import kotlin.Any
import kotlin.Boolean
import kotlin.String
import kotlin.Unit
import kotlin.collections.Map
import io.cloudshiftdev.constructs.Construct as CloudshiftdevConstructsConstruct
import software.constructs.Construct as SoftwareConstructsConstruct
/**
* Checks whether your CloudFormation stacks' actual configuration differs, or has drifted, from its
* expected configuration.
*
* Example:
*
* ```
* // Topic to which compliance notification events will be published
* Topic complianceTopic = new Topic(this, "ComplianceTopic");
* CloudFormationStackDriftDetectionCheck rule = new CloudFormationStackDriftDetectionCheck(this,
* "Drift");
* rule.onComplianceChange("TopicEvent", OnEventOptions.builder()
* .target(new SnsTopic(complianceTopic))
* .build());
* ```
*
* [Documentation](https://docs.aws.amazon.com/config/latest/developerguide/cloudformation-stack-drift-detection-check.html)
*/
public open class CloudFormationStackDriftDetectionCheck(
cdkObject: software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck,
) : ManagedRule(cdkObject) {
public constructor(scope: CloudshiftdevConstructsConstruct, id: String) :
this(software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id)
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CloudFormationStackDriftDetectionCheckProps,
) :
this(software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck(scope.let(CloudshiftdevConstructsConstruct.Companion::unwrap),
id, props.let(CloudFormationStackDriftDetectionCheckProps.Companion::unwrap))
)
public constructor(
scope: CloudshiftdevConstructsConstruct,
id: String,
props: CloudFormationStackDriftDetectionCheckProps.Builder.() -> Unit,
) : this(scope, id, CloudFormationStackDriftDetectionCheckProps(props)
)
/**
* A fluent builder for
* [io.cloudshiftdev.awscdk.services.config.CloudFormationStackDriftDetectionCheck].
*/
@CdkDslMarker
public interface Builder {
/**
* A name for the AWS Config rule.
*
* Default: - CloudFormation generated name
*
* @param configRuleName A name for the AWS Config rule.
*/
public fun configRuleName(configRuleName: String)
/**
* A description about this AWS Config rule.
*
* Default: - No description
*
* @param description A description about this AWS Config rule.
*/
public fun description(description: String)
/**
* The modes the AWS Config rule can be evaluated in.
*
* The valid values are distinct objects.
*
* Default: - Detective evaluation mode only
*
* @param evaluationModes The modes the AWS Config rule can be evaluated in.
*/
public fun evaluationModes(evaluationModes: EvaluationMode)
/**
* Input parameter values that are passed to the AWS Config rule.
*
* Default: - No input parameters
*
* @param inputParameters Input parameter values that are passed to the AWS Config rule.
*/
public fun inputParameters(inputParameters: Map)
/**
* The maximum frequency at which the AWS Config rule runs evaluations.
*
* Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
*
* @param maximumExecutionFrequency The maximum frequency at which the AWS Config rule runs
* evaluations.
*/
public fun maximumExecutionFrequency(maximumExecutionFrequency: MaximumExecutionFrequency)
/**
* Whether to check only the stack where this rule is deployed.
*
* Default: false
*
* @param ownStackOnly Whether to check only the stack where this rule is deployed.
*/
public fun ownStackOnly(ownStackOnly: Boolean)
/**
* The IAM role to use for this rule.
*
* 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
*
* @param role The IAM role to use for this rule.
*/
public fun role(role: IRole)
/**
* Defines which resources trigger an evaluation for an AWS Config rule.
*
* Default: - evaluations for the rule are triggered when any resource in the recording group
* changes.
*
* @param ruleScope Defines which resources trigger an evaluation for an AWS Config rule.
*/
public fun ruleScope(ruleScope: RuleScope)
}
private class BuilderImpl(
scope: SoftwareConstructsConstruct,
id: String,
) : Builder {
private val cdkBuilder:
software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck.Builder =
software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck.Builder.create(scope,
id)
/**
* A name for the AWS Config rule.
*
* Default: - CloudFormation generated name
*
* @param configRuleName A name for the AWS Config rule.
*/
override fun configRuleName(configRuleName: String) {
cdkBuilder.configRuleName(configRuleName)
}
/**
* A description about this AWS Config rule.
*
* Default: - No description
*
* @param description A description about this AWS Config rule.
*/
override fun description(description: String) {
cdkBuilder.description(description)
}
/**
* The modes the AWS Config rule can be evaluated in.
*
* The valid values are distinct objects.
*
* Default: - Detective evaluation mode only
*
* @param evaluationModes The modes the AWS Config rule can be evaluated in.
*/
override fun evaluationModes(evaluationModes: EvaluationMode) {
cdkBuilder.evaluationModes(evaluationModes.let(EvaluationMode.Companion::unwrap))
}
/**
* Input parameter values that are passed to the AWS Config rule.
*
* Default: - No input parameters
*
* @param inputParameters Input parameter values that are passed to the AWS Config rule.
*/
override fun inputParameters(inputParameters: Map) {
cdkBuilder.inputParameters(inputParameters.mapValues{CdkObjectWrappers.unwrap(it.value)})
}
/**
* The maximum frequency at which the AWS Config rule runs evaluations.
*
* Default: MaximumExecutionFrequency.TWENTY_FOUR_HOURS
*
* @param maximumExecutionFrequency The maximum frequency at which the AWS Config rule runs
* evaluations.
*/
override fun maximumExecutionFrequency(maximumExecutionFrequency: MaximumExecutionFrequency) {
cdkBuilder.maximumExecutionFrequency(maximumExecutionFrequency.let(MaximumExecutionFrequency.Companion::unwrap))
}
/**
* Whether to check only the stack where this rule is deployed.
*
* Default: false
*
* @param ownStackOnly Whether to check only the stack where this rule is deployed.
*/
override fun ownStackOnly(ownStackOnly: Boolean) {
cdkBuilder.ownStackOnly(ownStackOnly)
}
/**
* The IAM role to use for this rule.
*
* 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
*
* @param role The IAM role to use for this rule.
*/
override fun role(role: IRole) {
cdkBuilder.role(role.let(IRole.Companion::unwrap))
}
/**
* Defines which resources trigger an evaluation for an AWS Config rule.
*
* Default: - evaluations for the rule are triggered when any resource in the recording group
* changes.
*
* @param ruleScope Defines which resources trigger an evaluation for an AWS Config rule.
*/
override fun ruleScope(ruleScope: RuleScope) {
cdkBuilder.ruleScope(ruleScope.let(RuleScope.Companion::unwrap))
}
public fun build():
software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck =
cdkBuilder.build()
}
public companion object {
public operator fun invoke(
scope: CloudshiftdevConstructsConstruct,
id: String,
block: Builder.() -> Unit = {},
): CloudFormationStackDriftDetectionCheck {
val builderImpl = BuilderImpl(CloudshiftdevConstructsConstruct.unwrap(scope), id)
return CloudFormationStackDriftDetectionCheck(builderImpl.apply(block).build())
}
internal
fun wrap(cdkObject: software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck):
CloudFormationStackDriftDetectionCheck = CloudFormationStackDriftDetectionCheck(cdkObject)
internal fun unwrap(wrapped: CloudFormationStackDriftDetectionCheck):
software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck =
wrapped.cdkObject as
software.amazon.awscdk.services.config.CloudFormationStackDriftDetectionCheck
}
}