CfnAnalysis

java.lang.Object
- software.constructs.Construct
- - software.amazon.awscdk.core.Construct
  - - software.amazon.awscdk.core.CfnElement
    - - software.amazon.awscdk.core.CfnRefElement
      - software.amazon.awscdk.core.CfnResource
        
        software.amazon.awscdk.services.quicksight.CfnAnalysis

All Implemented Interfaces:: IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.73.0 (build 6faeda3)",
           date="2023-01-31T18:36:49.718Z")
public class CfnAnalysis
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QuickSight::Analysis`.

Creates an analysis in Amazon QuickSight.

Example:

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.quicksight.*;
 CfnAnalysis cfnAnalysis = CfnAnalysis.Builder.create(this, "MyCfnAnalysis")
         .analysisId("analysisId")
         .awsAccountId("awsAccountId")
         .sourceEntity(AnalysisSourceEntityProperty.builder()
                 .sourceTemplate(AnalysisSourceTemplateProperty.builder()
                         .arn("arn")
                         .dataSetReferences(List.of(DataSetReferenceProperty.builder()
                                 .dataSetArn("dataSetArn")
                                 .dataSetPlaceholder("dataSetPlaceholder")
                                 .build()))
                         .build())
                 .build())
         // the properties below are optional
         .errors(List.of(AnalysisErrorProperty.builder()
                 .message("message")
                 .type("type")
                 .build()))
         .name("name")
         .parameters(ParametersProperty.builder()
                 .dateTimeParameters(List.of(DateTimeParameterProperty.builder()
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .decimalParameters(List.of(DecimalParameterProperty.builder()
                         .name("name")
                         .values(List.of(123))
                         .build()))
                 .integerParameters(List.of(IntegerParameterProperty.builder()
                         .name("name")
                         .values(List.of(123))
                         .build()))
                 .stringParameters(List.of(StringParameterProperty.builder()
                         .name("name")
                         .values(List.of("values"))
                         .build()))
                 .build())
         .permissions(List.of(ResourcePermissionProperty.builder()
                 .actions(List.of("actions"))
                 .principal("principal")
                 .build()))
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .themeArn("themeArn")
         .build();

Nested Class Summary

Nested Classes
Modifier and Type	Class and Description
`static interface`	`CfnAnalysis.AnalysisErrorProperty` Analysis error.
`static interface`	`CfnAnalysis.AnalysisSourceEntityProperty` The source entity of an analysis.
`static interface`	`CfnAnalysis.AnalysisSourceTemplateProperty` The source template of an analysis.
`static class`	`CfnAnalysis.Builder` A fluent builder for `CfnAnalysis`.
`static interface`	`CfnAnalysis.DataSetReferenceProperty` Dataset reference.
`static interface`	`CfnAnalysis.DateTimeParameterProperty` A date-time parameter.
`static interface`	`CfnAnalysis.DecimalParameterProperty` A decimal parameter.
`static interface`	`CfnAnalysis.IntegerParameterProperty` An integer parameter.
`static interface`	`CfnAnalysis.ParametersProperty` A list of Amazon QuickSight parameters and the list's override values.
`static interface`	`CfnAnalysis.ResourcePermissionProperty` Permission for the resource.
`static interface`	`CfnAnalysis.SheetProperty` A sheet , which is an object that contains a set of visuals that are viewed together on one page in Amazon QuickSight.
`static interface`	`CfnAnalysis.StringParameterProperty` A string parameter.

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct
IConstruct.Jsii$Default

Field Summary

Fields
Modifier and Type Field and Description

static java.lang.String CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.

Fields
Modifier and Type	Field and Description
`static java.lang.String`	`CFN_RESOURCE_TYPE_NAME` The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors
Modifier	Constructor and Description
	`CfnAnalysis(Construct scope, java.lang.String id, CfnAnalysisProps props)` Create a new `AWS::QuickSight::Analysis`.
`protected`	`CfnAnalysis(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)`
`protected`	`CfnAnalysis(software.amazon.jsii.JsiiObjectRef objRef)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`java.lang.String`	`getAnalysisId()` The ID for the analysis that you're creating.
`java.lang.String`	`getAttrArn()` The Amazon Resource Name (ARN) of the analysis.
`java.lang.String`	`getAttrCreatedTime()`
`java.util.List<java.lang.String>`	`getAttrDataSetArns()` The ARNs of the datasets of the analysis.
`java.lang.String`	`getAttrLastUpdatedTime()` The time that the analysis was last updated.
`IResolvable`	`getAttrSheets()`
`java.lang.String`	`getAttrStatus()`
`java.lang.String`	`getAwsAccountId()` The ID of the AWS account where you are creating an analysis.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`getCfnProperties()`
`java.lang.Object`	`getErrors()` `AWS::QuickSight::Analysis.Errors`.
`java.lang.String`	`getName()` A descriptive name for the analysis that you're creating.
`java.lang.Object`	`getParameters()` The parameter names and override values that you want to use.
`java.lang.Object`	`getPermissions()` A structure that describes the principals and the resource-level permissions on an analysis.
`java.lang.Object`	`getSourceEntity()` A source entity to use for the analysis that you're creating.
`TagManager`	`getTags()` Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
`java.lang.String`	`getThemeArn()` The ARN for the theme to apply to the analysis that you're creating.
`void`	`inspect(TreeInspector inspector)` Examines the CloudFormation resource and discloses attributes.
`protected java.util.Map<java.lang.String,java.lang.Object>`	`renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)`
`void`	`setAnalysisId(java.lang.String value)` The ID for the analysis that you're creating.
`void`	`setAwsAccountId(java.lang.String value)` The ID of the AWS account where you are creating an analysis.
`void`	`setErrors(IResolvable value)` `AWS::QuickSight::Analysis.Errors`.
`void`	`setErrors(java.util.List<java.lang.Object> value)` `AWS::QuickSight::Analysis.Errors`.
`void`	`setName(java.lang.String value)` A descriptive name for the analysis that you're creating.
`void`	`setParameters(CfnAnalysis.ParametersProperty value)` The parameter names and override values that you want to use.
`void`	`setParameters(IResolvable value)` The parameter names and override values that you want to use.
`void`	`setPermissions(IResolvable value)` A structure that describes the principals and the resource-level permissions on an analysis.
`void`	`setPermissions(java.util.List<java.lang.Object> value)` A structure that describes the principals and the resource-level permissions on an analysis.
`void`	`setSourceEntity(CfnAnalysis.AnalysisSourceEntityProperty value)` A source entity to use for the analysis that you're creating.
`void`	`setSourceEntity(IResolvable value)` A source entity to use for the analysis that you're creating.
`void`	`setThemeArn(java.lang.String value)` The ARN for the theme to apply to the analysis that you're creating.

