Skip to content
v2.276.0

CfnDataProtectionSettingsProps Struct ​

Properties for defining a CfnDataProtectionSettings.

Example ​

ts
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import { aws_workspacesweb as workspacesweb } from 'aws-cdk-lib';
const cfnDataProtectionSettingsProps: workspacesweb.CfnDataProtectionSettingsProps = {
  additionalEncryptionContext: {
    additionalEncryptionContextKey: 'additionalEncryptionContext',
  },
  customerManagedKey: 'customerManagedKey',
  description: 'description',
  displayName: 'displayName',
  inlineRedactionConfiguration: {
    inlineRedactionPatterns: [{
      redactionPlaceHolder: {
        redactionPlaceHolderType: 'redactionPlaceHolderType',

        // the properties below are optional
        redactionPlaceHolderText: 'redactionPlaceHolderText',
      },

      // the properties below are optional
      builtInPatternId: 'builtInPatternId',
      confidenceLevel: 123,
      customPattern: {
        patternName: 'patternName',
        patternRegex: 'patternRegex',

        // the properties below are optional
        keywordRegex: 'keywordRegex',
        patternDescription: 'patternDescription',
      },
      enforcedUrls: ['enforcedUrls'],
      exemptUrls: ['exemptUrls'],
    }],

    // the properties below are optional
    globalConfidenceLevel: 123,
    globalEnforcedUrls: ['globalEnforcedUrls'],
    globalExemptUrls: ['globalExemptUrls'],
  },
  tags: [{
    key: 'key',
    value: 'value',
  }],
};
python
from aws_cdk import CfnTag
# The code below shows an example of how to instantiate this type.
# The values are placeholders you should change.
from aws_cdk import aws_workspacesweb as workspacesweb

cfn_data_protection_settings_props = workspacesweb.CfnDataProtectionSettingsProps(
    additional_encryption_context={
        "additional_encryption_context_key": "additionalEncryptionContext"
    },
    customer_managed_key="customerManagedKey",
    description="description",
    display_name="displayName",
    inline_redaction_configuration=workspacesweb.CfnDataProtectionSettings.InlineRedactionConfigurationProperty(
        inline_redaction_patterns=[workspacesweb.CfnDataProtectionSettings.InlineRedactionPatternProperty(
            redaction_place_holder=workspacesweb.CfnDataProtectionSettings.RedactionPlaceHolderProperty(
                redaction_place_holder_type="redactionPlaceHolderType",

                # the properties below are optional
                redaction_place_holder_text="redactionPlaceHolderText"
            ),

            # the properties below are optional
            built_in_pattern_id="builtInPatternId",
            confidence_level=123,
            custom_pattern=workspacesweb.CfnDataProtectionSettings.CustomPatternProperty(
                pattern_name="patternName",
                pattern_regex="patternRegex",

                # the properties below are optional
                keyword_regex="keywordRegex",
                pattern_description="patternDescription"
            ),
            enforced_urls=["enforcedUrls"],
            exempt_urls=["exemptUrls"]
        )],

        # the properties below are optional
        global_confidence_level=123,
        global_enforced_urls=["globalEnforcedUrls"],
        global_exempt_urls=["globalExemptUrls"]
    ),
    tags=[CfnTag(
        key="key",
        value="value"
    )]
)
java
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import software.amazon.awscdk.services.workspacesweb.*;

CfnDataProtectionSettingsProps cfnDataProtectionSettingsProps = CfnDataProtectionSettingsProps.builder()
        .additionalEncryptionContext(Map.of(
                "additionalEncryptionContextKey", "additionalEncryptionContext"))
        .customerManagedKey("customerManagedKey")
        .description("description")
        .displayName("displayName")
        .inlineRedactionConfiguration(InlineRedactionConfigurationProperty.builder()
                .inlineRedactionPatterns(List.of(InlineRedactionPatternProperty.builder()
                        .redactionPlaceHolder(RedactionPlaceHolderProperty.builder()
                                .redactionPlaceHolderType("redactionPlaceHolderType")

                                // the properties below are optional
                                .redactionPlaceHolderText("redactionPlaceHolderText")
                                .build())

                        // the properties below are optional
                        .builtInPatternId("builtInPatternId")
                        .confidenceLevel(123)
                        .customPattern(CustomPatternProperty.builder()
                                .patternName("patternName")
                                .patternRegex("patternRegex")

                                // the properties below are optional
                                .keywordRegex("keywordRegex")
                                .patternDescription("patternDescription")
                                .build())
                        .enforcedUrls(List.of("enforcedUrls"))
                        .exemptUrls(List.of("exemptUrls"))
                        .build()))

                // the properties below are optional
                .globalConfidenceLevel(123)
                .globalEnforcedUrls(List.of("globalEnforcedUrls"))
                .globalExemptUrls(List.of("globalExemptUrls"))
                .build())
        .tags(List.of(CfnTag.builder()
                .key("key")
                .value("value")
                .build()))
        .build();
csharp
// Install: dotnet add package Amazon.CDK.Lib
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
using Amazon.CDK.AWS.WorkSpacesWeb;

