github.com/khulnasoft-lab/defsec@v1.0.5-0.20230827010352-5e9f46893d95/rules/cloud/policies/aws/elasticache/enable_backup_retention.go (about)

     1  package elasticache
     2  
     3  import (
     4  	"github.com/khulnasoft-lab/defsec/internal/rules"
     5  	"github.com/khulnasoft-lab/defsec/pkg/providers"
     6  	"github.com/khulnasoft-lab/defsec/pkg/scan"
     7  	"github.com/khulnasoft-lab/defsec/pkg/severity"
     8  	"github.com/khulnasoft-lab/defsec/pkg/state"
     9  )
    10  
    11  var CheckEnableBackupRetention = rules.Register(
    12  	scan.Rule{
    13  		AVDID:       "AVD-AWS-0050",
    14  		Provider:    providers.AWSProvider,
    15  		Service:     "elasticache",
    16  		ShortCode:   "enable-backup-retention",
    17  		Summary:     "Redis cluster should have backup retention turned on",
    18  		Impact:      "Without backups of the redis cluster recovery is made difficult",
    19  		Resolution:  "Configure snapshot retention for redis cluster",
    20  		Explanation: `Redis clusters should have a snapshot retention time to ensure that they are backed up and can be restored if required.`,
    21  		Links: []string{
    22  			"https://docs.aws.amazon.com/AmazonElastiCache/latest/red-ug/backups-automatic.html",
    23  		},
    24  		Terraform: &scan.EngineMetadata{
    25  			GoodExamples:        terraformEnableBackupRetentionGoodExamples,
    26  			BadExamples:         terraformEnableBackupRetentionBadExamples,
    27  			Links:               terraformEnableBackupRetentionLinks,
    28  			RemediationMarkdown: terraformEnableBackupRetentionRemediationMarkdown,
    29  		},
    30  		CloudFormation: &scan.EngineMetadata{
    31  			GoodExamples:        cloudFormationEnableBackupRetentionGoodExamples,
    32  			BadExamples:         cloudFormationEnableBackupRetentionBadExamples,
    33  			Links:               cloudFormationEnableBackupRetentionLinks,
    34  			RemediationMarkdown: cloudFormationEnableBackupRetentionRemediationMarkdown,
    35  		},
    36  		Severity: severity.Medium,
    37  	},
    38  	func(s *state.State) (results scan.Results) {
    39  		for _, cluster := range s.AWS.ElastiCache.Clusters {
    40  			if !cluster.Engine.EqualTo("redis") {
    41  				continue
    42  			}
    43  
    44  			if cluster.NodeType.EqualTo("cache.t1.micro") {
    45  				continue
    46  			}
    47  
    48  			if cluster.SnapshotRetentionLimit.EqualTo(0) {
    49  				results.Add(
    50  					"Cluster snapshot retention is not enabled.",
    51  					cluster.SnapshotRetentionLimit,
    52  				)
    53  			} else {
    54  				results.AddPassed(&cluster)
    55  			}
    56  		}
    57  		return
    58  	},
    59  )