Class CfnAnalysis
Creates an analysis in Amazon QuickSight.
Inherited Members
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnAnalysis : CfnResource, IInspectable, ITaggable
Syntax (vb)
Public Class CfnAnalysis
Inherits CfnResource
Implements IInspectable, 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(ByRefValue) | Used by jsii to construct an instance of this class from a Javascript-owned object reference |
CfnAnalysis(DeputyBase.DeputyProps) | Used by jsii to construct an instance of this class from DeputyProps |
CfnAnalysis(Construct, String, ICfnAnalysisProps) |
Properties
AnalysisId | The ID for the analysis that you're creating. |
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 | |
AttrLastUpdatedTime | The time that the analysis was last updated. |
AttrSheets | |
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 | |
Definition | |
Errors | Errors associated with the analysis. |
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
Inspect(TreeInspector) | Examines the CloudFormation resource and discloses attributes. |
RenderProperties(IDictionary<String, Object>) |
Constructors
CfnAnalysis(ByRefValue)
Used by jsii to construct an instance of this class from a Javascript-owned object reference
protected CfnAnalysis(ByRefValue reference)
Parameters
- reference Amazon.JSII.Runtime.Deputy.ByRefValue
The Javascript-owned object reference
CfnAnalysis(DeputyBase.DeputyProps)
Used by jsii to construct an instance of this class from DeputyProps
protected CfnAnalysis(DeputyBase.DeputyProps props)
Parameters
- props Amazon.JSII.Runtime.Deputy.DeputyBase.DeputyProps
The deputy props
CfnAnalysis(Construct, String, ICfnAnalysisProps)
public CfnAnalysis(Construct scope, string id, ICfnAnalysisProps props)
Parameters
- scope Constructs.Construct
Scope in which this resource is defined.
- id System.String
Construct identifier for this resource (unique in its scope).
- props ICfnAnalysisProps
Resource properties.
Properties
AnalysisId
The ID for the analysis that you're creating.
public virtual string AnalysisId { get; set; }
Property Value
System.String
AttrArn
The Amazon Resource Name (ARN) of the analysis.
public virtual string AttrArn { get; }
Property Value
System.String
Remarks
CloudformationAttribute: Arn
AttrCreatedTime
The time that the analysis was created.
public virtual string AttrCreatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: CreatedTime
AttrDataSetArns
The ARNs of the datasets of the analysis.
public virtual string[] AttrDataSetArns { get; }
Property Value
System.String[]
Remarks
CloudformationAttribute: DataSetArns
AttrErrors
public virtual IResolvable AttrErrors { get; }
Property Value
Remarks
CloudformationAttribute: Errors
AttrLastUpdatedTime
The time that the analysis was last updated.
public virtual string AttrLastUpdatedTime { get; }
Property Value
System.String
Remarks
CloudformationAttribute: LastUpdatedTime
AttrSheets
public virtual IResolvable AttrSheets { get; }
Property Value
Remarks
CloudformationAttribute: Sheets
AwsAccountId
The ID of the AWS account where you are creating an analysis.
public virtual string AwsAccountId { get; set; }
Property Value
System.String
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
public static string CFN_RESOURCE_TYPE_NAME { get; }
Property Value
System.String
CfnProperties
protected override IDictionary<string, object> CfnProperties { get; }
Property Value
System.Collections.Generic.IDictionary<System.String, System.Object>
Overrides
Definition
public virtual object Definition { get; set; }
Property Value
System.Object
Errors
Errors associated with the analysis.
public virtual object Errors { get; set; }
Property Value
System.Object
Name
A descriptive name for the analysis that you're creating.
public virtual string Name { get; set; }
Property Value
System.String
Parameters
The parameter names and override values that you want to use.
public virtual object Parameters { get; set; }
Property Value
System.Object
Permissions
A structure that describes the principals and the resource-level permissions on an analysis.
public virtual object Permissions { get; set; }
Property Value
System.Object
Sheets
A list of the associated sheets with the unique identifier and name of each sheet.
public virtual object Sheets { get; set; }
Property Value
System.Object
SourceEntity
A source entity to use for the analysis that you're creating.
public virtual object SourceEntity { get; set; }
Property Value
System.Object
Status
Status associated with the analysis.
public virtual string Status { get; set; }
Property Value
System.String
Tags
Tag Manager which manages the tags for this resource.
public virtual TagManager Tags { get; }
Property Value
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[]
ThemeArn
The ARN for the theme to apply to the analysis that you're creating.
public virtual string ThemeArn { get; set; }
Property Value
System.String
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
System.Object
Methods
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.
RenderProperties(IDictionary<String, Object>)
protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
Parameters
- props System.Collections.Generic.IDictionary<System.String, System.Object>
Returns
System.Collections.Generic.IDictionary<System.String, System.Object>