var cfnDataProtectionSettingsProps = new CfnDataProtectionSettingsProps {
    AdditionalEncryptionContext = new Dictionary<string, string> {
        { "additionalEncryptionContextKey", "additionalEncryptionContext" }
    },
    CustomerManagedKey = "customerManagedKey",
    Description = "description",
    DisplayName = "displayName",
    InlineRedactionConfiguration = new InlineRedactionConfigurationProperty {
        InlineRedactionPatterns = new [] { new InlineRedactionPatternProperty {
            RedactionPlaceHolder = new RedactionPlaceHolderProperty {
                RedactionPlaceHolderType = "redactionPlaceHolderType",

                // the properties below are optional
                RedactionPlaceHolderText = "redactionPlaceHolderText"
            },

            // the properties below are optional
            BuiltInPatternId = "builtInPatternId",
            ConfidenceLevel = 123,
            CustomPattern = new CustomPatternProperty {
                PatternName = "patternName",
                PatternRegex = "patternRegex",

                // the properties below are optional
                KeywordRegex = "keywordRegex",
                PatternDescription = "patternDescription"
            },
            EnforcedUrls = new [] { "enforcedUrls" },
            ExemptUrls = new [] { "exemptUrls" }
        } },

        // the properties below are optional
        GlobalConfidenceLevel = 123,
        GlobalEnforcedUrls = new [] { "globalEnforcedUrls" },
        GlobalExemptUrls = new [] { "globalExemptUrls" }
    },
    Tags = new [] { new CfnTag {
        Key = "key",
        Value = "value"
    } }
};
go
// Install: go get github.com/aws/aws-cdk-go/awscdk/v2
// The code below shows an example of how to instantiate this type.
// The values are placeholders you should change.
import "github.com/aws/aws-cdk-go/awscdk"

cfnDataProtectionSettingsProps := &CfnDataProtectionSettingsProps{
	AdditionalEncryptionContext: map[string]*string{
		"additionalEncryptionContextKey": jsii.String("additionalEncryptionContext"),
	},
	CustomerManagedKey: jsii.String("customerManagedKey"),
	Description: jsii.String("description"),
	DisplayName: jsii.String("displayName"),
	InlineRedactionConfiguration: &InlineRedactionConfigurationProperty{
		InlineRedactionPatterns: []interface{}{
			&InlineRedactionPatternProperty{
				RedactionPlaceHolder: &RedactionPlaceHolderProperty{
					RedactionPlaceHolderType: jsii.String("redactionPlaceHolderType"),

					// the properties below are optional
					RedactionPlaceHolderText: jsii.String("redactionPlaceHolderText"),
				},

				// the properties below are optional
				BuiltInPatternId: jsii.String("builtInPatternId"),
				ConfidenceLevel: jsii.Number(123),
				CustomPattern: &CustomPatternProperty{
					PatternName: jsii.String("patternName"),
					PatternRegex: jsii.String("patternRegex"),

					// the properties below are optional
					KeywordRegex: jsii.String("keywordRegex"),
					PatternDescription: jsii.String("patternDescription"),
				},
				EnforcedUrls: []*string{
					jsii.String("enforcedUrls"),
				},
				ExemptUrls: []*string{
					jsii.String("exemptUrls"),
				},
			},
		},

		// the properties below are optional
		GlobalConfidenceLevel: jsii.Number(123),
		GlobalEnforcedUrls: []*string{
			jsii.String("globalEnforcedUrls"),
		},
		GlobalExemptUrls: []*string{
			jsii.String("globalExemptUrls"),
		},
	},
	Tags: []CfnTag{
		&CfnTag{
			Key: jsii.String("key"),
			Value: jsii.String("value"),
		},
	},
}

Properties ​

additionalEncryptionContextoptionalIResolvable | { [key: string]: string }additional_encryption_contextoptionaltyping.Union[IResolvable, typing.Mapping[str, str]]additionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalIResolvableAdditionalEncryptionContextoptionalinterface{}#
The additional encryption context of the data protection settings.
customerManagedKeyoptionalstringcustomer_managed_keyoptionalstrcustomerManagedKeyoptionalStringCustomerManagedKeyoptionalstringCustomerManagedKeyoptional*string#
The customer managed key used to encrypt sensitive information in the data protection settings.
descriptionoptionalstringdescriptionoptionalstrdescriptionoptionalStringDescriptionoptionalstringDescriptionoptional*string#
The description of the data protection settings.
displayNameoptionalstringdisplay_nameoptionalstrdisplayNameoptionalStringDisplayNameoptionalstringDisplayNameoptional*string#
The display name of the data protection settings.
inlineRedactionConfigurationoptionalIResolvable | CfnDataProtectionSettings.InlineRedactionConfigurationPropertyinline_redaction_configurationoptionaltyping.Union[IResolvable, InlineRedactionConfigurationProperty]inlineRedactionConfigurationoptionalIResolvableInlineRedactionConfigurationoptionalIResolvableInlineRedactionConfigurationoptionalinterface{}#
The inline redaction configuration for the data protection settings.
tagsoptionalCfnTag[]tagsoptionaltyping.List[CfnTag]tagsoptionalList<CfnTag>TagsoptionalCfnTag[]Tagsoptional*[]CfnTag#
The tags of the data protection settings.