<!-- This readme file is generated with terraform-docs -->
## Example

```hcl
module "aws-backup" {
  source = "../"

  backup_kms_key           = "arn..."
  daily-backup-cron        = "cron(0 20 * * ? *)"
  daily-backup-retention   = 30
  monthly-backup-cron      = ""
  monthly-backup-retention = 360
  service-opt-in = {
    "Aurora" : false,
    "DynamoDB" : false,
    "EBS" : false,
    "EC2" : true,
    "EFS" : true,
    "FSx" : false,
    "Redshift" : false,
    "RDS" : true,
    "VirtualMachine" : false,
    "S3" : true,
    "EKS" : false,
    "CloudFormation" : false,
    "Neptune" : false,
    "Redshift Serverless" : false,
    "SAP HANA on Amazon EC2" : false,
    "Storage Gateway" : false
  }
}
```

# aws-backup

Module to configure AWSBackup service opt in and manage backup settings for typical workloads

## Requirements

No requirements.

## Providers

| Name | Version |
| ---- | ------- |
| aws | n/a |

## Modules

No modules.

## Resources

| Name | Type |
| ---- | ---- |
| [aws_backup_plan.ab-plan](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_plan) | resource |
| [aws_backup_region_settings.ab-settings](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_region_settings) | resource |
| [aws_backup_selection.ab-selection-by-service-type](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_selection) | resource |
| [aws_backup_vault.ab-vault](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_vault) | resource |
| [aws_backup_vault_policy.ab-vault-policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/backup_vault_policy) | resource |
| [aws_iam_role.ab-iam-role](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role) | resource |
| [aws_iam_role_policy_attachment.ab-iam-role-policy](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/resources/iam_role_policy_attachment) | resource |
| [aws_caller_identity.this](https://registry.terraform.io/providers/hashicorp/aws/latest/docs/data-sources/caller_identity) | data source |

## Inputs

| Name | Description | Type | Default | Required |
| ---- | ----------- | ---- | ------- | :------: |
| backup\_kms\_key | KMS key arn for AWS Backup | `string` | `null` | no |
| daily-backup-cron | Daily backup rule cron expression | `string` | n/a | yes |
| daily-backup-retention | Daily backup retention period | `number` | n/a | yes |
| enable-monthly-backup | Enable monthly backup plan. In most cases, monthly backup is not useful. | `bool` | `false` | no |
| enable-vss | Enable VSS for Windows Ec2 | `bool` | `false` | no |
| monthly-backup-cron | Monthly backup rule cron expression | `string` | `null` | no |
| monthly-backup-retention | Monthly backup retention period | `number` | `null` | no |
| service-opt-in | If not specified, EC2, RDS, EFS, and S3 are enabled | `map(bool)` | <pre>{<br/>  "Aurora": false,<br/>  "CloudFormation": false,<br/>  "DynamoDB": false,<br/>  "EBS": false,<br/>  "EC2": true,<br/>  "EFS": true,<br/>  "EKS": false,<br/>  "FSx": false,<br/>  "Neptune": false,<br/>  "RDS": true,<br/>  "Redshift": false,<br/>  "Redshift Serverless": false,<br/>  "S3": true,<br/>  "SAP HANA on Amazon EC2": false,<br/>  "Storage Gateway": false,<br/>  "VirtualMachine": false<br/>}</pre> | no |

## Outputs

| Name | Description |
| ---- | ----------- |
| backup\_iam\_role\_arn | n/a |
| backup\_plan\_ids | n/a |
| backup\_vault\_arns | n/a |
 
---
## Authorship
This module was developed by xpk.