com.pulumi.awsnative.quicksight.kotlin.Dashboard.kt Maven / Gradle / Ivy
@file:Suppress("NAME_SHADOWING", "DEPRECATION")
package com.pulumi.awsnative.quicksight.kotlin
import com.pulumi.awsnative.kotlin.outputs.Tag
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardLinkSharingConfiguration
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardParameters
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardPublishOptions
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardResourcePermission
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardSourceEntity
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardValidationStrategy
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardVersion
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardVersionDefinition
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.outputs.DashboardLinkSharingConfiguration.Companion.toKotlin as dashboardLinkSharingConfigurationToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardParameters.Companion.toKotlin as dashboardParametersToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardPublishOptions.Companion.toKotlin as dashboardPublishOptionsToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardResourcePermission.Companion.toKotlin as dashboardResourcePermissionToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardSourceEntity.Companion.toKotlin as dashboardSourceEntityToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardValidationStrategy.Companion.toKotlin as dashboardValidationStrategyToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardVersion.Companion.toKotlin as dashboardVersionToKotlin
import com.pulumi.awsnative.quicksight.kotlin.outputs.DashboardVersionDefinition.Companion.toKotlin as dashboardVersionDefinitionToKotlin
/**
* Builder for [Dashboard].
*/
@PulumiTagMarker
public class DashboardResourceBuilder internal constructor() {
public var name: String? = null
public var args: DashboardArgs = DashboardArgs()
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 DashboardArgsBuilder.() -> Unit) {
val builder = DashboardArgsBuilder()
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(): Dashboard {
val builtJavaResource = com.pulumi.awsnative.quicksight.Dashboard(
this.name,
this.args.toJava(),
this.opts.toJava(),
)
return Dashboard(builtJavaResource)
}
}
/**
* Definition of the AWS::QuickSight::Dashboard Resource Type.
*/
public class Dashboard internal constructor(
override val javaResource: com.pulumi.awsnative.quicksight.Dashboard,
) : KotlinCustomResource(javaResource, DashboardMapper) {
/**
* The Amazon Resource Name (ARN) of the resource.
*/
public val arn: Output
get() = javaResource.arn().applyValue({ args0 -> args0 })
/**
* The ID of the AWS account where you want to create the dashboard.
*/
public val awsAccountId: Output
get() = javaResource.awsAccountId().applyValue({ args0 -> args0 })
/**
* The time that this dashboard was created.
*/
public val createdTime: Output
get() = javaResource.createdTime().applyValue({ args0 -> args0 })
/**
* The ID for the dashboard, also added to the IAM policy.
*/
public val dashboardId: Output
get() = javaResource.dashboardId().applyValue({ args0 -> args0 })
/**
* Options for publishing the dashboard when you create it:
* - `AvailabilityStatus` for `AdHocFilteringOption` - This status can be either `ENABLED` or `DISABLED` . When this is set to `DISABLED` , Amazon QuickSight disables the left filter pane on the published dashboard, which can be used for ad hoc (one-time) filtering. This option is `ENABLED` by default.
* - `AvailabilityStatus` for `ExportToCSVOption` - This status can be either `ENABLED` or `DISABLED` . The visual option to export data to .CSV format isn't enabled when this is set to `DISABLED` . This option is `ENABLED` by default.
* - `VisibilityState` for `SheetControlsOption` - This visibility state can be either `COLLAPSED` or `EXPANDED` . This option is `COLLAPSED` by default.
*/
public val dashboardPublishOptions: Output?
get() = javaResource.dashboardPublishOptions().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> dashboardPublishOptionsToKotlin(args0) })
}).orElse(null)
})
public val definition: Output?
get() = javaResource.definition().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
dashboardVersionDefinitionToKotlin(args0)
})
}).orElse(null)
})
/**
* The last time that this dashboard was published.
*/
public val lastPublishedTime: Output
get() = javaResource.lastPublishedTime().applyValue({ args0 -> args0 })
/**
* The last time that this dashboard was updated.
*/
public val lastUpdatedTime: Output
get() = javaResource.lastUpdatedTime().applyValue({ args0 -> args0 })
/**
* A list of analysis Amazon Resource Names (ARNs) to be linked to the dashboard.
*/
public val linkEntities: Output>?
get() = javaResource.linkEntities().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0
})
}).orElse(null)
})
/**
* A structure that contains the link sharing configurations that you want to apply overrides to.
*/
public val linkSharingConfiguration: Output?
get() = javaResource.linkSharingConfiguration().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> dashboardLinkSharingConfigurationToKotlin(args0) })
}).orElse(null)
})
/**
* The display name of the dashboard.
*/
public val name: Output
get() = javaResource.name().applyValue({ args0 -> args0 })
/**
* The parameters for the creation of the dashboard, which you want to use to override the default settings. A dashboard can have any type of parameters, and some parameters might accept multiple values.
*/
public val parameters: Output?
get() = javaResource.parameters().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
dashboardParametersToKotlin(args0)
})
}).orElse(null)
})
/**
* A structure that contains the permissions of the dashboard. You can use this structure for granting permissions by providing a list of IAM action information for each principal ARN.
* To specify no permissions, omit the permissions list.
*/
public val permissions: Output>?
get() = javaResource.permissions().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> dashboardResourcePermissionToKotlin(args0) })
})
}).orElse(null)
})
/**
* The entity that you are using as a source when you create the dashboard. In `SourceEntity` , you specify the type of object that you want to use. You can only create a dashboard from a template, so you use a `SourceTemplate` entity. If you need to create a dashboard from an analysis, first convert the analysis to a template by using the `CreateTemplate` API operation. For `SourceTemplate` , specify the Amazon Resource Name (ARN) of the source template. The `SourceTemplate` ARN can contain any AWS account; and any QuickSight-supported AWS Region .
* Use the `DataSetReferences` entity within `SourceTemplate` to list the replacement datasets for the placeholders listed in the original. The schema in each dataset must match its placeholder.
*/
public val sourceEntity: Output?
get() = javaResource.sourceEntity().applyValue({ args0 ->
args0.map({ args0 ->
args0.let({ args0 ->
dashboardSourceEntityToKotlin(args0)
})
}).orElse(null)
})
/**
* Contains a map of the key-value pairs for the resource tag or tags assigned to the dashboard.
*/
public val tags: Output>?
get() = javaResource.tags().applyValue({ args0 ->
args0.map({ args0 ->
args0.map({ args0 ->
args0.let({ args0 -> tagToKotlin(args0) })
})
}).orElse(null)
})
/**
* The Amazon Resource Name (ARN) of the theme that is being used for this dashboard. If you add a value for this field, it overrides the value that is used in the source entity. The theme ARN must exist in the same AWS account where you create the dashboard.
*/
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 -> dashboardValidationStrategyToKotlin(args0) })
}).orElse(null)
})
public val version: Output
get() = javaResource.version().applyValue({ args0 ->
args0.let({ args0 ->
dashboardVersionToKotlin(args0)
})
})
/**
* A description for the first version of the dashboard being created.
*/
public val versionDescription: Output?
get() = javaResource.versionDescription().applyValue({ args0 ->
args0.map({ args0 ->
args0
}).orElse(null)
})
}
public object DashboardMapper : ResourceMapper {
override fun supportsMappingOfType(javaResource: Resource): Boolean =
com.pulumi.awsnative.quicksight.Dashboard::class == javaResource::class
override fun map(javaResource: Resource): Dashboard = Dashboard(
javaResource as
com.pulumi.awsnative.quicksight.Dashboard,
)
}
/**
* @see [Dashboard].
* @param name The _unique_ name of the resulting resource.
* @param block Builder for [Dashboard].
*/
public suspend fun dashboard(name: String, block: suspend DashboardResourceBuilder.() -> Unit): Dashboard {
val builder = DashboardResourceBuilder()
builder.name(name)
block(builder)
return builder.build()
}
/**
* @see [Dashboard].
* @param name The _unique_ name of the resulting resource.
*/
public fun dashboard(name: String): Dashboard {
val builder = DashboardResourceBuilder()
builder.name(name)
return builder.build()
}
© 2015 - 2025 Weber Informatics LLC | Privacy Policy