Class CfnAnalysis

Creates an analysis in Amazon QuickSight.

Inheritance

object

CfnElement

CfnRefElement

CfnResource

CfnAnalysis

Implements

IInspectable

IAnalysisRef

IConstruct

IDependable

IEnvironmentAware

ITaggable

Inherited Members

CfnResource.IsCfnResource(object)

CfnResource.AddDeletionOverride(string)

CfnResource.AddDependency(CfnResource)

CfnResource.AddDependsOn(CfnResource)

CfnResource.AddMetadata(string, object)

CfnResource.AddOverride(string, object)

CfnResource.AddPropertyDeletionOverride(string)

CfnResource.AddPropertyOverride(string, object)

CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)

CfnResource.GetAtt(string, ResolutionTypeHint?)

CfnResource.GetMetadata(string)

CfnResource.ObtainDependencies()

CfnResource.ObtainResourceDependencies()

CfnResource.RemoveDependency(CfnResource)

CfnResource.ReplaceDependency(CfnResource, CfnResource)

CfnResource.ShouldSynthesize()

CfnResource.ToString()

CfnResource.ValidateProperties(object)

CfnResource.CfnOptions

CfnResource.CfnResourceType

CfnResource.Env

CfnResource.UpdatedProperites

CfnResource.UpdatedProperties

CfnRefElement.Ref

CfnElement.IsCfnElement(object)

CfnElement.OverrideLogicalId(string)

CfnElement.With(params IMixin[])

CfnElement.CreationStack

CfnElement.LogicalId

CfnElement.Stack

Namespace: Amazon.CDK.AWS.QuickSight

Assembly: Amazon.CDK.Lib.dll

Syntax (csharp)

public class CfnAnalysis : CfnResource, IInspectable, IAnalysisRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Syntax (vb)

Public Class CfnAnalysis Inherits CfnResource Implements IInspectable, IAnalysisRef, IConstruct, IDependable, IEnvironmentAware, ITaggable

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Synopsis

Constructors

CfnAnalysis(Construct, string, ICfnAnalysisProps)

Create a new AWS::QuickSight::Analysis.

Properties

AnalysisId	The ID for the analysis that you're creating.
AnalysisRef	A reference to a Analysis resource.
AttrArn	The Amazon Resource Name (ARN) of the analysis.
AttrCreatedTime	The time that the analysis was created.
AttrDataSetArns	The ARNs of the datasets of the analysis.
AttrErrors	Creates an analysis in Amazon QuickSight.
AttrLastUpdatedTime	The time that the analysis was last updated.
AttrSheets	Creates an analysis in Amazon QuickSight.
AwsAccountId	The ID of the AWS account where you are creating an analysis.
CFN_RESOURCE_TYPE_NAME	The CloudFormation resource type name for this resource class.
CfnProperties	Creates an analysis in Amazon QuickSight.
Definition	Creates an analysis in Amazon QuickSight.
Errors	Errors associated with the analysis.
FolderArns	Creates an analysis in Amazon QuickSight.
Name	A descriptive name for the analysis that you're creating.
Parameters	The parameter names and override values that you want to use.
Permissions	A structure that describes the principals and the resource-level permissions on an analysis.
Sheets	A list of the associated sheets with the unique identifier and name of each sheet.
SourceEntity	A source entity to use for the analysis that you're creating.
Status	Status associated with the analysis.
Tags	Tag Manager which manages the tags for this resource.
TagsRaw	Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
ThemeArn	The ARN for the theme to apply to the analysis that you're creating.
ValidationStrategy	The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

Methods

ArnForAnalysis(IAnalysisRef)	Creates an analysis in Amazon QuickSight.
Inspect(TreeInspector)	Examines the CloudFormation resource and discloses attributes.
IsCfnAnalysis(object)	Checks whether the given object is a CfnAnalysis.
RenderProperties(IDictionary<string, object>)	Creates an analysis in Amazon QuickSight.

Constructors

CfnAnalysis(Construct, string, ICfnAnalysisProps)

Create a new AWS::QuickSight::Analysis.

public CfnAnalysis(Construct scope, string id, ICfnAnalysisProps props)

Parameters

scope Construct: Scope in which this resource is defined.
id string: Construct identifier for this resource (unique in its scope).
props ICfnAnalysisProps: Resource properties.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Properties

