io.cloudshiftdev.awscdk.services.config.RuleScope.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of kotlin-cdk-wrapper Show documentation
Kotlin DSL for AWS CDK
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.CdkObject
import kotlin.String
import kotlin.collections.List

/**
 * Determines which resources trigger an evaluation of an AWS Config rule.
 *
 * Example:
 *
 * ```
 * // Lambda function containing logic that evaluates compliance with the rule.
 * Function evalComplianceFn = Function.Builder.create(this, "CustomFunction")
 * .code(AssetCode.fromInline("exports.handler = (event) => console.log(event);"))
 * .handler("index.handler")
 * .runtime(Runtime.NODEJS_18_X)
 * .build();
 * // A custom rule that runs on configuration changes of EC2 instances
 * CustomRule customRule = CustomRule.Builder.create(this, "Custom")
 * .configurationChanges(true)
 * .lambdaFunction(evalComplianceFn)
 * .ruleScope(RuleScope.fromResource(ResourceType.EC2_INSTANCE))
 * .build();
 * ```
 */
public open class RuleScope(
  cdkObject: software.amazon.awscdk.services.config.RuleScope,
) : CdkObject(cdkObject) {
  /**
   * tag key applied to resources that will trigger evaluation of a rule.
   */
  public open fun key(): String? = unwrap(this).getKey()

  /**
   * ID of the only AWS resource that will trigger evaluation of a rule.
   */
  public open fun resourceId(): String? = unwrap(this).getResourceId()

  /**
   * Resource types that will trigger evaluation of a rule.
   */
  public open fun resourceTypes(): List =
      unwrap(this).getResourceTypes()?.map(ResourceType::wrap) ?: emptyList()

  /**
   * tag value applied to resources that will trigger evaluation of a rule.
   */
  public open fun `value`(): String? = unwrap(this).getValue()

  public companion object {
    public fun fromResource(resourceType: ResourceType): RuleScope =
        software.amazon.awscdk.services.config.RuleScope.fromResource(resourceType.let(ResourceType.Companion::unwrap)).let(RuleScope::wrap)

    public fun fromResource(resourceType: ResourceType, resourceId: String): RuleScope =
        software.amazon.awscdk.services.config.RuleScope.fromResource(resourceType.let(ResourceType.Companion::unwrap),
        resourceId).let(RuleScope::wrap)

    public fun fromResources(resourceTypes: List): RuleScope =
        software.amazon.awscdk.services.config.RuleScope.fromResources(resourceTypes.map(ResourceType.Companion::unwrap)).let(RuleScope::wrap)

    public fun fromResources(vararg resourceTypes: ResourceType): RuleScope =
        fromResources(resourceTypes.toList())

    public fun fromTag(key: String): RuleScope =
        software.amazon.awscdk.services.config.RuleScope.fromTag(key).let(RuleScope::wrap)

    public fun fromTag(key: String, `value`: String): RuleScope =
        software.amazon.awscdk.services.config.RuleScope.fromTag(key, `value`).let(RuleScope::wrap)

    internal fun wrap(cdkObject: software.amazon.awscdk.services.config.RuleScope): RuleScope =
        RuleScope(cdkObject)

    internal fun unwrap(wrapped: RuleScope): software.amazon.awscdk.services.config.RuleScope =
        wrapped.cdkObject as software.amazon.awscdk.services.config.RuleScope
  }
}