awsmacie

package
v2.7.0 Latest Latest
Warning

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

 Go to latest Published: Jan 12, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func CfnCustomDataIdentifier_CFN_RESOURCE_TYPE_NAME 

func CfnCustomDataIdentifier_CFN_RESOURCE_TYPE_NAME() *string

func CfnCustomDataIdentifier_IsCfnElement 

func CfnCustomDataIdentifier_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnCustomDataIdentifier_IsCfnResource 

func CfnCustomDataIdentifier_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnCustomDataIdentifier_IsConstruct 

func CfnCustomDataIdentifier_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func CfnFindingsFilter_CFN_RESOURCE_TYPE_NAME 

func CfnFindingsFilter_CFN_RESOURCE_TYPE_NAME() *string

func CfnFindingsFilter_IsCfnElement 

func CfnFindingsFilter_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnFindingsFilter_IsCfnResource 

func CfnFindingsFilter_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnFindingsFilter_IsConstruct 

func CfnFindingsFilter_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func CfnSession_CFN_RESOURCE_TYPE_NAME 

func CfnSession_CFN_RESOURCE_TYPE_NAME() *string

func CfnSession_IsCfnElement 

func CfnSession_IsCfnElement(x interface{}) *bool

Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).

Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.

Returns: The construct as a stack element or undefined if it is not a stack element.

func CfnSession_IsCfnResource 

func CfnSession_IsCfnResource(construct constructs.IConstruct) *bool

Check whether the given construct is a CfnResource.

func CfnSession_IsConstruct 

func CfnSession_IsConstruct(x interface{}) *bool

Checks if `x` is a construct.

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

func NewCfnCustomDataIdentifier_Override 

func NewCfnCustomDataIdentifier_Override(c CfnCustomDataIdentifier, scope constructs.Construct, id *string, props *CfnCustomDataIdentifierProps)

Create a new `AWS::Macie::CustomDataIdentifier`.

func NewCfnFindingsFilter_Override 

func NewCfnFindingsFilter_Override(c CfnFindingsFilter, scope constructs.Construct, id *string, props *CfnFindingsFilterProps)

Create a new `AWS::Macie::FindingsFilter`.

func NewCfnSession_Override 

func NewCfnSession_Override(c CfnSession, scope constructs.Construct, id *string, props *CfnSessionProps)

Create a new `AWS::Macie::Session`.

Types

type CfnCustomDataIdentifier 

