AWS Amazon FSx Backup
This page shows how to write Terraform and CloudFormation for Amazon FSx Backup and write them securely.
aws_fsx_backup (Terraform)
The Backup in Amazon FSx can be configured in Terraform with the resource name aws_fsx_backup. The following sections describe how to use the resource and its parameters.
Example Usage from GitHub
An example could not be found in GitHub.
Parameters
The following arguments are supported:
file_system_id- (Required) The ID of the file system to back up.tags- (Optional) A map of tags to assign to the file system. If configured with a providerdefault_tagsconfiguration block present, tags with matching keys will overwrite those defined at the provider-level. If you have setcopy_tags_to_backupsto true, and you specify one or more tags, no existing file system tags are copied from the file system to the backup.
In addition to all arguments above, the following attributes are exported:
arn- Amazon Resource Name of the backup.id- Identifier of the backup, e.g.,fs-12345678kms_key_id- The ID of the AWS Key Management Service (AWS KMS) key used to encrypt the backup of the Amazon FSx file system's data at rest.owner_id- AWS account identifier that created the file system.tags_all- A map of tags assigned to the resource, including those inherited from the providerdefault_tagsconfiguration block.type- The type of the file system backup.
Explanation in Terraform Registry
Provides a FSx Backup resource.
AWS::FSx::FileSystem (CloudFormation)
The FileSystem in FSx can be configured in CloudFormation with the resource name AWS::FSx::FileSystem. The following sections describe 10 examples of how to use the resource and its parameters.
Example Usage from GitHub
Type: "AWS::FSx::FileSystem"
Properties:
FileSystemType: "WINDOWS"
StorageCapacity: !Ref StorageCapacity
KmsKeyId: !Ref KMSId
SubnetIds: !Ref SubnetIds
Type: "AWS::FSx::FileSystem"
Properties:
FileSystemType: "WINDOWS"
StorageCapacity: !Ref StorageCapacity
KmsKeyId: !Ref KMSId
SubnetIds: !Ref SubnetIds
Type: 'AWS::FSx::FileSystem'
UpdateReplacePolicy: Retain
DeletionPolicy: Retain
Properties:
FileSystemType: WINDOWS
StorageCapacity: 2000
Type: AWS::FSx::FileSystem
DependsOn: "SecurityGroup"
DeletionPolicy: "Delete"
Properties:
# BackupId: String
FileSystemType: "LUSTRE"
Type: 'AWS::FSx::FileSystem'
Properties:
FileSystemType: WINDOWS
StorageCapacity: 300
SubnetIds:
- !Ref PrivateSubnet1
"Type": "AWS::FSx::FileSystem",
"Properties": {
"FileSystemType": "LUSTRE",
"StorageCapacity": 3600,
"SubnetIds": [
{
"path": "/ResourceTypes/AWS::FSx::FileSystem/Properties/StorageCapacity/Value",
"value": {
"ValueType": "AWS::FSx::FileSystem.StorageCapacity"
}
}
]
"path": "/ResourceTypes/AWS::FSx::FileSystem/Properties/StorageCapacity/Value",
"value": {
"ValueType": "AWS::FSx::FileSystem.StorageCapacity"
}
}
]
"Type": "AWS::FSx::FileSystem",
"Properties": {
"FileSystemType": "WINDOWS",
"StorageCapacity": 300,
"SubnetIds": [
{
"Type": "AWS::FSx::FileSystem"
}
}
}
Parameters
-
StorageTypeoptional - String -
KmsKeyIdoptional - String -
StorageCapacityoptional - Integer -
FileSystemTyperequired - String -
LustreConfigurationoptional - LustreConfiguration -
BackupIdoptional - String -
SubnetIdsrequired - List -
SecurityGroupIdsoptional - List -
Tagsoptional - List of Tag -
WindowsConfigurationoptional - WindowsConfiguration
Explanation in CloudFormation Registry
The
AWS::FSx::FileSystemresource is an Amazon FSx resource type that creates either an Amazon FSx for Windows File Server file system or an Amazon FSx for Lustre file system.
Frequently asked questions
What is AWS Amazon FSx Backup?
AWS Amazon FSx Backup is a resource for Amazon FSx of Amazon Web Service. Settings can be wrote in Terraform and CloudFormation.
Where can I find the example code for the AWS Amazon FSx Backup?
For CloudFormation, the aws-samples/aws-service-catalog-reference-architectures, mynameisakash/aws-service-catalog-reference-architectures and K-Masopa/SageSI-IaC source code examples are useful. See the CloudFormation Example section for further details.
