Package com.pulumi.aws.workspacesweb
Class DataProtectionSettings
- java.lang.Object
-
- com.pulumi.resources.Resource
-
- com.pulumi.resources.CustomResource
-
- com.pulumi.aws.workspacesweb.DataProtectionSettings
-
public class DataProtectionSettings extends com.pulumi.resources.CustomResourceResource for managing an AWS WorkSpaces Web Data Protection Settings resource. Once associated with a web portal, data protection settings control how sensitive information is redacted in streaming sessions. ## Example Usage ### Basic Usage
### With Inline Redaction Configurationpackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.workspacesweb.DataProtectionSettings; import com.pulumi.aws.workspacesweb.DataProtectionSettingsArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new DataProtectionSettings("example", DataProtectionSettingsArgs.builder() .displayName("example") .build()); } }
### Complete Examplepackage generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.workspacesweb.DataProtectionSettings; import com.pulumi.aws.workspacesweb.DataProtectionSettingsArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolderArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new DataProtectionSettings("example", DataProtectionSettingsArgs.builder() .inlineRedactionConfiguration(DataProtectionSettingsInlineRedactionConfigurationArgs.builder() .inlineRedactionPatterns(DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternArgs.builder() .redactionPlaceHolders(DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolderArgs.builder() .redactionPlaceHolderType("CustomText") .redactionPlaceHolderText("REDACTED") .build()) .builtInPatternId("ssn") .confidenceLevel(3) .build()) .globalConfidenceLevel(2) .globalEnforcedUrls("https://example.com") .build()) .displayName("example") .description("Example data protection settings") .build()); } }
## Import Using `pulumi import`, import WorkSpaces Web Data Protection Settings using the `dataProtectionSettingsArn`. For example: ```sh $ pulumi import aws:workspacesweb/dataProtectionSettings:DataProtectionSettings example arn:aws:workspaces-web:us-west-2:123456789012:dataprotectionsettings/abcdef12345 ```package generated_program; import com.pulumi.Context; import com.pulumi.Pulumi; import com.pulumi.core.Output; import com.pulumi.aws.kms.Key; import com.pulumi.aws.kms.KeyArgs; import com.pulumi.aws.workspacesweb.DataProtectionSettings; import com.pulumi.aws.workspacesweb.DataProtectionSettingsArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolderArgs; import com.pulumi.aws.workspacesweb.inputs.DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternCustomPatternArgs; import java.util.ArrayList; import java.util.Arrays; import java.util.Map; import java.io.File; import java.nio.file.Files; import java.nio.file.Paths; public class App { public static void main(String[] args) { Pulumi.run(App::stack); } public static void stack(Context ctx) { var example = new Key("example", KeyArgs.builder() .description("KMS key for WorkSpaces Web Data Protection Settings") .deletionWindowInDays(7) .build()); var exampleDataProtectionSettings = new DataProtectionSettings("exampleDataProtectionSettings", DataProtectionSettingsArgs.builder() .inlineRedactionConfiguration(DataProtectionSettingsInlineRedactionConfigurationArgs.builder() .inlineRedactionPatterns( DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternArgs.builder() .redactionPlaceHolders(DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolderArgs.builder() .redactionPlaceHolderType("CustomText") .redactionPlaceHolderText("REDACTED-SSN") .build()) .builtInPatternId("ssn") .confidenceLevel(3) .enforcedUrls("https://pattern1.example.com") .exemptUrls("https://exempt-pattern1.example.com") .build(), DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternArgs.builder() .customPattern(DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternCustomPatternArgs.builder() .patternName("CustomPattern") .patternRegex("/\\d{3}-\\d{2}-\\d{4}/g") .keywordRegex("/SSN|Social Security/gi") .patternDescription("Custom SSN pattern") .build()) .redactionPlaceHolders(DataProtectionSettingsInlineRedactionConfigurationInlineRedactionPatternRedactionPlaceHolderArgs.builder() .redactionPlaceHolderType("CustomText") .redactionPlaceHolderText("REDACTED-CUSTOM") .build()) .build()) .globalConfidenceLevel(2) .globalEnforcedUrls( "https://example.com", "https://test.example.com") .globalExemptUrls("https://exempt.example.com") .build()) .displayName("example-complete") .description("Complete example data protection settings") .customerManagedKey(example.arn()) .additionalEncryptionContext(Map.of("Environment", "Production")) .tags(Map.of("Name", "example-data-protection-settings")) .build()); } }
-
-
Constructor Summary
Constructors Constructor Description DataProtectionSettings(java.lang.String name)DataProtectionSettings(java.lang.String name, DataProtectionSettingsArgs args)DataProtectionSettings(java.lang.String name, DataProtectionSettingsArgs args, com.pulumi.resources.CustomResourceOptions options)
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>additionalEncryptionContext()com.pulumi.core.Output<java.util.List<java.lang.String>>associatedPortalArns()com.pulumi.core.Output<java.util.Optional<java.lang.String>>customerManagedKey()com.pulumi.core.Output<java.lang.String>dataProtectionSettingsArn()com.pulumi.core.Output<java.util.Optional<java.lang.String>>description()com.pulumi.core.Output<java.lang.String>displayName()static DataProtectionSettingsget(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, DataProtectionSettingsState state, com.pulumi.resources.CustomResourceOptions options)Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.com.pulumi.core.Output<java.util.Optional<DataProtectionSettingsInlineRedactionConfiguration>>inlineRedactionConfiguration()com.pulumi.core.Output<java.lang.String>region()com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>>tags()com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>>tagsAll()
-
-
-
Constructor Detail
-
DataProtectionSettings
public DataProtectionSettings(java.lang.String name)
- Parameters:
name- The _unique_ name of the resulting resource.
-
DataProtectionSettings
public DataProtectionSettings(java.lang.String name, DataProtectionSettingsArgs args)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.
-
DataProtectionSettings
public DataProtectionSettings(java.lang.String name, DataProtectionSettingsArgs args, @Nullable com.pulumi.resources.CustomResourceOptions options)- Parameters:
name- The _unique_ name of the resulting resource.args- The arguments to use to populate this resource's properties.options- A bag of options that control this resource's behavior.
-
-
Method Detail
-
additionalEncryptionContext
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> additionalEncryptionContext()
- Returns:
- Additional encryption context for the data protection settings.
-
associatedPortalArns
public com.pulumi.core.Output<java.util.List<java.lang.String>> associatedPortalArns()
- Returns:
- List of web portal ARNs that this data protection settings resource is associated with.
-
customerManagedKey
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> customerManagedKey()
- Returns:
- ARN of the customer managed KMS key.
-
dataProtectionSettingsArn
public com.pulumi.core.Output<java.lang.String> dataProtectionSettingsArn()
- Returns:
- ARN of the data protection settings resource.
-
description
public com.pulumi.core.Output<java.util.Optional<java.lang.String>> description()
- Returns:
- The description of the data protection settings.
-
displayName
public com.pulumi.core.Output<java.lang.String> displayName()
- Returns:
- The display name of the data protection settings. The following arguments are optional:
-
inlineRedactionConfiguration
public com.pulumi.core.Output<java.util.Optional<DataProtectionSettingsInlineRedactionConfiguration>> inlineRedactionConfiguration()
- Returns:
- The inline redaction configuration of the data protection settings. Detailed below.
-
region
public com.pulumi.core.Output<java.lang.String> region()
- Returns:
- Region where this resource will be [managed](https://docs.aws.amazon.com/general/latest/gr/rande.html#regional-endpoints). Defaults to the Region set in the provider configuration.
-
tags
public com.pulumi.core.Output<java.util.Optional<java.util.Map<java.lang.String,java.lang.String>>> tags()
- Returns:
- Map of tags assigned to the resource. If configured with a provider `defaultTags` configuration block present, tags with matching keys will overwrite those defined at the provider-level.
-
tagsAll
public com.pulumi.core.Output<java.util.Map<java.lang.String,java.lang.String>> tagsAll()
- Returns:
- Map of tags assigned to the resource, including those inherited from the provider `defaultTags` configuration block.
-
get
public static DataProtectionSettings get(java.lang.String name, com.pulumi.core.Output<java.lang.String> id, @Nullable DataProtectionSettingsState state, @Nullable com.pulumi.resources.CustomResourceOptions options)
Get an existing Host resource's state with the given name, ID, and optional extra properties used to qualify the lookup.- Parameters:
name- The _unique_ name of the resulting resource.id- The _unique_ provider ID of the resource to lookup.state-options- Optional settings to control the behavior of the CustomResource.
-
-