software.amazon.awscdk.services.quicksight

Class CfnDashboard

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.CfnDashboard

All Implemented Interfaces:

IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable

@Generated(value="jsii-pacmak/1.29.0 (build 41df200)",
           date="2021-06-02T09:55:31.909Z")
 @Stability(value=Stable)
public class CfnDashboard
extends CfnResource
implements IInspectable

A CloudFormation `AWS::QuickSight::Dashboard`.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	CfnDashboard.AdHocFilteringOptionProperty
static class	CfnDashboard.Builder A fluent builder for CfnDashboard.
static interface	CfnDashboard.DashboardPublishOptionsProperty
static interface	CfnDashboard.DashboardSourceEntityProperty
static interface	CfnDashboard.DashboardSourceTemplateProperty
static interface	CfnDashboard.DataSetReferenceProperty
static interface	CfnDashboard.DateTimeParameterProperty
static interface	CfnDashboard.DecimalParameterProperty
static interface	CfnDashboard.ExportToCSVOptionProperty
static interface	CfnDashboard.IntegerParameterProperty
static interface	CfnDashboard.ParametersProperty
static interface	CfnDashboard.ResourcePermissionProperty
static interface	CfnDashboard.SheetControlsOptionProperty
static interface	CfnDashboard.StringParameterProperty

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
	CfnDashboard(software.constructs.Construct scope, String id, CfnDashboardProps props) Create a new `AWS::QuickSight::Dashboard`.
protected	CfnDashboard(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnDashboard(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
String	getAttrArn()
String	getAttrCreatedTime()
String	getAttrLastPublishedTime()
String	getAttrLastUpdatedTime()
String	getAwsAccountId() `AWS::QuickSight::Dashboard.AwsAccountId`.
protected Map<String,Object>	getCfnProperties()
String	getDashboardId() `AWS::QuickSight::Dashboard.DashboardId`.
Object	getDashboardPublishOptions() `AWS::QuickSight::Dashboard.DashboardPublishOptions`.
String	getName() `AWS::QuickSight::Dashboard.Name`.
Object	getParameters() `AWS::QuickSight::Dashboard.Parameters`.
Object	getPermissions() `AWS::QuickSight::Dashboard.Permissions`.
Object	getSourceEntity() `AWS::QuickSight::Dashboard.SourceEntity`.
TagManager	getTags() `AWS::QuickSight::Dashboard.Tags`.
String	getThemeArn() `AWS::QuickSight::Dashboard.ThemeArn`.
String	getVersionDescription() `AWS::QuickSight::Dashboard.VersionDescription`.
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setAwsAccountId(String value) `AWS::QuickSight::Dashboard.AwsAccountId`.
void	setDashboardId(String value) `AWS::QuickSight::Dashboard.DashboardId`.
void	setDashboardPublishOptions(CfnDashboard.DashboardPublishOptionsProperty value) `AWS::QuickSight::Dashboard.DashboardPublishOptions`.
void	setDashboardPublishOptions(IResolvable value) `AWS::QuickSight::Dashboard.DashboardPublishOptions`.
void	setName(String value) `AWS::QuickSight::Dashboard.Name`.
void	setParameters(CfnDashboard.ParametersProperty value) `AWS::QuickSight::Dashboard.Parameters`.
void	setParameters(IResolvable value) `AWS::QuickSight::Dashboard.Parameters`.
void	setPermissions(IResolvable value) `AWS::QuickSight::Dashboard.Permissions`.
void	setPermissions(List<Object> value) `AWS::QuickSight::Dashboard.Permissions`.
void	setSourceEntity(CfnDashboard.DashboardSourceEntityProperty value) `AWS::QuickSight::Dashboard.SourceEntity`.
void	setSourceEntity(IResolvable value) `AWS::QuickSight::Dashboard.SourceEntity`.
void	setThemeArn(String value) `AWS::QuickSight::Dashboard.ThemeArn`.
void	setVersionDescription(String value) `AWS::QuickSight::Dashboard.VersionDescription`.

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

CfnDashboard

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

CfnDashboard

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

CfnDashboard

@Stability(value=Stable)
public CfnDashboard(@NotNull
                                             software.constructs.Construct scope,
                                             @NotNull
                                             String id,
                                             @NotNull
                                             CfnDashboardProps props)

Create a new `AWS::QuickSight::Dashboard`.

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

getAttrCreatedTime

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

getAttrLastPublishedTime

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

getAttrLastUpdatedTime

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

getCfnProperties

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

Overrides:

getCfnProperties in class CfnResource

getTags

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

`AWS::QuickSight::Dashboard.Tags`.

getAwsAccountId

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

`AWS::QuickSight::Dashboard.AwsAccountId`.

setAwsAccountId

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

`AWS::QuickSight::Dashboard.AwsAccountId`.

getDashboardId

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

`AWS::QuickSight::Dashboard.DashboardId`.

setDashboardId

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

`AWS::QuickSight::Dashboard.DashboardId`.

getDashboardPublishOptions

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

`AWS::QuickSight::Dashboard.DashboardPublishOptions`.

setDashboardPublishOptions

@Stability(value=Stable)
public void setDashboardPublishOptions(@Nullable
                                                                CfnDashboard.DashboardPublishOptionsProperty value)

`AWS::QuickSight::Dashboard.DashboardPublishOptions`.

setDashboardPublishOptions

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

`AWS::QuickSight::Dashboard.DashboardPublishOptions`.

getName

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

`AWS::QuickSight::Dashboard.Name`.

setName

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

`AWS::QuickSight::Dashboard.Name`.

getParameters

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

`AWS::QuickSight::Dashboard.Parameters`.

setParameters

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

`AWS::QuickSight::Dashboard.Parameters`.

setParameters

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

`AWS::QuickSight::Dashboard.Parameters`.

getPermissions

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

`AWS::QuickSight::Dashboard.Permissions`.

setPermissions

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

`AWS::QuickSight::Dashboard.Permissions`.

setPermissions

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

`AWS::QuickSight::Dashboard.Permissions`.

getSourceEntity

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

`AWS::QuickSight::Dashboard.SourceEntity`.

setSourceEntity

@Stability(value=Stable)
public void setSourceEntity(@Nullable
                                                     CfnDashboard.DashboardSourceEntityProperty value)

`AWS::QuickSight::Dashboard.SourceEntity`.

setSourceEntity

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

`AWS::QuickSight::Dashboard.SourceEntity`.

getThemeArn

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

`AWS::QuickSight::Dashboard.ThemeArn`.

setThemeArn

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

`AWS::QuickSight::Dashboard.ThemeArn`.

getVersionDescription

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

`AWS::QuickSight::Dashboard.VersionDescription`.

setVersionDescription

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

`AWS::QuickSight::Dashboard.VersionDescription`.