com.pulumi.awsnative.resourceexplorer2.kotlin.ViewArgs.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.resourceexplorer2.kotlin

import com.pulumi.awsnative.resourceexplorer2.ViewArgs.builder
import com.pulumi.awsnative.resourceexplorer2.kotlin.inputs.ViewIncludedPropertyArgs
import com.pulumi.awsnative.resourceexplorer2.kotlin.inputs.ViewIncludedPropertyArgsBuilder
import com.pulumi.awsnative.resourceexplorer2.kotlin.inputs.ViewSearchFilterArgs
import com.pulumi.awsnative.resourceexplorer2.kotlin.inputs.ViewSearchFilterArgsBuilder
import com.pulumi.core.Output
import com.pulumi.core.Output.of
import com.pulumi.kotlin.ConvertibleToJava
import com.pulumi.kotlin.PulumiTagMarker
import com.pulumi.kotlin.applySuspend
import kotlin.Pair
import kotlin.String
import kotlin.Suppress
import kotlin.Unit
import kotlin.collections.List
import kotlin.collections.Map
import kotlin.jvm.JvmName

/**
 * Definition of AWS::ResourceExplorer2::View Resource Type
 * @property filters An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
 * For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
 * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
 * @property includedProperties A list of fields that provide additional information about the view.
 * @property scope The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
 * @property tags Tag key and value pairs that are attached to the view.
 * @property viewName The name of the new view.
 */
public data class ViewArgs(
    public val filters: Output? = null,
    public val includedProperties: Output>? = null,
    public val scope: Output? = null,
    public val tags: Output>? = null,
    public val viewName: Output? = null,
) : ConvertibleToJava {
    override fun toJava(): com.pulumi.awsnative.resourceexplorer2.ViewArgs =
        com.pulumi.awsnative.resourceexplorer2.ViewArgs.builder()
            .filters(filters?.applyValue({ args0 -> args0.let({ args0 -> args0.toJava() }) }))
            .includedProperties(
                includedProperties?.applyValue({ args0 ->
                    args0.map({ args0 ->
                        args0.let({ args0 -> args0.toJava() })
                    })
                }),
            )
            .scope(scope?.applyValue({ args0 -> args0 }))
            .tags(tags?.applyValue({ args0 -> args0.map({ args0 -> args0.key.to(args0.value) }).toMap() }))
            .viewName(viewName?.applyValue({ args0 -> args0 })).build()
}

/**
 * Builder for [ViewArgs].
 */
@PulumiTagMarker
public class ViewArgsBuilder internal constructor() {
    private var filters: Output? = null

    private var includedProperties: Output>? = null

    private var scope: Output? = null

    private var tags: Output>? = null

    private var viewName: Output? = null

    /**
     * @param value An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
     * For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
     * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
     */
    @JvmName("mmxhdewisjlcvxiu")
    public suspend fun filters(`value`: Output) {
        this.filters = value
    }

    /**
     * @param value A list of fields that provide additional information about the view.
     */
    @JvmName("bgxnpqhmfuyqsbsm")
    public suspend fun includedProperties(`value`: Output>) {
        this.includedProperties = value
    }

    @JvmName("riuqljyfdqctnpiv")
    public suspend fun includedProperties(vararg values: Output) {
        this.includedProperties = Output.all(values.asList())
    }

    /**
     * @param values A list of fields that provide additional information about the view.
     */
    @JvmName("xiyfagejkwxmynsw")
    public suspend fun includedProperties(values: List>) {
        this.includedProperties = Output.all(values)
    }

    /**
     * @param value The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
     */
    @JvmName("plgvqmojfpbkcsop")
    public suspend fun scope(`value`: Output) {
        this.scope = value
    }

    /**
     * @param value Tag key and value pairs that are attached to the view.
     */
    @JvmName("rxcqlhlpjafrsdnf")
    public suspend fun tags(`value`: Output>) {
        this.tags = value
    }

    /**
     * @param value The name of the new view.
     */
    @JvmName("ecjmhgmcrcrjwqli")
    public suspend fun viewName(`value`: Output) {
        this.viewName = value
    }

    /**
     * @param value An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
     * For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
     * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
     */
    @JvmName("mfnvofgrxbjckscn")
    public suspend fun filters(`value`: ViewSearchFilterArgs?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.filters = mapped
    }

