sensitivedatascannerrule

package
v11.15.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 18, 2024 License: MPL-2.0 Imports: 7 Imported by: 0

README

datadog_sensitive_data_scanner_rule

Refer to the Terraform Registry for docs: datadog_sensitive_data_scanner_rule.

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func NewSensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference_Override added in v11.2.0 

func NewSensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference_Override(s SensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewSensitiveDataScannerRuleTextReplacementOutputReference_Override 

func NewSensitiveDataScannerRuleTextReplacementOutputReference_Override(s SensitiveDataScannerRuleTextReplacementOutputReference, terraformResource cdktf.IInterpolatingParent, terraformAttribute *string)

func NewSensitiveDataScannerRule_Override 

func NewSensitiveDataScannerRule_Override(s SensitiveDataScannerRule, scope constructs.Construct, id *string, config *SensitiveDataScannerRuleConfig)

Create a new {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule datadog_sensitive_data_scanner_rule} Resource.

func SensitiveDataScannerRule_GenerateConfigForImport 

func SensitiveDataScannerRule_GenerateConfigForImport(scope constructs.Construct, importToId *string, importFromId *string, provider cdktf.TerraformProvider) cdktf.ImportableResource

Generates CDKTF code for importing a SensitiveDataScannerRule resource upon running "cdktf plan <stack-name>".

func SensitiveDataScannerRule_IsConstruct 

func SensitiveDataScannerRule_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.

Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.

Returns: true if `x` is an object created from a class which extends `Construct`.

func SensitiveDataScannerRule_IsTerraformElement 

func SensitiveDataScannerRule_IsTerraformElement(x interface{}) *bool

Experimental.

func SensitiveDataScannerRule_IsTerraformResource 

func SensitiveDataScannerRule_IsTerraformResource(x interface{}) *bool

Experimental.

func SensitiveDataScannerRule_TfResourceType 

func SensitiveDataScannerRule_TfResourceType() *string

Types

type SensitiveDataScannerRule 

type SensitiveDataScannerRule interface {
	cdktf.TerraformResource
	// Experimental.
	CdktfStack() cdktf.TerraformStack
	// Experimental.
	Connection() interface{}
	// Experimental.
	SetConnection(val interface{})
	// Experimental.
	ConstructNodeMetadata() *map[string]interface{}
	// Experimental.
	Count() interface{}
	// Experimental.
	SetCount(val interface{})
	// Experimental.
	DependsOn() *[]*string
	// Experimental.
	SetDependsOn(val *[]*string)
	Description() *string
	SetDescription(val *string)
	DescriptionInput() *string
	ExcludedNamespaces() *[]*string
	SetExcludedNamespaces(val *[]*string)
	ExcludedNamespacesInput() *[]*string
	// Experimental.
	ForEach() cdktf.ITerraformIterator
	// Experimental.
	SetForEach(val cdktf.ITerraformIterator)
	// Experimental.
	Fqn() *string
	// Experimental.
	FriendlyUniqueId() *string
	GroupId() *string
	SetGroupId(val *string)
	GroupIdInput() *string
	Id() *string
	SetId(val *string)
	IdInput() *string
	IncludedKeywordConfiguration() SensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference
	IncludedKeywordConfigurationInput() *SensitiveDataScannerRuleIncludedKeywordConfiguration
	IsEnabled() interface{}
	SetIsEnabled(val interface{})
	IsEnabledInput() interface{}
	// Experimental.
	Lifecycle() *cdktf.TerraformResourceLifecycle
	// Experimental.
	SetLifecycle(val *cdktf.TerraformResourceLifecycle)
	Name() *string
	SetName(val *string)
	NameInput() *string
	Namespaces() *[]*string
	SetNamespaces(val *[]*string)
	NamespacesInput() *[]*string
	// The tree node.
	Node() constructs.Node
	Pattern() *string
	SetPattern(val *string)
	PatternInput() *string
	Priority() *float64
	SetPriority(val *float64)
	PriorityInput() *float64
	// Experimental.
	Provider() cdktf.TerraformProvider
	// Experimental.
	SetProvider(val cdktf.TerraformProvider)
	// Experimental.
	Provisioners() *[]interface{}
	// Experimental.
	SetProvisioners(val *[]interface{})
	// Experimental.
	RawOverrides() interface{}
	StandardPatternId() *string
	SetStandardPatternId(val *string)
	StandardPatternIdInput() *string
	Tags() *[]*string
	SetTags(val *[]*string)
	TagsInput() *[]*string
	// Experimental.
	TerraformGeneratorMetadata() *cdktf.TerraformProviderGeneratorMetadata
	// Experimental.
	TerraformMetaArguments() *map[string]interface{}
	// Experimental.
	TerraformResourceType() *string
	TextReplacement() SensitiveDataScannerRuleTextReplacementOutputReference
	TextReplacementInput() *SensitiveDataScannerRuleTextReplacement
	// Adds a user defined moveTarget string to this resource to be later used in .moveTo(moveTarget) to resolve the location of the move.
	// Experimental.
	AddMoveTarget(moveTarget *string)
	// Experimental.
	AddOverride(path *string, value interface{})
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	HasResourceMove() interface{}
	// Experimental.
	ImportFrom(id *string, provider cdktf.TerraformProvider)
	// Experimental.
	InterpolationForAttribute(terraformAttribute *string) cdktf.IResolvable
	// Move the resource corresponding to "id" to this resource.
	//
	// Note that the resource being moved from must be marked as moved using it's instance function.
	// Experimental.
	MoveFromId(id *string)
	// Moves this resource to the target resource given by moveTarget.
	// Experimental.
	MoveTo(moveTarget *string, index interface{})
	// Moves this resource to the resource corresponding to "id".
	// Experimental.
	MoveToId(id *string)
	// Overrides the auto-generated logical ID with a specific ID.
	// Experimental.
	OverrideLogicalId(newLogicalId *string)
	PutIncludedKeywordConfiguration(value *SensitiveDataScannerRuleIncludedKeywordConfiguration)
	PutTextReplacement(value *SensitiveDataScannerRuleTextReplacement)
	ResetDescription()
	ResetExcludedNamespaces()
	ResetId()
	ResetIncludedKeywordConfiguration()
	ResetIsEnabled()
	ResetName()
	ResetNamespaces()
	// Resets a previously passed logical Id to use the auto-generated logical id again.
	// Experimental.
	ResetOverrideLogicalId()
	ResetPattern()
	ResetPriority()
	ResetStandardPatternId()
	ResetTags()
	ResetTextReplacement()
	SynthesizeAttributes() *map[string]interface{}
	SynthesizeHclAttributes() *map[string]interface{}
	// Experimental.
	ToHclTerraform() interface{}
	// Experimental.
	ToMetadata() interface{}
	// Returns a string representation of this construct.
	ToString() *string
	// Adds this resource to the terraform JSON output.
	// Experimental.
	ToTerraform() interface{}
}

Represents a {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule datadog_sensitive_data_scanner_rule}.

func NewSensitiveDataScannerRule 

func NewSensitiveDataScannerRule(scope constructs.Construct, id *string, config *SensitiveDataScannerRuleConfig) SensitiveDataScannerRule

Create a new {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule datadog_sensitive_data_scanner_rule} Resource.

type SensitiveDataScannerRuleConfig 

type SensitiveDataScannerRuleConfig struct {
	// Experimental.
	Connection interface{} `field:"optional" json:"connection" yaml:"connection"`
	// Experimental.
	Count interface{} `field:"optional" json:"count" yaml:"count"`
	// Experimental.
	DependsOn *[]cdktf.ITerraformDependable `field:"optional" json:"dependsOn" yaml:"dependsOn"`
	// Experimental.
	ForEach cdktf.ITerraformIterator `field:"optional" json:"forEach" yaml:"forEach"`
	// Experimental.
	Lifecycle *cdktf.TerraformResourceLifecycle `field:"optional" json:"lifecycle" yaml:"lifecycle"`
	// Experimental.
	Provider cdktf.TerraformProvider `field:"optional" json:"provider" yaml:"provider"`
	// Experimental.
	Provisioners *[]interface{} `field:"optional" json:"provisioners" yaml:"provisioners"`
	// Id of the scanning group the rule belongs to.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#group_id SensitiveDataScannerRule#group_id}
	GroupId *string `field:"required" json:"groupId" yaml:"groupId"`
	// Description of the rule.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#description SensitiveDataScannerRule#description}
	Description *string `field:"optional" json:"description" yaml:"description"`
	// Attributes excluded from the scan. If namespaces is provided, it has to be a sub-path of the namespaces array.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#excluded_namespaces SensitiveDataScannerRule#excluded_namespaces}
	ExcludedNamespaces *[]*string `field:"optional" json:"excludedNamespaces" yaml:"excludedNamespaces"`
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#id SensitiveDataScannerRule#id}.
	//
	// Please be aware that the id field is automatically added to all resources in Terraform providers using a Terraform provider SDK version below 2.
	// If you experience problems setting this value it might not be settable. Please take a look at the provider documentation to ensure it should be settable.
	Id *string `field:"optional" json:"id" yaml:"id"`
	// included_keyword_configuration block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#included_keyword_configuration SensitiveDataScannerRule#included_keyword_configuration}
	IncludedKeywordConfiguration *SensitiveDataScannerRuleIncludedKeywordConfiguration `field:"optional" json:"includedKeywordConfiguration" yaml:"includedKeywordConfiguration"`
	// Whether or not the rule is enabled.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#is_enabled SensitiveDataScannerRule#is_enabled}
	IsEnabled interface{} `field:"optional" json:"isEnabled" yaml:"isEnabled"`
	// Name of the rule.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#name SensitiveDataScannerRule#name}
	Name *string `field:"optional" json:"name" yaml:"name"`
	// Attributes included in the scan.
	//
	// If namespaces is empty or missing, all attributes except excluded_namespaces are scanned. If both are missing the whole event is scanned.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#namespaces SensitiveDataScannerRule#namespaces}
	Namespaces *[]*string `field:"optional" json:"namespaces" yaml:"namespaces"`
	// Not included if there is a relationship to a standard pattern.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#pattern SensitiveDataScannerRule#pattern}
	Pattern *string `field:"optional" json:"pattern" yaml:"pattern"`
	// Priority level of the rule (optional).
	//
	// Used to order sensitive data discovered in the sds summary page. It must be between 1 and 5 (1 being the most important).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#priority SensitiveDataScannerRule#priority}
	Priority *float64 `field:"optional" json:"priority" yaml:"priority"`
	// Id of the standard pattern the rule refers to. If provided, then pattern must not be provided.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#standard_pattern_id SensitiveDataScannerRule#standard_pattern_id}
	StandardPatternId *string `field:"optional" json:"standardPatternId" yaml:"standardPatternId"`
	// List of tags.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#tags SensitiveDataScannerRule#tags}
	Tags *[]*string `field:"optional" json:"tags" yaml:"tags"`
	// text_replacement block.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#text_replacement SensitiveDataScannerRule#text_replacement}
	TextReplacement *SensitiveDataScannerRuleTextReplacement `field:"optional" json:"textReplacement" yaml:"textReplacement"`
}

type SensitiveDataScannerRuleIncludedKeywordConfiguration added in v11.2.0 

type SensitiveDataScannerRuleIncludedKeywordConfiguration struct {
	// Number of characters before the match to find a keyword validating the match.
	//
	// It must be between 1 and 50 (inclusive).
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#character_count SensitiveDataScannerRule#character_count}
	CharacterCount *float64 `field:"required" json:"characterCount" yaml:"characterCount"`
	// Keyword list that is checked during scanning in order to validate a match.
	//
	// The number of keywords in the list must be lower than or equal to 30.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#keywords SensitiveDataScannerRule#keywords}
	Keywords *[]*string `field:"required" json:"keywords" yaml:"keywords"`
}

type SensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference added in v11.2.0 

type SensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference interface {
	cdktf.ComplexObject
	CharacterCount() *float64
	SetCharacterCount(val *float64)
	CharacterCountInput() *float64
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() *SensitiveDataScannerRuleIncludedKeywordConfiguration
	SetInternalValue(val *SensitiveDataScannerRuleIncludedKeywordConfiguration)
	Keywords() *[]*string
	SetKeywords(val *[]*string)
	KeywordsInput() *[]*string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewSensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference added in v11.2.0 

func NewSensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) SensitiveDataScannerRuleIncludedKeywordConfigurationOutputReference

type SensitiveDataScannerRuleTextReplacement 

type SensitiveDataScannerRuleTextReplacement struct {
	// Type of the replacement text.
	//
	// None means no replacement. hash means the data will be stubbed. replacement_string means that one can chose a text to replace the data. partial_replacement_from_beginning allows a user to partially replace the data from the beginning, and partial_replacement_from_end on the other hand, allows to replace data from the end. Valid values are `none`, `hash`, `replacement_string`, `partial_replacement_from_beginning`, `partial_replacement_from_end`.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#type SensitiveDataScannerRule#type}
	Type *string `field:"required" json:"type" yaml:"type"`
	// Required if type == 'partial_replacement_from_beginning' or 'partial_replacement_from_end'. It must be > 0.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#number_of_chars SensitiveDataScannerRule#number_of_chars}
	NumberOfChars *float64 `field:"optional" json:"numberOfChars" yaml:"numberOfChars"`
	// Required if type == 'replacement_string'.
	//
	// Docs at Terraform Registry: {@link https://registry.terraform.io/providers/datadog/datadog/3.50.0/docs/resources/sensitive_data_scanner_rule#replacement_string SensitiveDataScannerRule#replacement_string}
	ReplacementString *string `field:"optional" json:"replacementString" yaml:"replacementString"`
}

type SensitiveDataScannerRuleTextReplacementOutputReference 

type SensitiveDataScannerRuleTextReplacementOutputReference interface {
	cdktf.ComplexObject
	// the index of the complex object in a list.
	// Experimental.
	ComplexObjectIndex() interface{}
	// Experimental.
	SetComplexObjectIndex(val interface{})
	// set to true if this item is from inside a set and needs tolist() for accessing it set to "0" for single list items.
	// Experimental.
	ComplexObjectIsFromSet() *bool
	// Experimental.
	SetComplexObjectIsFromSet(val *bool)
	// The creation stack of this resolvable which will be appended to errors thrown during resolution.
	//
	// If this returns an empty array the stack will not be attached.
	// Experimental.
	CreationStack() *[]*string
	// Experimental.
	Fqn() *string
	InternalValue() *SensitiveDataScannerRuleTextReplacement
	SetInternalValue(val *SensitiveDataScannerRuleTextReplacement)
	NumberOfChars() *float64
	SetNumberOfChars(val *float64)
	NumberOfCharsInput() *float64
	ReplacementString() *string
	SetReplacementString(val *string)
	ReplacementStringInput() *string
	// Experimental.
	TerraformAttribute() *string
	// Experimental.
	SetTerraformAttribute(val *string)
	// Experimental.
	TerraformResource() cdktf.IInterpolatingParent
	// Experimental.
	SetTerraformResource(val cdktf.IInterpolatingParent)
	Type() *string
	SetType(val *string)
	TypeInput() *string
	// Experimental.
	ComputeFqn() *string
	// Experimental.
	GetAnyMapAttribute(terraformAttribute *string) *map[string]interface{}
	// Experimental.
	GetBooleanAttribute(terraformAttribute *string) cdktf.IResolvable
	// Experimental.
	GetBooleanMapAttribute(terraformAttribute *string) *map[string]*bool
	// Experimental.
	GetListAttribute(terraformAttribute *string) *[]*string
	// Experimental.
	GetNumberAttribute(terraformAttribute *string) *float64
	// Experimental.
	GetNumberListAttribute(terraformAttribute *string) *[]*float64
	// Experimental.
	GetNumberMapAttribute(terraformAttribute *string) *map[string]*float64
	// Experimental.
	GetStringAttribute(terraformAttribute *string) *string
	// Experimental.
	GetStringMapAttribute(terraformAttribute *string) *map[string]*string
	// Experimental.
	InterpolationAsList() cdktf.IResolvable
	// Experimental.
	InterpolationForAttribute(property *string) cdktf.IResolvable
	ResetNumberOfChars()
	ResetReplacementString()
	// Produce the Token's value at resolution time.
	// Experimental.
	Resolve(_context cdktf.IResolveContext) interface{}
	// Return a string representation of this resolvable object.
	//
	// Returns a reversible string representation.
	// Experimental.
	ToString() *string
}

func NewSensitiveDataScannerRuleTextReplacementOutputReference 

func NewSensitiveDataScannerRuleTextReplacementOutputReference(terraformResource cdktf.IInterpolatingParent, terraformAttribute *string) SensitiveDataScannerRuleTextReplacementOutputReference

Source Files

View all Source files

Directories

Path Synopsis

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.