gateway_informations
Creates, updates, deletes, gets or lists a gateway_informations resource.
Overview
| Name | gateway_informations |
| Type | Resource |
| Id | aws.storagegateway.gateway_informations |
Fields
The following fields are returned by SELECT queries:
- describe_gateway_information
| Name | Datatype | Description |
|---|---|---|
cloud_watch_log_group_arn | string | The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway. This field only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM |
deprecation_date | string | Date after which this gateway will not receive software updates for new features and bug fixes. |
ec_2_instance_id | string | The ID of the Amazon EC2 instance that was used to launch the gateway. |
ec_2_instance_region | string | The Amazon Web Services Region where the Amazon EC2 instance is located. |
endpoint_type | string | The type of endpoint for your gateway. Valid Values: STANDARD | FIPS |
gateway_arn | string | 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. |
gateway_capacity | string | Specifies the size of the gateway's metadata cache. (Small, Medium, Large) |
gateway_id | string | 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. |
gateway_name | string | The name you configured for your gateway. |
gateway_network_interfaces | array | A NetworkInterface array that contains descriptions of the gateway network interfaces. |
gateway_state | string | A value that indicates the operating state of the gateway. |
gateway_timezone | string | A value that indicates the time zone configured for the gateway. |
gateway_type | string | 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. |
host_environment | string | The type of hardware or software platform on which the gateway is running. Tape Gateway is no longer available on Snow Family devices. (VMWARE, HYPER-V, EC2, KVM, OTHER, SNOWBALL) |
host_environment_id | string | 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. |
last_software_update | string | The date on which the last software update was applied to the gateway. If the gateway has never been updated, this field does not return a value in the response. This only only exist and returns once it have been chosen and set by the SGW service, based on the OS version of the gateway VM |
next_update_availability_date | string | The date on which an update to the gateway is available. This date is in the time zone of the gateway. If the gateway is not available for an update this field is not returned in the response. |
software_updates_end_date | string | Date after which this gateway will not receive software updates for new features. |
software_version | string | The version number of the software running on the gateway appliance. |
supported_gateway_capacities | array | A list of the metadata cache sizes that the gateway can support based on its current hardware specifications. |
tags | array | A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name. Each tag is a key-value pair. For a gateway with more than 10 tags assigned, you can view all tags using the ListTagsForResource API operation. |
vpc_endpoint | string | The configuration settings for the virtual private cloud (VPC) endpoint for your gateway. |
Methods
The following methods are available for this resource:
| Name | Accessible by | Required Params | Optional Params | Description |
|---|---|---|---|---|
describe_gateway_information | select | region | Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request. | |
update_gateway_information | update | region, GatewayARN | Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN. |
Parameters
Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.
| Name | Datatype | Description |
|---|---|---|
region | string | AWS region (default: us-east-1) |
SELECT examples
- describe_gateway_information
Returns metadata about a gateway such as its name, network interfaces, time zone, status, and software version. To specify which gateway to describe, use the Amazon Resource Name (ARN) of the gateway in your request.
SELECT
cloud_watch_log_group_arn,
deprecation_date,
ec_2_instance_id,
ec_2_instance_region,
endpoint_type,
gateway_arn,
gateway_capacity,
gateway_id,
gateway_name,
gateway_network_interfaces,
gateway_state,
gateway_timezone,
gateway_type,
host_environment,
host_environment_id,
last_software_update,
next_update_availability_date,
software_updates_end_date,
software_version,
supported_gateway_capacities,
tags,
vpc_endpoint
FROM aws.storagegateway.gateway_informations
WHERE region = '{{ region }}' -- required
;
UPDATE examples
- update_gateway_information
Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request. For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.
UPDATE aws.storagegateway.gateway_informations
SET
GatewayARN = '{{ GatewayARN }}',
GatewayName = '{{ GatewayName }}',
GatewayTimezone = '{{ GatewayTimezone }}',
CloudWatchLogGroupARN = '{{ CloudWatchLogGroupARN }}',
GatewayCapacity = '{{ GatewayCapacity }}'
WHERE
region = '{{ region }}' --required
AND GatewayARN = '{{ GatewayARN }}' --required
RETURNING
gateway_arn,
gateway_name;