Interface ICfnAnalysisProps
Properties for defining a CfnAnalysis
.
Namespace: Amazon.CDK.AWS.QuickSight
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public interface ICfnAnalysisProps
Syntax (vb)
Public Interface ICfnAnalysisProps
Remarks
See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-quicksight-analysis.html
ExampleMetadata: fixture=_generated
Synopsis
Properties
AnalysisId | The ID for the analysis that you're creating. |
AwsAccountId | The ID of the AWS account where you are creating an analysis. |
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 | 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. |
Properties
AnalysisId
The ID for the analysis that you're creating.
string AnalysisId { get; }
Property Value
System.String
Remarks
This ID displays in the URL of the analysis.
AwsAccountId
The ID of the AWS account where you are creating an analysis.
string AwsAccountId { get; }
Property Value
System.String
Remarks
Definition
virtual object Definition { get; }
Property Value
System.Object
Remarks
Errors
Errors associated with the analysis.
virtual object Errors { get; }
Property Value
System.Object
Remarks
Name
A descriptive name for the analysis that you're creating.
string Name { get; }
Property Value
System.String
Remarks
This name displays for the analysis in the Amazon QuickSight console.
Parameters
The parameter names and override values that you want to use.
virtual object Parameters { get; }
Property Value
System.Object
Remarks
An analysis can have any parameter type, and some parameters might accept multiple values.
Permissions
A structure that describes the principals and the resource-level permissions on an analysis.
virtual object Permissions { get; }
Property Value
System.Object
Remarks
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
.
Sheets
A list of the associated sheets with the unique identifier and name of each sheet.
virtual object Sheets { get; }
Property Value
System.Object
Remarks
SourceEntity
A source entity to use for the analysis that you're creating.
virtual object SourceEntity { get; }
Property Value
System.Object
Remarks
This metadata structure contains details that describe a source template and one or more datasets.
Either a SourceEntity
or a Definition
must be provided in order for the request to be valid.
Status
Status associated with the analysis.
virtual string Status { get; }
Property Value
System.String
Remarks
Tags
Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
virtual ICfnTag[] Tags { get; }
Property Value
ICfnTag[]
Remarks
ThemeArn
The ARN for the theme to apply to the analysis that you're creating.
virtual string ThemeArn { get; }
Property Value
System.String
Remarks
To see the theme in the Amazon QuickSight console, make sure that you have access to it.
ValidationStrategy
The option to relax the validation that is required to create and update analyses, dashboards, and templates with definition objects.
virtual object ValidationStrategy { get; }
Property Value
System.Object
Remarks
When you set this value to LENIENT
, validation is skipped for specific errors.