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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.758Z")
 @Stability(value=Stable)
public class CfnAnalysis
extends CfnResource
implements IInspectable

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

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 Example:
static interface	CfnAnalysis.AnalysisSourceEntityProperty Example:
static interface	CfnAnalysis.AnalysisSourceTemplateProperty Example:
static class	CfnAnalysis.Builder A fluent builder for CfnAnalysis.
static interface	CfnAnalysis.DataSetReferenceProperty Example:
static interface	CfnAnalysis.DateTimeParameterProperty Example:
static interface	CfnAnalysis.DecimalParameterProperty Example:
static interface	CfnAnalysis.IntegerParameterProperty Example:
static interface	CfnAnalysis.ParametersProperty Example:
static interface	CfnAnalysis.ResourcePermissionProperty Example:
static interface	CfnAnalysis.SheetProperty Example:
static interface	CfnAnalysis.StringParameterProperty Example:

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() `AWS::QuickSight::Analysis.AnalysisId`.
String	getAttrArn()
String	getAttrCreatedTime()
List<String>	getAttrDataSetArns()
String	getAttrLastUpdatedTime()
IResolvable	getAttrSheets()
String	getAttrStatus()
String	getAwsAccountId() `AWS::QuickSight::Analysis.AwsAccountId`.
protected Map<String,Object>	getCfnProperties()
Object	getErrors() `AWS::QuickSight::Analysis.Errors`.
String	getName() `AWS::QuickSight::Analysis.Name`.
Object	getParameters() `AWS::QuickSight::Analysis.Parameters`.
Object	getPermissions() `AWS::QuickSight::Analysis.Permissions`.
Object	getSourceEntity() `AWS::QuickSight::Analysis.SourceEntity`.
TagManager	getTags() `AWS::QuickSight::Analysis.Tags`.
String	getThemeArn() `AWS::QuickSight::Analysis.ThemeArn`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAnalysisId(String value) `AWS::QuickSight::Analysis.AnalysisId`.
void	setAwsAccountId(String value) `AWS::QuickSight::Analysis.AwsAccountId`.
void	setErrors(IResolvable value) `AWS::QuickSight::Analysis.Errors`.
void	setErrors(List<Object> value) `AWS::QuickSight::Analysis.Errors`.
void	setName(String value) `AWS::QuickSight::Analysis.Name`.
void	setParameters(CfnAnalysis.ParametersProperty value) `AWS::QuickSight::Analysis.Parameters`.
void	setParameters(IResolvable value) `AWS::QuickSight::Analysis.Parameters`.
void	setPermissions(IResolvable value) `AWS::QuickSight::Analysis.Permissions`.
void	setPermissions(List<Object> value) `AWS::QuickSight::Analysis.Permissions`.
void	setSourceEntity(CfnAnalysis.AnalysisSourceEntityProperty value) `AWS::QuickSight::Analysis.SourceEntity`.
void	setSourceEntity(IResolvable value) `AWS::QuickSight::Analysis.SourceEntity`.
void	setThemeArn(String value) `AWS::QuickSight::Analysis.ThemeArn`.

Methods inherited from class software.amazon.awscdk.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.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.

getAnalysisId

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

`AWS::QuickSight::Analysis.AnalysisId`.

setAnalysisId

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

`AWS::QuickSight::Analysis.AnalysisId`.

getAttrArn

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

getAttrCreatedTime

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

getAttrDataSetArns

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

getAttrLastUpdatedTime

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

getAttrSheets

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

getAttrStatus

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

getAwsAccountId

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

`AWS::QuickSight::Analysis.AwsAccountId`.

setAwsAccountId

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

`AWS::QuickSight::Analysis.AwsAccountId`.

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

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()

`AWS::QuickSight::Analysis.Name`.

setName

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

`AWS::QuickSight::Analysis.Name`.

getParameters

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

`AWS::QuickSight::Analysis.Parameters`.

setParameters

@Stability(value=Stable)
public void setParameters(@Nullable
                                                   CfnAnalysis.ParametersProperty value)

`AWS::QuickSight::Analysis.Parameters`.

setParameters

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

`AWS::QuickSight::Analysis.Parameters`.

getPermissions

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

`AWS::QuickSight::Analysis.Permissions`.

setPermissions

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

`AWS::QuickSight::Analysis.Permissions`.

setPermissions

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

`AWS::QuickSight::Analysis.Permissions`.

getSourceEntity

@Stability(value=Stable)
 @NotNull
public Object getSourceEntity()

`AWS::QuickSight::Analysis.SourceEntity`.

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     CfnAnalysis.AnalysisSourceEntityProperty value)

`AWS::QuickSight::Analysis.SourceEntity`.

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@NotNull
                                                     IResolvable value)

`AWS::QuickSight::Analysis.SourceEntity`.

getTags

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

`AWS::QuickSight::Analysis.Tags`.

getThemeArn

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

`AWS::QuickSight::Analysis.ThemeArn`.

setThemeArn

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

`AWS::QuickSight::Analysis.ThemeArn`.