com.pulumi.awsnative.quicksight.kotlin.Analysis.kt Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of pulumi-aws-native-kotlin Show documentation
Build cloud applications and infrastructure by combining the safety and reliability of infrastructure as code with the power of the Kotlin programming language.
There is a newer version: 1.24.0.0
Show newest version
@file:Suppress("NAME_SHADOWING", "DEPRECATION")

package com.pulumi.awsnative.quicksight.kotlin

import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.awsnative.quicksight.kotlin.enums.AnalysisResourceStatus
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisDefinition
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisError
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisParameters
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisResourcePermission
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisSheet
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisSourceEntity
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisValidationStrategy
import com.pulumi.core.Output
import com.pulumi.kotlin.KotlinCustomResource
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.ResourceMapper
import com.pulumi.kotlin.options.CustomResourceOptions
import com.pulumi.kotlin.options.CustomResourceOptionsBuilder
import com.pulumi.resources.Resource
import kotlin.Boolean
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import com.pulumi.awsnative.kotlin.outputs.Tag.Companion.toKotlin as tagToKotlin
import com.pulumi.awsnative.quicksight.kotlin.enums.AnalysisResourceStatus.Companion.toKotlin as analysisResourceStatusToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisDefinition.Companion.toKotlin as analysisDefinitionToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisError.Companion.toKotlin as analysisErrorToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisParameters.Companion.toKotlin as analysisParametersToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisResourcePermission.Companion.toKotlin as analysisResourcePermissionToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisSheet.Companion.toKotlin as analysisSheetToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisSourceEntity.Companion.toKotlin as analysisSourceEntityToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.AnalysisValidationStrategy.Companion.toKotlin as analysisValidationStrategyToKotlin

/**
 * Builder for [Analysis].
 */
@PulumiTagMarker
public class AnalysisResourceBuilder internal constructor() {
    public var name: String? = null

    public var args: AnalysisArgs = AnalysisArgs()

    public var opts: CustomResourceOptions = CustomResourceOptions()

    /**
     * @param name The _unique_ name of the resulting resource.
     */
    public fun name(`value`: String) {
        this.name = value
    }

    /**
     * @param block The arguments to use to populate this resource's properties.
     */
    public suspend fun args(block: suspend AnalysisArgsBuilder.() -> Unit) {
        val builder = AnalysisArgsBuilder()
        block(builder)
        this.args = builder.build()
    }

    /**
     * @param block A bag of options that control this resource's behavior.
     */
    public suspend fun opts(block: suspend CustomResourceOptionsBuilder.() -> Unit) {
        this.opts = com.pulumi.kotlin.options.CustomResourceOptions.opts(block)
    }

    internal fun build(): Analysis {
        val builtJavaResource = com.pulumi.awsnative.quicksight.Analysis(
            this.name,
            this.args.toJava(),
            this.opts.toJava(),
        )
        return Analysis(builtJavaResource)
    }
}

/**
 * Definition of the AWS::QuickSight::Analysis Resource Type.
 */
public class Analysis internal constructor(
    override val javaResource: com.pulumi.awsnative.quicksight.Analysis,
) : KotlinCustomResource(javaResource, AnalysisMapper) {
    /**
     * The ID for the analysis that you're creating. This ID displays in the URL of the analysis.
     */
    public val analysisId: Output
        get() = javaResource.analysisId().applyValue({ args0 -> args0 })

    /**
     * The Amazon Resource Name (ARN) of the analysis.
     */
    public val arn: Output
        get() = javaResource.arn().applyValue({ args0 -> args0 })

    /**
     * The ID of the AWS account where you are creating an analysis.
     */
    public val awsAccountId: Output
        get() = javaResource.awsAccountId().applyValue({ args0 -> args0 })

    /**
     * The time that the analysis was created.
     */
    public val createdTime: Output
        get() = javaResource.createdTime().applyValue({ args0 -> args0 })

    /**
     * The ARNs of the datasets of the analysis.
     */
    public val dataSetArns: Output>
        get() = javaResource.dataSetArns().applyValue({ args0 -> args0.map({ args0 -> args0 }) })

    public val definition: Output?
        get() = javaResource.definition().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    analysisDefinitionToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Errors associated with the analysis.
     */
    public val errors: Output>?
        get() = javaResource.errors().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> analysisErrorToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * The time that the analysis was last updated.
     */
    public val lastUpdatedTime: Output
        get() = javaResource.lastUpdatedTime().applyValue({ args0 -> args0 })

    /**
     * The descriptive name of the analysis.
     */
    public val name: Output
        get() = javaResource.name().applyValue({ args0 -> args0 })

    /**
     * The parameter names and override values that you want to use. An analysis can have any parameter type, and some parameters might accept multiple values.
     */
    public val parameters: Output?
        get() = javaResource.parameters().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    analysisParametersToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * A structure that describes the principals and the resource-level permissions on an analysis. You can use the `Permissions` structure to grant permissions by providing a list of AWS Identity and Access Management (IAM) action information for each principal listed by Amazon Resource Name (ARN).
     * To specify no permissions, omit `Permissions` .
     */
    public val permissions: Output>?
        get() = javaResource.permissions().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> analysisResourcePermissionToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * A list of the associated sheets with the unique identifier and name of each sheet.
     */
    public val sheets: Output>?
        get() = javaResource.sheets().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> analysisSheetToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * A source entity to use for the analysis that you're creating. This metadata structure contains details that describe a source template and one or more datasets.
     * Either a `SourceEntity` or a `Definition` must be provided in order for the request to be valid.
     */
    public val sourceEntity: Output?
        get() = javaResource.sourceEntity().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    analysisSourceEntityToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Status associated with the analysis.
     */
    public val status: Output?
        get() = javaResource.status().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 ->
                    analysisResourceStatusToKotlin(args0)
                })
            }).orElse(null)
        })

    /**
     * Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
     */
    public val tags: Output>?
        get() = javaResource.tags().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.map({ args0 ->
                    args0.let({ args0 -> tagToKotlin(args0) })
                })
            }).orElse(null)
        })

    /**
     * The ARN of the theme of the analysis.
     */
    public val themeArn: Output?
        get() = javaResource.themeArn().applyValue({ args0 -> args0.map({ args0 -> args0 }).orElse(null) })

    /**
     * The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects. When you set this value to `LENIENT` , validation is skipped for specific errors.
     */
    public val validationStrategy: Output?
        get() = javaResource.validationStrategy().applyValue({ args0 ->
            args0.map({ args0 ->
                args0.let({ args0 -> analysisValidationStrategyToKotlin(args0) })
            }).orElse(null)
        })
}

public object AnalysisMapper : ResourceMapper {
    override fun supportsMappingOfType(javaResource: Resource): Boolean =
        com.pulumi.awsnative.quicksight.Analysis::class == javaResource::class

    override fun map(javaResource: Resource): Analysis = Analysis(
        javaResource as
            com.pulumi.awsnative.quicksight.Analysis,
    )
}

/**
 * @see [Analysis].
 * @param name The _unique_ name of the resulting resource.
 * @param block Builder for [Analysis].
 */
public suspend fun analysis(name: String, block: suspend AnalysisResourceBuilder.() -> Unit): Analysis {
    val builder = AnalysisResourceBuilder()
    builder.name(name)
    block(builder)
    return builder.build()
}

/**
 * @see [Analysis].
 * @param name The _unique_ name of the resulting resource.
 */
public fun analysis(name: String): Analysis {
    val builder = AnalysisResourceBuilder()
    builder.name(name)
    return builder.build()
}