software.amazon.awscdk.services.quicksight

Interface CfnAnalysisProps

All Known Implementing Classes:

CfnAnalysisProps.Jsii$Proxy

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:39.382Z")
public interface CfnAnalysisProps

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

Method Detail

getAnalysisId

java.lang.String getAnalysisId()

The ID for the analysis that you're creating.

This ID displays in the URL of the analysis.

getAwsAccountId

java.lang.String getAwsAccountId()

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

getSourceEntity

java.lang.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.

Either a SourceEntity or a Definition must be provided in order for the request to be valid.

getErrors

default java.lang.Object getErrors()

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

getName

default java.lang.String getName()

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

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

getParameters

default java.lang.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

default java.lang.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

default java.util.List<CfnTag> getTags()

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

getThemeArn

default java.lang.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

static CfnAnalysisProps.Builder builder()

Returns:

a CfnAnalysisProps.Builder of CfnAnalysisProps