Methods inherited from class software.amazon.awscdk.core.CfnResource
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement
getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Field Detail
  - CFN_RESOURCE_TYPE_NAME
```
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
```
    The CloudFormation resource type name for this resource class.
- Constructor Detail
  - CfnAnalysis
```
protected CfnAnalysis(software.amazon.jsii.JsiiObjectRef objRef)
```
  - CfnAnalysis
```
protected CfnAnalysis(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
```
  - CfnAnalysis
```
public CfnAnalysis(Construct scope,
                   java.lang.String id,
                   CfnAnalysisProps props)
```
    Create a new `AWS::QuickSight::Analysis`.
    
    Parameters:
    
    scope - - scope in which this resource is defined. This parameter is required.
    
    id - - scoped id of the resource. This parameter is required.
    
    props - - resource properties. This parameter is required.
- Method Detail
  - inspect
```
public void inspect(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
```
protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
```
    Overrides:
    
    renderProperties in class CfnResource
    
    Parameters:
    
    props - This parameter is required.
  - getAttrArn
```
public java.lang.String getAttrArn()
```
    The Amazon Resource Name (ARN) of the analysis.
  - getAttrCreatedTime
```
public java.lang.String getAttrCreatedTime()
```
  - getAttrDataSetArns
```
public java.util.List<java.lang.String> getAttrDataSetArns()
```
    The ARNs of the datasets of the analysis.
  - getAttrLastUpdatedTime
```
public java.lang.String getAttrLastUpdatedTime()
```
    The time that the analysis was last updated.
  - getAttrSheets
```
public IResolvable getAttrSheets()
```
  - getAttrStatus
```
public java.lang.String getAttrStatus()
```
  - getCfnProperties
```
protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
```
    Overrides:
    
    getCfnProperties in class CfnResource
  - getTags
```
public TagManager getTags()
```
    Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
  - getAnalysisId
```
public java.lang.String getAnalysisId()
```
    The ID for the analysis that you're creating.
    This ID displays in the URL of the analysis.
  - setAnalysisId
```
public void setAnalysisId(java.lang.String value)
```
    The ID for the analysis that you're creating.
    This ID displays in the URL of the analysis.
  - getAwsAccountId
```
public java.lang.String getAwsAccountId()
```
    The ID of the AWS account where you are creating an analysis.
  - setAwsAccountId
```
public void setAwsAccountId(java.lang.String value)
```
    The ID of the AWS account where you are creating an analysis.
  - getSourceEntity
```
public java.lang.Object getSourceEntity()
```
    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.
  - setSourceEntity
```
public void setSourceEntity(CfnAnalysis.AnalysisSourceEntityProperty value)
```
    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.
  - setSourceEntity
```
public void setSourceEntity(IResolvable value)
```
    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.
  - getErrors
```
public java.lang.Object getErrors()
```
    `AWS::QuickSight::Analysis.Errors`.
  - setErrors
```
public void setErrors(IResolvable value)
```
    `AWS::QuickSight::Analysis.Errors`.
  - setErrors
```
public void setErrors(java.util.List<java.lang.Object> value)
```
    `AWS::QuickSight::Analysis.Errors`.
  - getName
```
public java.lang.String getName()
```
    A descriptive name for the analysis that you're creating.
    This name displays for the analysis in the Amazon QuickSight console.
  - setName
```
public void setName(java.lang.String value)
```
    A descriptive name for the analysis that you're creating.
    This name displays for the analysis in the Amazon QuickSight console.
  - getParameters
```
public java.lang.Object getParameters()
```
    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.
  - setParameters
```
public void setParameters(IResolvable value)
```
    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.
  - setParameters
```
public void setParameters(CfnAnalysis.ParametersProperty value)
```
    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.
  - getPermissions
```
public java.lang.Object getPermissions()
```
    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 .
  - setPermissions
```
public void setPermissions(IResolvable value)
```
    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 .
  - setPermissions
```
public void setPermissions(java.util.List<java.lang.Object> value)
```
    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 .
  - getThemeArn
```
public java.lang.String getThemeArn()
```
    The ARN for the theme to apply to the analysis that you're creating.
    To see the theme in the Amazon QuickSight console, make sure that you have access to it.
  - setThemeArn
```
public void setThemeArn(java.lang.String value)
```
    The ARN for the theme to apply to the analysis that you're creating.
    To see the theme in the Amazon QuickSight console, make sure that you have access to it.

Class CfnAnalysis

Nested Class Summary

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

Field Summary

Constructor Summary

Method Summary

Methods inherited from class software.amazon.awscdk.core.CfnResource

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

Methods inherited from class software.amazon.awscdk.core.CfnElement

Methods inherited from class software.amazon.awscdk.core.Construct

Methods inherited from class java.lang.Object

Field Detail

CFN_RESOURCE_TYPE_NAME

Constructor Detail

CfnAnalysis

CfnAnalysis

CfnAnalysis

Method Detail

inspect

renderProperties

getAttrArn

getAttrCreatedTime

getAttrDataSetArns

getAttrLastUpdatedTime

getAttrSheets

getAttrStatus

getCfnProperties

getTags

getAnalysisId

setAnalysisId

getAwsAccountId

setAwsAccountId

getSourceEntity

setSourceEntity

setSourceEntity

getErrors

setErrors

setErrors

getName

setName

getParameters

setParameters

setParameters

getPermissions

setPermissions

setPermissions

getThemeArn

setThemeArn