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.47.0 (build 86d2c33)",
           date="2021-12-22T10:27:18.760Z")
 @Stability(value=Stable)
public interface CfnAnalysisProps
extends software.amazon.jsii.JsiiSerializable

Properties for defining a `AWS::QuickSight::Analysis`.

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() `AWS::QuickSight::Analysis.AnalysisId`.
String	getAwsAccountId() `AWS::QuickSight::Analysis.AwsAccountId`.
default Object	getErrors() `AWS::QuickSight::Analysis.Errors`.
default String	getName() `AWS::QuickSight::Analysis.Name`.
default Object	getParameters() `AWS::QuickSight::Analysis.Parameters`.
default Object	getPermissions() `AWS::QuickSight::Analysis.Permissions`.
Object	getSourceEntity() `AWS::QuickSight::Analysis.SourceEntity`.
default List<CfnTag>	getTags() `AWS::QuickSight::Analysis.Tags`.
default String	getThemeArn() `AWS::QuickSight::Analysis.ThemeArn`.

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Method Detail

getAnalysisId

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

`AWS::QuickSight::Analysis.AnalysisId`.

getAwsAccountId

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

`AWS::QuickSight::Analysis.AwsAccountId`.

getErrors

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

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

getName

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

`AWS::QuickSight::Analysis.Name`.

getParameters

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

`AWS::QuickSight::Analysis.Parameters`.

getPermissions

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

`AWS::QuickSight::Analysis.Permissions`.

getSourceEntity

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

`AWS::QuickSight::Analysis.SourceEntity`.

getTags

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

`AWS::QuickSight::Analysis.Tags`.

getThemeArn

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

`AWS::QuickSight::Analysis.ThemeArn`.

builder

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

Returns:

a CfnAnalysisProps.Builder of CfnAnalysisProps