Metadata-Version: 2.1
Name: awsjavakit-cfn-rules
Version: 0.0.7
Summary: My CFN rules
Author: Orestis Gkorgkas
Author-email: orestis.gorgas@gmail.com
Requires-Python: >=3.10.15,<4.0.0
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: attrs (==24.2.0)
Requires-Dist: cfn-lint (>=1.21.0,<2.0.0)
Requires-Dist: flake8 (==7.1.1)
Description-Content-Type: text/markdown

# Some custom Cloud Formation rules

### Suggested Usage:

Create a configuration file `.cfnlintrc` like the following:
    
```
        templates:
          - template.yaml
        append_rules:
            - awsjavakit_cfn_rules
        
        configure_rules:
            E9001:
                expected_tags:
                    - expectedTag


```
Place the configuration file in the same folder as your template (template.yaml).  
Afterwards, run the following commands
```
        python -m venv .cfn-lint-venv
        . .cfn-lint-venv/bin activate
        pip install cfn-lint
        pip install awsjavakit-cfn-rules
        
```
Finally run `cfn-lint` to run the cfn-lint.

## Implemented rules:

### E9001 Tags Rule:
It checks whether resources (currently only Lambda functions) have the desired tags. Example:
```
templates:
    - tests/resources/templates/**/*.yaml
append_rules:
    - awsjavakit_cfn_rules

configure_rules:
    E9001:
        expected_tags:
            - expectedTag

```
    