type CfnCustomDataIdentifier interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrArn() *string
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	IgnoreWords() *[]*string
	SetIgnoreWords(val *[]*string)
	Keywords() *[]*string
	SetKeywords(val *[]*string)
	LogicalId() *string
	MaximumMatchDistance() *float64
	SetMaximumMatchDistance(val *float64)
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Ref() *string
	Regex() *string
	SetRegex(val *string)
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Macie::CustomDataIdentifier`.

The `AWS::Macie::CustomDataIdentifier` resource is a set of criteria that you define to detect sensitive data in one or more data sources. Each identifier specifies a regular expression ( *regex* ) that defines a text pattern to match in the data. It can also specify character sequences, such as words and phrases, and a proximity rule that refine the analysis of a data source. By using custom data identifiers, you can tailor your analysis to meet your organization's specific needs and supplement the built-in, managed data identifiers that Amazon Macie provides.

A `Session` must exist for the account before you can create a `CustomDataIdentifier` . Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that the `Session` is created before the other resources. For example, `"DependsOn: Session"` .

TODO: EXAMPLE

func NewCfnCustomDataIdentifier 

func NewCfnCustomDataIdentifier(scope constructs.Construct, id *string, props *CfnCustomDataIdentifierProps) CfnCustomDataIdentifier

Create a new `AWS::Macie::CustomDataIdentifier`.

type CfnCustomDataIdentifierProps 

type CfnCustomDataIdentifierProps struct {
	// A custom name for the custom data identifier. The name can contain as many as 128 characters.
	//
	// We strongly recommend that you avoid including any sensitive data in the name of a custom data identifier. Other users of your account might be able to see the identifier's name, depending on the actions that they're allowed to perform in Amazon Macie .
	Name *string `json:"name"`
	// The regular expression ( *regex* ) that defines the pattern to match.
	//
	// The expression can contain as many as 512 characters.
	Regex *string `json:"regex"`
	// The description of the custom data identifier.
	//
	// The description can contain as many as 512 characters.
	Description *string `json:"description"`
	// An array that lists specific character sequences (ignore words) to exclude from the results.
	//
	// If the text matched by the regular expression is the same as any string in this array, Amazon Macie ignores it. The array can contain as many as 10 ignore words. Each ignore word can contain 4-90 characters. Ignore words are case sensitive.
	IgnoreWords *[]*string `json:"ignoreWords"`
	// An array that lists specific character sequences (keywords), one of which must be within proximity ( `MaximumMatchDistance` ) of the regular expression to match.
	//
	// The array can contain as many as 50 keywords. Each keyword can contain 3-90 characters. Keywords aren't case sensitive.
	Keywords *[]*string `json:"keywords"`
	// The maximum number of characters that can exist between text that matches the regex pattern and the character sequences specified by the `Keywords` array.
	//
	// Amazon Macie includes or excludes a result based on the proximity of a keyword to text that matches the regex pattern. The distance can be 1-300 characters. The default value is 50.
	MaximumMatchDistance *float64 `json:"maximumMatchDistance"`
}

Properties for defining a `CfnCustomDataIdentifier`.

TODO: EXAMPLE

type CfnFindingsFilter 

type CfnFindingsFilter interface {
	awscdk.CfnResource
	awscdk.IInspectable
	Action() *string
	SetAction(val *string)
	AttrArn() *string
	AttrFindingsFilterListItems() awscdk.IResolvable
	AttrId() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	Description() *string
	SetDescription(val *string)
	FindingCriteria() interface{}
	SetFindingCriteria(val interface{})
	LogicalId() *string
	Name() *string
	SetName(val *string)
	Node() constructs.Node
	Position() *float64
	SetPosition(val *float64)
	Ref() *string
	Stack() awscdk.Stack
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Macie::FindingsFilter`.

The `AWS::Macie::FindingsFilter` resource represents an individual findings filter that you create and save to view, analyze, and manage findings. A *findings filter* is a set of criteria that specifies which findings to include in the results of a query for findings. A findings filter can also perform specific actions on findings that meet the filter's criteria.

A `Session` must exist for the account before you can create a `FindingsFilter` . Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that the `Session` is created before the other resources. For example, `"DependsOn: Session"` .

TODO: EXAMPLE

func NewCfnFindingsFilter 

func NewCfnFindingsFilter(scope constructs.Construct, id *string, props *CfnFindingsFilterProps) CfnFindingsFilter

Create a new `AWS::Macie::FindingsFilter`.

type CfnFindingsFilterProps 

type CfnFindingsFilterProps struct {
	// The criteria to use to filter findings.
	FindingCriteria interface{} `json:"findingCriteria"`
	// A custom name for the filter.
	//
	// The name must contain at least 3 characters and can contain as many as 64 characters.
	//
	// We strongly recommend that you avoid including any sensitive data in the name of a filter. Other users might be able to see the filter's name, depending on the actions that they're allowed to perform in Amazon Macie .
	Name *string `json:"name"`
	// The action to perform on findings that meet the filter criteria ( `FindingCriteria` ). Valid values are:.
	//
	// - ARCHIVE - Suppress (automatically archive) the findings.
	// - NOOP - Don't perform any action on the findings.
	Action *string `json:"action"`
	// A custom description of the filter. The description can contain as many as 512 characters.
	//
	// We strongly recommend that you avoid including any sensitive data in the description of a filter. Other users might be able to see the filter's description, depending on the actions that they're allowed to perform in Amazon Macie .
	Description *string `json:"description"`
	// The position of the filter in the list of saved filters on the Amazon Macie console.
	//
	// This value also determines the order in which the filter is applied to findings, relative to other filters that are also applied to the findings.
	Position *float64 `json:"position"`
}

