Package software.amazon.awscdk.services.quicksight

Class CfnCustomization

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.quicksight.CfnCustomization
All Implemented Interfaces:
IInspectable, IEnvironmentAware, ICustomizationRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.140.0 (build 79fd58c)", date="2026-09-30T11:04:57.884Z") @Stability(Stable) public class CfnCustomization extends CfnResource implements IInspectable, ICustomizationRef, ITaggableV2
Definition of the AWS::QuickSight::Customization Resource Type.

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.*;
 CfnCustomization cfnCustomization = CfnCustomization.Builder.create(this, "MyCfnCustomization")
         .defaultTheme("defaultTheme")
         .namespace("namespace")
         // the properties below are optional
         .tags(List.of(CfnTag.builder()
                 .key("key")
                 .value("value")
                 .build()))
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnCustomization

      protected CfnCustomization(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnCustomization

      protected CfnCustomization(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnCustomization

      @Stability(Stable) public CfnCustomization(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnCustomizationProps props)
      Create a new AWS::QuickSight::Customization.

      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • arnForCustomization

      @Stability(Stable) @NotNull public static String arnForCustomization(@NotNull ICustomizationRef resource)
      Parameters:
      resource - This parameter is required.

    • isCfnCustomization

      @Stability(Stable) @NotNull public static Boolean isCfnCustomization(@NotNull Object x)
      Checks whether the given object is a CfnCustomization.

      Parameters:
      x - This parameter is required.

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getAttrArn

      @Stability(Stable) @NotNull public String getAttrArn()
      The Amazon Resource Name of the namespace-scoped account customization, arn:{Partition}:quicksight:{Region}:{AccountId}:customization/namespace/{Namespace}.

      Returned by the service and used as the primary identifier.

    • getAttrAwsAccountId

      @Stability(Stable) @NotNull public String getAttrAwsAccountId()
      The AWS account that owns the customization.

      Supplied by CloudFormation from the invoking account rather than by the template, so it is read-only.

    • getCdkTagManager

      @Stability(Stable) @NotNull public TagManager getCdkTagManager()
      Tag Manager which manages the tags for this resource.
      Specified by:
      getCdkTagManager in interface ITaggableV2

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getCfnPropertyNames

      @Stability(Stable) @NotNull protected Map<String,String> getCfnPropertyNames()
      Overrides:
      getCfnPropertyNames in class CfnResource

    • getCustomizationRef

      @Stability(Stable) @NotNull public CustomizationReference getCustomizationRef()
      A reference to a Customization resource.
      Specified by:
      getCustomizationRef in interface ICustomizationRef

    • getDefaultTheme

      @Stability(Stable) @NotNull public String getDefaultTheme()
      The ARN of the theme applied by default in the QuickSight console for this namespace.

    • setDefaultTheme

      @Stability(Stable) public void setDefaultTheme(@NotNull String value)
      The ARN of the theme applied by default in the QuickSight console for this namespace.

    • getNamespace

      @Stability(Stable) @NotNull public String getNamespace()
      The QuickSight namespace the customization applies to.

    • setNamespace

      @Stability(Stable) public void setNamespace(@NotNull String value)
      The QuickSight namespace the customization applies to.

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()
      Tags applied to the customization.

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)
      Tags applied to the customization.