software.amazon.awscdk.services.quicksight

Interface CfnAnalysisProps

All Superinterfaces:

software.amazon.jsii.JsiiSerializable

All Known Implementing Classes:

CfnAnalysisProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.63.2 (build a8a8833)",
           date="2022-08-17T17:31:11.749Z")
 @Stability(value=Stable)
public interface CfnAnalysisProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `CfnAnalysis`.

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.*;
 CfnAnalysisProps cfnAnalysisProps = CfnAnalysisProps.builder()
         .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	Interface and Description
static class	CfnAnalysisProps.Builder A builder for CfnAnalysisProps
static class	CfnAnalysisProps.Jsii$Proxy An implementation for CfnAnalysisProps

Method Summary

Modifier and Type	Method and Description
static CfnAnalysisProps.Builder	builder()
String	getAnalysisId() The ID for the analysis that you're creating.
String	getAwsAccountId() The ID of the AWS account where you are creating an analysis.
default Object	getErrors() `AWS::QuickSight::Analysis.Errors`.
default String	getName() A descriptive name for the analysis that you're creating.
default Object	getParameters() The parameter names and override values that you want to use.
default Object	getPermissions() A structure that describes the principals and the resource-level permissions on an analysis.
Object	getSourceEntity() A source entity to use for the analysis that you're creating.
default List<CfnTag>	getTags() Contains a map of the key-value pairs for the resource tag or tags assigned to the analysis.
default String	getThemeArn() The ARN for the theme to apply to the analysis that you're creating.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAnalysisId

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

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

getAwsAccountId

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

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

getSourceEntity

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

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

This metadata structure contains details that describe a source template and one or more datasets.

getErrors

@Stability(value=Stable)
 @Nullable
default Object getErrors()

`AWS::QuickSight::Analysis.Errors`.

getName

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

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

This name displays for the analysis in the Amazon QuickSight console.

getParameters

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

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

An analysis can have any parameter type, and some parameters might accept multiple values.

getPermissions

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

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

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 .

getTags

@Stability(value=Stable)
 @Nullable
default List<CfnTag> getTags()

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

getThemeArn

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

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

To see the theme in the Amazon QuickSight console, make sure that you have access to it.

builder

@Stability(value=Stable)
static CfnAnalysisProps.Builder builder()

Returns:

a CfnAnalysisProps.Builder of CfnAnalysisProps