Properties for defining a `CfnFindingsFilter`.

TODO: EXAMPLE

type CfnFindingsFilter_CriterionProperty 

type CfnFindingsFilter_CriterionProperty struct {
}

A condition that specifies the property, operator, and value to use to filter the results of a query for findings.

For more information, see [Criterion](https://docs.aws.amazon.com/macie/latest/APIReference/findingsfilters-id.html#findingsfilters-id-model-criterion) in the *Amazon Macie API Reference* .

TODO: EXAMPLE

type CfnFindingsFilter_FindingCriteriaProperty 

type CfnFindingsFilter_FindingCriteriaProperty struct {
	// Specifies a condition that defines the property, operator, and value to use to filter the results.
	Criterion interface{} `json:"criterion"`
}

Specifies, as a map, one or more property-based conditions that filter the results of a query for findings.

TODO: EXAMPLE

type CfnFindingsFilter_FindingsFilterListItemProperty 

type CfnFindingsFilter_FindingsFilterListItemProperty struct {
	// The unique identifier for the filter.
	Id *string `json:"id"`
	// The custom name of the filter.
	Name *string `json:"name"`
}

Specifies the unique identifier and custom name of a findings filter.

TODO: EXAMPLE

type CfnSession 

type CfnSession interface {
	awscdk.CfnResource
	awscdk.IInspectable
	AttrAwsAccountId() *string
	AttrServiceRole() *string
	CfnOptions() awscdk.ICfnResourceOptions
	CfnProperties() *map[string]interface{}
	CfnResourceType() *string
	CreationStack() *[]*string
	FindingPublishingFrequency() *string
	SetFindingPublishingFrequency(val *string)
	LogicalId() *string
	Node() constructs.Node
	Ref() *string
	Stack() awscdk.Stack
	Status() *string
	SetStatus(val *string)
	UpdatedProperites() *map[string]interface{}
	AddDeletionOverride(path *string)
	AddDependsOn(target awscdk.CfnResource)
	AddMetadata(key *string, value interface{})
	AddOverride(path *string, value interface{})
	AddPropertyDeletionOverride(propertyPath *string)
	AddPropertyOverride(propertyPath *string, value interface{})
	ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions)
	GetAtt(attributeName *string) awscdk.Reference
	GetMetadata(key *string) interface{}
	Inspect(inspector awscdk.TreeInspector)
	OverrideLogicalId(newLogicalId *string)
	RenderProperties(props *map[string]interface{}) *map[string]interface{}
	ShouldSynthesize() *bool
	ToString() *string
	ValidateProperties(_properties interface{})
}

A CloudFormation `AWS::Macie::Session`.

The `AWS::Macie::Session` resource represents the Amazon Macie service and configuration settings for an account. A `Session` is created for each AWS Region in which you enable Macie .

You must create a `Session` for an account before you can create an `AWS::Macie::FindingsFilter` or `AWS::Macie::CustomDataIdentifier` resource. Use a [DependsOn attribute](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-dependson.html) to ensure that the `Session` is created before the other resources. For example, `"DependsOn: Session"` .

TODO: EXAMPLE

func NewCfnSession 

func NewCfnSession(scope constructs.Construct, id *string, props *CfnSessionProps) CfnSession

Create a new `AWS::Macie::Session`.

type CfnSessionProps 

type CfnSessionProps struct {
	// The frequency with which Amazon Macie publishes updates to policy findings for an account.
	//
	// This includes publishing updates to AWS Security Hub and Amazon EventBridge (formerly called Amazon CloudWatch Events ). Valid values are:
	//
	// - FIFTEEN_MINUTES
	// - ONE_HOUR
	// - SIX_HOURS
	FindingPublishingFrequency *string `json:"findingPublishingFrequency"`
	// The `MacieStatus` of the `Session` .
	//
	// Valid values include `ENABLED` and `PAUSED` .
	Status *string `json:"status"`
}

Properties for defining a `CfnSession`.

TODO: EXAMPLE

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.