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, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.67.0 (build 2c027f5)",
           date="2022-09-19T20:26:41.274Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.constructs.IConstruct

software.constructs.IConstruct.Jsii$Default

Field Summary

Fields

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

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnAnalysis(software.constructs.Construct scope, 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

Modifier and Type	Method and Description
String	getAnalysisId() The ID for the analysis that you're creating.
String	getAttrArn() The Amazon Resource Name (ARN) of the analysis.
String	getAttrCreatedTime()
List<String>	getAttrDataSetArns() The ARNs of the datasets of the analysis.
String	getAttrLastUpdatedTime() The time that the analysis was last updated.
IResolvable	getAttrSheets()
String	getAttrStatus()
String	getAwsAccountId() The ID of the AWS account where you are creating an analysis.
protected Map<String,Object>	getCfnProperties()
Object	getErrors() `AWS::QuickSight::Analysis.Errors`.
String	getName() A descriptive name for the analysis that you're creating.
Object	getParameters() The parameter names and override values that you want to use.
Object	getPermissions() A structure that describes the principals and the resource-level permissions on an analysis.
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.
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 Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAnalysisId(String value) The ID for the analysis that you're creating.
void	setAwsAccountId(String value) The ID of the AWS account where you are creating an analysis.
void	setErrors(IResolvable value) `AWS::QuickSight::Analysis.Errors`.
void	setErrors(List<Object> value) `AWS::QuickSight::Analysis.Errors`.
void	setName(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(List<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(String value) The ARN for the theme to apply to the analysis that you're creating.

Methods inherited from class software.amazon.awscdk.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, getUpdatedProperties, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.constructs.Construct

getNode, isConstruct

Methods inherited from class software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnAnalysis(@NotNull
                                            software.constructs.Construct scope,
                                            @NotNull
                                            String id,
                                            @NotNull
                                            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

@Stability(value=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(value=Stable)
 @NotNull
protected Map<String,Object> renderProperties(@NotNull
                                                                                 Map<String,Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getAttrArn

@Stability(value=Stable)
 @NotNull
public String getAttrArn()

The Amazon Resource Name (ARN) of the analysis.

getAttrCreatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrCreatedTime()

getAttrDataSetArns

@Stability(value=Stable)
 @NotNull
public List<String> getAttrDataSetArns()

The ARNs of the datasets of the analysis.

getAttrLastUpdatedTime

@Stability(value=Stable)
 @NotNull
public String getAttrLastUpdatedTime()

The time that the analysis was last updated.

getAttrSheets

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

getAttrStatus

@Stability(value=Stable)
 @NotNull
public String getAttrStatus()

getCfnProperties

@Stability(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getTags

@Stability(value=Stable)
 @NotNull
public TagManager getTags()

Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.

getAnalysisId

@Stability(value=Stable)
 @NotNull
public String getAnalysisId()

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

setAnalysisId

@Stability(value=Stable)
public void setAnalysisId(@NotNull
                                                   String value)

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

getAwsAccountId

@Stability(value=Stable)
 @NotNull
public String getAwsAccountId()

The ID of the AWS account where you are creating an analysis.

setAwsAccountId

@Stability(value=Stable)
public void setAwsAccountId(@NotNull
                                                     String value)

The ID of the AWS account where you are creating an analysis.

getSourceEntity

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     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

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     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

@Stability(value=Stable)
 @Nullable
public Object getErrors()

`AWS::QuickSight::Analysis.Errors`.

setErrors

@Stability(value=Stable)
public void setErrors(@Nullable
                                               IResolvable value)

`AWS::QuickSight::Analysis.Errors`.

setErrors

@Stability(value=Stable)
public void setErrors(@Nullable
                                               List<Object> value)

`AWS::QuickSight::Analysis.Errors`.

getName

@Stability(value=Stable)
 @Nullable
public String getName()

A descriptive name for the analysis that you're creating.

This name displays for the analysis in the Amazon QuickSight console.

setName

@Stability(value=Stable)
public void setName(@Nullable
                                             String value)

A descriptive name for the analysis that you're creating.

This name displays for the analysis in the Amazon QuickSight console.

getParameters

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   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.

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   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.

getPermissions

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    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

@Stability(value=Stable)
public void setPermissions(@Nullable
                                                    List<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

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setThemeArn(@Nullable
                                                 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.