Package software.amazon.awscdk.services.quicksight

Class CfnDLPSetting

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.CfnDLPSetting
All Implemented Interfaces:
IInspectable, IEnvironmentAware, IDLPSettingRef, ITaggableV2, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.139.0 (build 26a6b54)", date="2026-09-02T11:03:15.812Z") @Stability(Stable) public class CfnDLPSetting extends CfnResource implements IInspectable, IDLPSettingRef, ITaggableV2
Definition of the AWS::QuickSight::DLPSetting 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.*;
 CfnDLPSetting cfnDLPSetting = CfnDLPSetting.Builder.create(this, "MyCfnDLPSetting")
         .dlpSettingId("dlpSettingId")
         .enabled(false)
         .name("name")
         .providerConfig(ProviderConfigProperty.builder()
                 .microsoftPurview(MicrosoftPurviewProviderConfigProperty.builder()
                         .credentials(MicrosoftPurviewCredentialsProperty.builder()
                                 .secretArn("secretArn")
                                 .build())
                         .labelActionMappings(List.of(LabelActionMappingProperty.builder()
                                 .action("action")
                                 .labelId("labelId")
                                 .labelName("labelName")
                                 .build()))
                         .unmappedAction("unmappedAction")
                         .build())
                 .build())
         .providerOutageAction("providerOutageAction")
         .providerType("providerType")
         // the properties below are optional
         .awsAccountId("awsAccountId")
         .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

    • CfnDLPSetting

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

    • CfnDLPSetting

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

    • CfnDLPSetting

      @Stability(Stable) public CfnDLPSetting(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnDLPSettingProps props)
      Create a new AWS::QuickSight::DLPSetting.

      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

    • arnForDLPSetting

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

    • isCfnDLPSetting

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

      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()

    • getAttrCreatedAt

      @Stability(Stable) @NotNull public String getAttrCreatedAt()

    • getAttrStatus

      @Stability(Stable) @NotNull public String getAttrStatus()

    • getAttrUpdatedAt

      @Stability(Stable) @NotNull public String getAttrUpdatedAt()

    • 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

    • getDlpSettingRef

      @Stability(Stable) @NotNull public DLPSettingReference getDlpSettingRef()
      A reference to a DLPSetting resource.
      Specified by:
      getDlpSettingRef in interface IDLPSettingRef

    • getDlpSettingId

      @Stability(Stable) @NotNull public String getDlpSettingId()

    • setDlpSettingId

      @Stability(Stable) public void setDlpSettingId(@NotNull String value)

    • getEnabled

      @Stability(Stable) @NotNull public Object getEnabled()
      Returns union: either Boolean or IResolvable

    • setEnabled

      @Stability(Stable) public void setEnabled(@NotNull Boolean value)

    • setEnabled

      @Stability(Stable) public void setEnabled(@NotNull IResolvable value)

    • getName

      @Stability(Stable) @NotNull public String getName()

    • setName

      @Stability(Stable) public void setName(@NotNull String value)

    • getProviderConfig

      @Stability(Stable) @NotNull public Object getProviderConfig()
      Returns union: either IResolvable or CfnDLPSetting.ProviderConfigProperty

    • setProviderConfig

      @Stability(Stable) public void setProviderConfig(@NotNull IResolvable value)

    • setProviderConfig

      @Stability(Stable) public void setProviderConfig(@NotNull CfnDLPSetting.ProviderConfigProperty value)

    • getProviderOutageAction

      @Stability(Stable) @NotNull public String getProviderOutageAction()

    • setProviderOutageAction

      @Stability(Stable) public void setProviderOutageAction(@NotNull String value)

    • getProviderType

      @Stability(Stable) @NotNull public String getProviderType()

    • setProviderType

      @Stability(Stable) public void setProviderType(@NotNull String value)

    • getAwsAccountId

      @Stability(Stable) @Nullable public String getAwsAccountId()

    • setAwsAccountId

      @Stability(Stable) public void setAwsAccountId(@Nullable String value)

    • getTags

      @Stability(Stable) @Nullable public List<CfnTag> getTags()

    • setTags

      @Stability(Stable) public void setTags(@Nullable List<CfnTag> value)