Describes a gateway object.
Contents
- DeprecationDate
-
Date after which this gateway will not receive software updates for new features and bug fixes.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 25.
Required: No
- Ec2InstanceId
-
The ID of the Amazon EC2 instance that was used to launch the gateway.
Type: String
Required: No
- Ec2InstanceRegion
-
The AWS Region where the Amazon EC2 instance is located.
Type: String
Required: No
- GatewayARN
-
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and AWS Region.
Type: String
Length Constraints: Minimum length of 50. Maximum length of 500.
Required: No
- GatewayId
-
The unique identifier assigned to your gateway during activation. This ID becomes part of the gateway Amazon Resource Name (ARN), which you use as input for other operations.
Type: String
Length Constraints: Minimum length of 12. Maximum length of 30.
Required: No
- GatewayName
-
The name of the gateway.
Type: String
Required: No
- GatewayOperationalState
-
The state of the gateway.
Valid Values:
DISABLED|ACTIVEType: String
Length Constraints: Minimum length of 2. Maximum length of 25.
Required: No
- GatewayType
-
The type of the gateway.
Important
Amazon FSx File Gateway is no longer available to new customers. Existing customers of FSx File Gateway can continue to use the service normally. For capabilities similar to FSx File Gateway, visit this blog post
. Type: String
Length Constraints: Minimum length of 2. Maximum length of 20.
Required: No
- HostEnvironment
-
The type of hardware or software platform on which the gateway is running.
Note
Tape Gateway is no longer available on Snow Family devices.
Type: String
Valid Values:
VMWARE | HYPER-V | EC2 | KVM | OTHER | SNOWBALLRequired: No
- HostEnvironmentId
-
A unique identifier for the specific instance of the host platform running the gateway. This value is only available for certain host environments, and its format depends on the host environment type.
Type: String
Length Constraints: Minimum length of 1. Maximum length of 1024.
Required: No
- SoftwareVersion
-
The version number of the software running on the gateway appliance.
Type: String
Required: No
See Also
For more information about using this API in one of the language-specific AWS SDKs, see the following:
