Represents the hypervisor's permissions to which the gateway will connect.
A hypervisor is hardware, software, or firmware that creates and manages virtual machines, and allocates resources to them.
Syntax
To declare this entity in your AWS CloudFormation template, use the following syntax:
JSON
{
"Type" : "AWS::BackupGateway::Hypervisor",
"Properties" : {
"Host" : String,
"KmsKeyArn" : String,
"LogGroupArn" : String,
"Name" : String,
"Password" : String,
"Tags" : [ Tag, ... ],
"Username" : String
}
}
YAML
Type: AWS::BackupGateway::Hypervisor
Properties:
Host: String
KmsKeyArn: String
LogGroupArn: String
Name: String
Password: String
Tags:
- Tag
Username: String
Properties
Host-
The server host of the hypervisor. This can be either an IP address or a fully-qualified domain name (FQDN).
Required: No
Type: String
Pattern:
^.+$Minimum:
3Maximum:
128Update requires: No interruption
KmsKeyArn-
The Amazon Resource Name (ARN) of the AWS Key Management Service used to encrypt the hypervisor.
Required: No
Type: String
Pattern:
^(^arn:(aws|aws-cn|aws-us-gov):kms:([a-zA-Z0-9-]+):([0-9]+):(key|alias)/(\S+)$)|(^alias/(\S+)$)$Minimum:
50Maximum:
500Update requires: Replacement
LogGroupArn-
The Amazon Resource Name (ARN) of the group of gateways within the requested log.
Required: No
Type: String
Pattern:
^$|^arn:(aws|aws-cn|aws-us-gov):logs:([a-zA-Z0-9-]+):([0-9]+):log-group:[a-zA-Z0-9_\-\/\.]+:\*$Minimum:
0Maximum:
2048Update requires: No interruption
Name-
The name of the hypervisor.
Required: No
Type: String
Pattern:
^[a-zA-Z0-9-]*$Minimum:
1Maximum:
100Update requires: No interruption
Password-
The password for the hypervisor.
Required: No
Type: String
Pattern:
^[ -~]+$Minimum:
1Maximum:
100Update requires: No interruption
-
The tags of the hypervisor configuration to import.
Required: No
Type: Array of Tag
Update requires: Replacement
Username-
The username for the hypervisor.
Required: No
Type: String
Pattern:
^[ -\.0-\[\]-~]*[!-\.0-\[\]-~][ -\.0-\[\]-~]*$Minimum:
1Maximum:
100Update requires: No interruption
Return values
Ref
When you pass the logical ID of this resource to the intrinsic Ref function, Ref returns
HypervisorArn.
For more information about using the Ref function, see Ref.
Fn::GetAtt
The Fn::GetAtt intrinsic function returns a value for a specified attribute of this type. The following are the available attributes and sample return values.
For more information about using the Fn::GetAtt intrinsic function, see Fn::GetAtt.
HypervisorArn-
Returns
HypervisorArn, an Amazon Resource Name (ARN) that uniquely identifies a Hypervisor. For example:arn:aws:backup-gateway:us-east-1:123456789012:hypervisor/hype-1234D67D
