Package software.amazon.awscdk.services.quicksight

Class CfnAnalysis

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnAnalysis
All Implemented Interfaces:
IInspectable, ITaggable, IAnalysisRef, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.116.0 (build 0eddcff)", date="2025-10-24T13:34:43.409Z") @Stability(Stable) public class CfnAnalysis extends CfnResource implements IInspectable, IAnalysisRef, ITaggable
Creates an analysis in Amazon QuickSight.

Example:

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnAnalysis

      protected CfnAnalysis(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnAnalysis

      protected CfnAnalysis(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnAnalysis

      @Stability(Stable) public CfnAnalysis(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnAnalysisProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAnalysisRef

      @Stability(Stable) @NotNull public AnalysisReference getAnalysisRef()
      A reference to a Analysis resource.
      Specified by:
      getAnalysisRef in interface IAnalysisRef

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name (ARN) of the analysis.

    • getAttrCreatedTime

      @Stability(Stable) @NotNull public String getAttrCreatedTime()
      The time that the analysis was created.

    • getAttrDataSetArns

      @Stability(Stable) @NotNull public List<String> getAttrDataSetArns()
      The ARNs of the datasets of the analysis.

    • getAttrErrors

      @Stability(Stable) @NotNull public IResolvable getAttrErrors()

    • getAttrLastUpdatedTime

      @Stability(Stable) @NotNull public String getAttrLastUpdatedTime()
      The time that the analysis was last updated.

    • getAttrSheets

      @Stability(Stable) @NotNull public IResolvable getAttrSheets()

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getTags

      @Stability(Stable) @NotNull public TagManager getTags()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getTags in interface ITaggable

    • getAnalysisId

      @Stability(Stable) @NotNull public String getAnalysisId()
      The ID for the analysis that you're creating.

    • setAnalysisId

      @Stability(Stable) public void setAnalysisId(@NotNull String value)
      The ID for the analysis that you're creating.

    • getAwsAccountId

      @Stability(Stable) @NotNull public String getAwsAccountId()
      The ID of the AWS account where you are creating an analysis.

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@NotNull String value)
      The ID of the AWS account where you are creating an analysis.

    • getName

      @Stability(Stable) @NotNull public String getName()
      A descriptive name for the analysis that you're creating.

    • setName

      @Stability(Stable) public void setName(@NotNull String value)
      A descriptive name for the analysis that you're creating.

    • getDefinition

      @Stability(Stable) @Nullable public Object getDefinition()
      Returns union: either IResolvable or CfnAnalysis.AnalysisDefinitionProperty

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable IResolvable value)

    • setDefinition

      @Stability(Stable) public void setDefinition(@Nullable CfnAnalysis.AnalysisDefinitionProperty value)

    • getErrors

      @Stability(Stable) @Nullable public Object getErrors()
      Errors associated with the analysis.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.AnalysisErrorProperty>

    • setErrors

      @Stability(Stable) public void setErrors(@Nullable IResolvable value)
      Errors associated with the analysis.

    • setErrors

      @Stability(Stable) public void setErrors(@Nullable List<Object> value)
      Errors associated with the analysis.

    • getFolderArns

      @Stability(Stable) @Nullable public List<String> getFolderArns()

    • setFolderArns

      @Stability(Stable) public void setFolderArns(@Nullable List<String> value)

    • getParameters

      @Stability(Stable) @Nullable public Object getParameters()
      The parameter names and override values that you want to use.

      Returns union: either IResolvable or CfnAnalysis.ParametersProperty

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable IResolvable value)
      The parameter names and override values that you want to use.

    • setParameters

      @Stability(Stable) public void setParameters(@Nullable CfnAnalysis.ParametersProperty value)
      The parameter names and override values that you want to use.

    • getPermissions

      @Stability(Stable) @Nullable public Object getPermissions()
      A structure that describes the principals and the resource-level permissions on an analysis.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.ResourcePermissionProperty>

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable IResolvable value)
      A structure that describes the principals and the resource-level permissions on an analysis.

    • setPermissions

      @Stability(Stable) public void setPermissions(@Nullable List<Object> value)
      A structure that describes the principals and the resource-level permissions on an analysis.

    • getSheets

      @Stability(Stable) @Nullable public Object getSheets()
      A list of the associated sheets with the unique identifier and name of each sheet.

      Returns union: either IResolvable or Listinvalid input: '<'either IResolvable or CfnAnalysis.SheetProperty>

    • setSheets

      @Stability(Stable) public void setSheets(@Nullable IResolvable value)
      A list of the associated sheets with the unique identifier and name of each sheet.

    • setSheets

      @Stability(Stable) public void setSheets(@Nullable List<Object> value)
      A list of the associated sheets with the unique identifier and name of each sheet.

    • getSourceEntity

      @Stability(Stable) @Nullable public Object getSourceEntity()
      A source entity to use for the analysis that you're creating.

      Returns union: either IResolvable or CfnAnalysis.AnalysisSourceEntityProperty

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable IResolvable value)
      A source entity to use for the analysis that you're creating.

    • setSourceEntity

      @Stability(Stable) public void setSourceEntity(@Nullable CfnAnalysis.AnalysisSourceEntityProperty value)
      A source entity to use for the analysis that you're creating.

    • getStatus

      @Stability(Stable) @Nullable public String getStatus()
      Status associated with the analysis.

    • setStatus

      @Stability(Stable) public void setStatus(@Nullable String value)
      Status associated with the analysis.

    • getTagsRaw

      @Stability(Stable) @Nullable public List<CfnTag> getTagsRaw()
      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

    • setTagsRaw

      @Stability(Stable) public void setTagsRaw(@Nullable List<CfnTag> value)
      Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

    • getThemeArn

      @Stability(Stable) @Nullable public String getThemeArn()
      The ARN for the theme to apply to the analysis that you're creating.

    • setThemeArn

      @Stability(Stable) public void setThemeArn(@Nullable String value)
      The ARN for the theme to apply to the analysis that you're creating.

    • getValidationStrategy

      @Stability(Stable) @Nullable public Object getValidationStrategy()
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

      Returns union: either IResolvable or CfnAnalysis.ValidationStrategyProperty

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable IResolvable value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

    • setValidationStrategy

      @Stability(Stable) public void setValidationStrategy(@Nullable CfnAnalysis.ValidationStrategyProperty value)
      The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.