io.cloudshiftdev.awscdk.services.events.EventField.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
There is a newer version: 0.10.0
@file:Suppress("RedundantVisibilityModifier","RedundantUnitReturnType","RemoveRedundantQualifierName","unused","UnusedImport","ClassName","REDUNDANT_PROJECTION","DEPRECATION")

package io.cloudshiftdev.awscdk.services.events

import io.cloudshiftdev.awscdk.IResolvable
import io.cloudshiftdev.awscdk.IResolveContext
import io.cloudshiftdev.awscdk.common.CdkObject
import kotlin.Any
import kotlin.String
import kotlin.collections.List

/**
 * Represents a field in the event pattern.
 *
 * Example:
 *
 * ```
 * import io.cloudshiftdev.awscdk.services.logs.*;
 * LogGroup logGroup;
 * Rule rule;
 * rule.addTarget(CloudWatchLogGroup.Builder.create(logGroup)
 * .logEvent(LogGroupTargetInput.fromObject(LogGroupTargetInputOptions.builder()
 * .timestamp(EventField.fromPath("$.time"))
 * .message(EventField.fromPath("$.detail-type"))
 * .build()))
 * .build());
 * ```
 */
public open class EventField(
  cdkObject: software.amazon.awscdk.services.events.EventField,
) : CdkObject(cdkObject),
    IResolvable {
  /**
   * The creation stack of this resolvable which will be appended to errors thrown during
   * resolution.
   *
   * This may return an array with a single informational element indicating how
   * to get this property populated, if it was skipped for performance reasons.
   */
  public override fun creationStack(): List = unwrap(this).getCreationStack()

  /**
   * Human readable display hint about the event pattern.
   */
  public open fun displayHint(): String = unwrap(this).getDisplayHint()

  /**
   * the path to a field in the event pattern.
   */
  public open fun path(): String = unwrap(this).getPath()

  /**
   * Produce the Token's value at resolution time.
   *
   * @param _ctx 
   */
  public override fun resolve(ctx: IResolveContext): Any =
      unwrap(this).resolve(ctx.let(IResolveContext.Companion::unwrap))

  /**
   * Convert the path to the field in the event pattern to JSON.
   */
  public open fun toJSON(): String = unwrap(this).toJSON()

  public companion object {
    public fun account(): String = software.amazon.awscdk.services.events.EventField.getAccount()

    public fun detailType(): String =
        software.amazon.awscdk.services.events.EventField.getDetailType()

    public fun eventId(): String = software.amazon.awscdk.services.events.EventField.getEventId()

    public fun fromPath(path: String): String =
        software.amazon.awscdk.services.events.EventField.fromPath(path)

    public fun region(): String = software.amazon.awscdk.services.events.EventField.getRegion()

    public fun source(): String = software.amazon.awscdk.services.events.EventField.getSource()

    public fun time(): String = software.amazon.awscdk.services.events.EventField.getTime()

    internal fun wrap(cdkObject: software.amazon.awscdk.services.events.EventField): EventField =
        EventField(cdkObject)

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