    /**
     * @param argument An array of strings that include search keywords, prefixes, and operators that filter the results that are returned for queries made using this view. When you use this view in a [Search](https://docs.aws.amazon.com/resource-explorer/latest/apireference/API_Search.html) operation, the filter string is combined with the search's `QueryString` parameter using a logical `AND` operator.
     * For information about the supported syntax, see [Search query reference for Resource Explorer](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html) in the *AWS Resource Explorer User Guide* .
     * > This query string in the context of this operation supports only [filter prefixes](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-filters) with optional [operators](https://docs.aws.amazon.com/resource-explorer/latest/userguide/using-search-query-syntax.html#query-syntax-operators) . It doesn't support free-form text. For example, the string `region:us* service:ec2 -tag:stage=prod` includes all Amazon EC2 resources in any AWS Region that begin with the letters `us` and are *not* tagged with a key `Stage` that has the value `prod` .
     */
    @JvmName("uhxgsyptsgaqbffa")
    public suspend fun filters(argument: suspend ViewSearchFilterArgsBuilder.() -> Unit) {
        val toBeMapped = ViewSearchFilterArgsBuilder().applySuspend { argument() }.build()
        val mapped = of(toBeMapped)
        this.filters = mapped
    }

    /**
     * @param value A list of fields that provide additional information about the view.
     */
    @JvmName("bywblcnvlvnykwxq")
    public suspend fun includedProperties(`value`: List?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.includedProperties = mapped
    }

    /**
     * @param argument A list of fields that provide additional information about the view.
     */
    @JvmName("kxovpughmqhlcnsj")
    public suspend fun includedProperties(argument: List Unit>) {
        val toBeMapped = argument.toList().map {
            ViewIncludedPropertyArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.includedProperties = mapped
    }

    /**
     * @param argument A list of fields that provide additional information about the view.
     */
    @JvmName("ntoavospaivwjbvm")
    public suspend fun includedProperties(vararg argument: suspend ViewIncludedPropertyArgsBuilder.() -> Unit) {
        val toBeMapped = argument.toList().map {
            ViewIncludedPropertyArgsBuilder().applySuspend {
                it()
            }.build()
        }
        val mapped = of(toBeMapped)
        this.includedProperties = mapped
    }

    /**
     * @param argument A list of fields that provide additional information about the view.
     */
    @JvmName("qbqssbsqaurypsii")
    public suspend fun includedProperties(argument: suspend ViewIncludedPropertyArgsBuilder.() -> Unit) {
        val toBeMapped = listOf(ViewIncludedPropertyArgsBuilder().applySuspend { argument() }.build())
        val mapped = of(toBeMapped)
        this.includedProperties = mapped
    }

    /**
     * @param values A list of fields that provide additional information about the view.
     */
    @JvmName("kylcfrunfhbgvafi")
    public suspend fun includedProperties(vararg values: ViewIncludedPropertyArgs) {
        val toBeMapped = values.toList()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.includedProperties = mapped
    }

    /**
     * @param value The root ARN of the account, an organizational unit (OU), or an organization ARN. If left empty, the default is account.
     */
    @JvmName("kgrmaupoaapupaxn")
    public suspend fun scope(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.scope = mapped
    }

    /**
     * @param value Tag key and value pairs that are attached to the view.
     */
    @JvmName("jbgaluucauhjynpv")
    public suspend fun tags(`value`: Map?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param values Tag key and value pairs that are attached to the view.
     */
    @JvmName("ieypfuwmqcnfobmh")
    public fun tags(vararg values: Pair) {
        val toBeMapped = values.toMap()
        val mapped = toBeMapped.let({ args0 -> of(args0) })
        this.tags = mapped
    }

    /**
     * @param value The name of the new view.
     */
    @JvmName("wnccwieunbuwibov")
    public suspend fun viewName(`value`: String?) {
        val toBeMapped = value
        val mapped = toBeMapped?.let({ args0 -> of(args0) })
        this.viewName = mapped
    }

    internal fun build(): ViewArgs = ViewArgs(
        filters = filters,
        includedProperties = includedProperties,
        scope = scope,
        tags = tags,
        viewName = viewName,
    )
}