AnalysisId

The ID for the analysis that you're creating.

public virtual string AnalysisId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

AnalysisRef

A reference to a Analysis resource.

public virtual IAnalysisReference AnalysisRef { get; }

Property Value

IAnalysisReference

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

AttrArn

The Amazon Resource Name (ARN) of the analysis.

public virtual string AttrArn { get; }

Property Value

string

Remarks

CloudformationAttribute: Arn

AttrCreatedTime

The time that the analysis was created.

public virtual string AttrCreatedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: CreatedTime

AttrDataSetArns

The ARNs of the datasets of the analysis.

public virtual string[] AttrDataSetArns { get; }

Property Value

string[]

Remarks

CloudformationAttribute: DataSetArns

AttrErrors

Creates an analysis in Amazon QuickSight.

public virtual IResolvable AttrErrors { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Errors

AttrLastUpdatedTime

The time that the analysis was last updated.

public virtual string AttrLastUpdatedTime { get; }

Property Value

string

Remarks

CloudformationAttribute: LastUpdatedTime

AttrSheets

Creates an analysis in Amazon QuickSight.

public virtual IResolvable AttrSheets { get; }

Property Value

IResolvable

Remarks

CloudformationAttribute: Sheets

AwsAccountId

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

public virtual string AwsAccountId { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

public static string CFN_RESOURCE_TYPE_NAME { get; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

CfnProperties

Creates an analysis in Amazon QuickSight.

protected override IDictionary<string, object> CfnProperties { get; }

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Definition

Creates an analysis in Amazon QuickSight.

public virtual object? Definition { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAnalysis.IAnalysisDefinitionProperty

Errors

Errors associated with the analysis.

public virtual object? Errors { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAnalysis.IAnalysisErrorProperty)[]

FolderArns

Creates an analysis in Amazon QuickSight.

public virtual string[]? FolderArns { get; set; }

Property Value

string[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Name

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

public virtual string Name { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Parameters

The parameter names and override values that you want to use.

public virtual object? Parameters { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAnalysis.IParametersProperty

Permissions

A structure that describes the principals and the resource-level permissions on an analysis.

public virtual object? Permissions { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAnalysis.IResourcePermissionProperty)[]

Sheets

A list of the associated sheets with the unique identifier and name of each sheet.

public virtual object? Sheets { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or (either IResolvable or CfnAnalysis.ISheetProperty)[]

SourceEntity

A source entity to use for the analysis that you're creating.

public virtual object? SourceEntity { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAnalysis.IAnalysisSourceEntityProperty

Status

Status associated with the analysis.

public virtual string? Status { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

TagsRaw

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

public virtual ICfnTag[]? TagsRaw { get; set; }

Property Value

ICfnTag[]

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

ThemeArn

The ARN for the theme to apply to the analysis that you're creating.

public virtual string? ThemeArn { get; set; }

Property Value

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

ValidationStrategy

The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.

public virtual object? ValidationStrategy { get; set; }

Property Value

object

Remarks

Type union: either IResolvable or CfnAnalysis.IValidationStrategyProperty

Methods

ArnForAnalysis(IAnalysisRef)

Creates an analysis in Amazon QuickSight.

public static string ArnForAnalysis(IAnalysisRef resource)

Parameters

resource IAnalysisRef

Returns

string

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Inspect(TreeInspector)

Examines the CloudFormation resource and discloses attributes.

public virtual void Inspect(TreeInspector inspector)

Parameters

inspector TreeInspector: tree inspector to collect and process attributes.

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

IsCfnAnalysis(object)

Checks whether the given object is a CfnAnalysis.

public static bool IsCfnAnalysis(object x)

Parameters

x object

Returns

bool

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

RenderProperties(IDictionary<string, object>)

Creates an analysis in Amazon QuickSight.

protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)

Parameters

props IDictionary<string, object>

Returns

IDictionary<string, object>

Overrides

CfnResource.RenderProperties(IDictionary<string, object>)

Remarks

See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html

CloudformationResource: AWS::QuickSight::Analysis

ExampleMetadata: fixture=_generated

Implements

IInspectable

IAnalysisRef

Constructs.IConstruct

Constructs.IDependable

IEnvironmentAware

ITaggable