/AWS1/CL_STGGATEWAYINFO¶
Describes a gateway object.
CONSTRUCTOR¶
IMPORTING¶
Optional arguments:¶
iv_gatewayid TYPE /AWS1/STGGATEWAYID /AWS1/STGGATEWAYID¶
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.
iv_gatewayarn TYPE /AWS1/STGGATEWAYARN /AWS1/STGGATEWAYARN¶
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
iv_gatewaytype TYPE /AWS1/STGGATEWAYTYPE /AWS1/STGGATEWAYTYPE¶
The type of the gateway.
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.
iv_gatewayoperationalstate TYPE /AWS1/STGGATEWAYOPALSTATE /AWS1/STGGATEWAYOPALSTATE¶
The state of the gateway.
Valid Values:
DISABLED|ACTIVE
iv_gatewayname TYPE /AWS1/STGSTRING /AWS1/STGSTRING¶
The name of the gateway.
iv_ec2instanceid TYPE /AWS1/STGEC2INSTANCEID /AWS1/STGEC2INSTANCEID¶
The ID of the Amazon EC2 instance that was used to launch the gateway.
iv_ec2instanceregion TYPE /AWS1/STGEC2INSTANCEREGION /AWS1/STGEC2INSTANCEREGION¶
The Amazon Web Services Region where the Amazon EC2 instance is located.
iv_hostenvironment TYPE /AWS1/STGHOSTENVIRONMENT /AWS1/STGHOSTENVIRONMENT¶
The type of hardware or software platform on which the gateway is running.
Tape Gateway is no longer available on Snow Family devices.
iv_hostenvironmentid TYPE /AWS1/STGHOSTENVIRONMENTID /AWS1/STGHOSTENVIRONMENTID¶
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.
iv_deprecationdate TYPE /AWS1/STGDEPRECATIONDATE /AWS1/STGDEPRECATIONDATE¶
Date after which this gateway will not receive software updates for new features and bug fixes.
iv_softwareversion TYPE /AWS1/STGSOFTWAREVERSION /AWS1/STGSOFTWAREVERSION¶
The version number of the software running on the gateway appliance.
Queryable Attributes¶
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GATEWAYID() |
Getter for GATEWAYID, with configurable default |
ASK_GATEWAYID() |
Getter for GATEWAYID w/ exceptions if field has no value |
HAS_GATEWAYID() |
Determine if GATEWAYID has a value |
GatewayARN¶
The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation to return a list of gateways for your account and Amazon Web Services Region.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GATEWAYARN() |
Getter for GATEWAYARN, with configurable default |
ASK_GATEWAYARN() |
Getter for GATEWAYARN w/ exceptions if field has no value |
HAS_GATEWAYARN() |
Determine if GATEWAYARN has a value |
GatewayType¶
The type of the gateway.
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GATEWAYTYPE() |
Getter for GATEWAYTYPE, with configurable default |
ASK_GATEWAYTYPE() |
Getter for GATEWAYTYPE w/ exceptions if field has no value |
HAS_GATEWAYTYPE() |
Determine if GATEWAYTYPE has a value |
GatewayOperationalState¶
The state of the gateway.
Valid Values:
DISABLED|ACTIVE
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GATEWAYOPERATIONALSTATE() |
Getter for GATEWAYOPERATIONALSTATE, with configurable defaul |
ASK_GATEWAYOPERATIONALSTATE() |
Getter for GATEWAYOPERATIONALSTATE w/ exceptions if field ha |
HAS_GATEWAYOPERATIONALSTATE() |
Determine if GATEWAYOPERATIONALSTATE has a value |
GatewayName¶
The name of the gateway.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_GATEWAYNAME() |
Getter for GATEWAYNAME, with configurable default |
ASK_GATEWAYNAME() |
Getter for GATEWAYNAME w/ exceptions if field has no value |
HAS_GATEWAYNAME() |
Determine if GATEWAYNAME has a value |
Ec2InstanceId¶
The ID of the Amazon EC2 instance that was used to launch the gateway.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EC2INSTANCEID() |
Getter for EC2INSTANCEID, with configurable default |
ASK_EC2INSTANCEID() |
Getter for EC2INSTANCEID w/ exceptions if field has no value |
HAS_EC2INSTANCEID() |
Determine if EC2INSTANCEID has a value |
Ec2InstanceRegion¶
The Amazon Web Services Region where the Amazon EC2 instance is located.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_EC2INSTANCEREGION() |
Getter for EC2INSTANCEREGION, with configurable default |
ASK_EC2INSTANCEREGION() |
Getter for EC2INSTANCEREGION w/ exceptions if field has no v |
HAS_EC2INSTANCEREGION() |
Determine if EC2INSTANCEREGION has a value |
HostEnvironment¶
The type of hardware or software platform on which the gateway is running.
Tape Gateway is no longer available on Snow Family devices.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HOSTENVIRONMENT() |
Getter for HOSTENVIRONMENT, with configurable default |
ASK_HOSTENVIRONMENT() |
Getter for HOSTENVIRONMENT w/ exceptions if field has no val |
HAS_HOSTENVIRONMENT() |
Determine if HOSTENVIRONMENT has a value |
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.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_HOSTENVIRONMENTID() |
Getter for HOSTENVIRONMENTID, with configurable default |
ASK_HOSTENVIRONMENTID() |
Getter for HOSTENVIRONMENTID w/ exceptions if field has no v |
HAS_HOSTENVIRONMENTID() |
Determine if HOSTENVIRONMENTID has a value |
DeprecationDate¶
Date after which this gateway will not receive software updates for new features and bug fixes.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_DEPRECATIONDATE() |
Getter for DEPRECATIONDATE, with configurable default |
ASK_DEPRECATIONDATE() |
Getter for DEPRECATIONDATE w/ exceptions if field has no val |
HAS_DEPRECATIONDATE() |
Determine if DEPRECATIONDATE has a value |
SoftwareVersion¶
The version number of the software running on the gateway appliance.
Accessible with the following methods¶
| Method | Description |
|---|---|
GET_SOFTWAREVERSION() |
Getter for SOFTWAREVERSION, with configurable default |
ASK_SOFTWAREVERSION() |
Getter for SOFTWAREVERSION w/ exceptions if field has no val |
HAS_SOFTWAREVERSION() |
Determine if SOFTWAREVERSION has a value |
Public Local Types In This Class¶
Internal table types, representing arrays and maps of this class, are defined as local types:
TT_GATEWAYS¶
TYPES TT_GATEWAYS TYPE STANDARD TABLE OF REF TO /AWS1/CL_STGGATEWAYINFO WITH DEFAULT KEY
.