Package com.pulumi.aws.quicksight
Class Analysis
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.quicksight.Analysis
-
public class Analysis extends com.pulumi.resources.CustomResource
Resource for managing a QuickSight Analysis. ## Example Usage ### From Source Template <!--Start PulumiCodeChooser -->package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.quicksight.Analysis; import com.pulumi.aws.quicksight.AnalysisArgs; import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntityArgs; import com.pulumi.aws.quicksight.inputs.AnalysisSourceEntitySourceTemplateArgs; import java.util.List; import java.util.ArrayList; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Analysis("example", AnalysisArgs.builder() .analysisId("example-id") .name("example-name") .sourceEntity(AnalysisSourceEntityArgs.builder() .sourceTemplate(AnalysisSourceEntitySourceTemplateArgs.builder() .arn(source.arn()) .dataSetReferences(AnalysisSourceEntitySourceTemplateDataSetReferenceArgs.builder() .dataSetArn(dataset.arn()) .dataSetPlaceholder("1") .build()) .build()) .build()) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description Analysis(java.lang.String name)
Analysis(java.lang.String name, AnalysisArgs args)
Analysis(java.lang.String name, AnalysisArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.lang.String>
analysisId()
com.pulumi.core.Output<java.lang.String>
arn()
com.pulumi.core.Output<java.lang.String>
awsAccountId()
com.pulumi.core.Output<java.lang.String>
createdTime()
static Analysis
get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, AnalysisState state, com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.lang.String>
lastPublishedTime()
com.pulumi.core.Output<java.lang.String>
lastUpdatedTime()
com.pulumi.core.Output<java.lang.String>
name()
com.pulumi.core.Output<AnalysisParameters>
parameters()
com.pulumi.core.Output<java.util.Optional<java.util.List<AnalysisPermission>>>
permissions()
com.pulumi.core.Output<java.util.Optional<java.lang.Integer>>
recoveryWindowInDays()
com.pulumi.core.Output<java.util.Optional<AnalysisSourceEntity>>
sourceEntity()
com.pulumi.core.Output<java.lang.String>
status()
com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>
tags()
com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>
tagsAll()
com.pulumi.core.Output<java.util.Optional<java.lang.String>>
themeArn()
-
-
-
Constructor Detail
-
Analysis
public Analysis(java.lang.String name)
- Parameters:
name
- The _unique_ name of the resulting resource.
-
Analysis
public Analysis(java.lang.String name, AnalysisArgs args)
- Parameters:
name
- The _unique_ name of the resulting resource.args
- The arguments to use to populate this resource's properties.
-
Analysis
public Analysis(java.lang.String name, AnalysisArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)
- Parameters:
name
- The _unique_ name of the resulting resource.args
- The arguments to use to populate this resource's properties.options
- A bag of options that control this resource's behavior.
-
-
Method Detail
-
analysisId
public com.pulumi.core.Output<java.lang.String> analysisId()
- Returns:
- Identifier for the analysis.
-
arn
public com.pulumi.core.Output<java.lang.String> arn()
- Returns:
- ARN of the analysis.
-
awsAccountId
public com.pulumi.core.Output<java.lang.String> awsAccountId()
- Returns:
- AWS account ID.
-
createdTime
public com.pulumi.core.Output<java.lang.String> createdTime()
- Returns:
- The time that the analysis was created.
-
lastPublishedTime
public com.pulumi.core.Output<java.lang.String> lastPublishedTime()
-
lastUpdatedTime
public com.pulumi.core.Output<java.lang.String> lastUpdatedTime()
- Returns:
- The time that the analysis was last updated.
-
name
public com.pulumi.core.Output<java.lang.String> name()
- Returns:
- Display name for the analysis. The following arguments are optional:
-
parameters
public com.pulumi.core.Output<AnalysisParameters> parameters()
- Returns:
- The parameters for the creation of the analysis, which you want to use to override the default settings. An analysis can have any type of parameters, and some parameters might accept multiple values. See parameters.
-
permissions
public com.pulumi.core.Output<java.util.Optional<java.util.List<AnalysisPermission>>> permissions()
- Returns:
- A set of resource permissions on the analysis. Maximum of 64 items. See permissions.
-
recoveryWindowInDays
public com.pulumi.core.Output<java.util.Optional<java.lang.Integer>> recoveryWindowInDays()
- Returns:
- A value that specifies the number of days that Amazon QuickSight waits before it deletes the analysis. Use `0` to force deletion without recovery. Minimum value of `7`. Maximum value of `30`. Default to `30`.
-
sourceEntity
public com.pulumi.core.Output<java.util.Optional<AnalysisSourceEntity>> sourceEntity()
- Returns:
- The entity that you are using as a source when you create the analysis (template). Only one of `definition` or `source_entity` should be configured. See source_entity.
-
status
public com.pulumi.core.Output<java.lang.String> status()
- Returns:
- The analysis creation status.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Key-value map of resource tags. If configured with a provider `default_tags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- A map of tags assigned to the resource, including those inherited from the provider `default_tags` configuration block.
-
themeArn
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> themeArn()
- Returns:
- The Amazon Resource Name (ARN) of the theme that is being used for this analysis. The theme ARN must exist in the same AWS account where you create the analysis.
-
get
public static Analysis get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable AnalysisState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name
- The _unique_ name of the resulting resource.id
- The _unique_ provider ID of the resource to lookup.state
-options
- Optional settings to control the behavior of the CustomResource.
-
-