config

Documentation

Index

• func ShouldInclude(name string, includeREs []Expression, excludeREs []Expression) bool
• type Config
  • func GetConfig(filePath string) (*Config, error)
• type Expression
  • func (expression *Expression) UnmarshalText(data []byte) error
• type FilterRule
• type ResourceType

Functions

func ShouldInclude

func ShouldInclude(name string, includeREs []Expression, excludeREs []Expression) bool

ShouldInclude - Checks if a resource's name should be included according to the inclusion and exclusion rules

Types

type Config

type Config struct {
	S3                    ResourceType `yaml:"s3"`
	IAMUsers              ResourceType `yaml:"IAMUsers"`
	SecretsManagerSecrets ResourceType `yaml:"SecretsManager"`
	NatGateway            ResourceType `yaml:"NatGateway"`
	AccessAnalyzer        ResourceType `yaml:"AccessAnalyzer"`
	CloudWatchDashboard   ResourceType `yaml:"CloudWatchDashboard"`
	OpenSearchDomain      ResourceType `yaml:"OpenSearchDomain"`
	DynamoDB              ResourceType `yaml:"DynamoDB"`
	EBSVolume             ResourceType `yaml:"EBSVolume"`
	LambdaFunction        ResourceType `yaml:"LambdaFunction"`
	ELBv2                 ResourceType `yaml:"ELBv2"`
	ECSService            ResourceType `yaml:"ECSService"`
	ECSCluster            ResourceType `yaml:"ECSCluster"`
	Elasticache           ResourceType `yaml:"Elasticache"`
	VPC                   ResourceType `yaml:"VPC"`
	OIDCProvider          ResourceType `yaml:"OIDCProvider"`
}

Config - the config object we pass around

func GetConfig

func GetConfig(filePath string) (*Config, error)

GetConfig - Unmarshall the config file and parse it into a config object.

type Expression

type Expression struct {
	RE regexp.Regexp
}

func (*Expression) UnmarshalText

func (expression *Expression) UnmarshalText(data []byte) error

UnmarshalText - Internally used by yaml.Unmarshal to unmarshall an Expression field

type FilterRule

type FilterRule struct {
	NamesRegExp []Expression `yaml:"names_regex"`
}

type ResourceType

type ResourceType struct {
	IncludeRule FilterRule `yaml:"include"`
	ExcludeRule FilterRule `yaml:"exclude"`
}