AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Class: Aws::StorageGateway::Types::DescribeGatewayInformationOutput

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb

Overview

A JSON object containing the following fields:

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#cloud_watch_log_group_arnString

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that is used to monitor events in the gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#deprecation_dateString

Date after which this gateway will not receive software updates for new features and bug fixes.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_idString

The ID of the Amazon EC2 instance that was used to launch the gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#ec2_instance_regionString

The Amazon Web Services Region where the Amazon EC2 instance is located.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#endpoint_typeString

The type of endpoint for your gateway.

Valid Values: STANDARD | FIPS

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_arnString

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.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_capacityString

Specifies the size of the gateway's metadata cache.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_idString

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.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_nameString

The name you configured for your gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_network_interfacesArray<Types::NetworkInterface>

A NetworkInterface array that contains descriptions of the gateway network interfaces.

Returns:



3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_stateString

A value that indicates the operating state of the gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_timezoneString

A value that indicates the time zone configured for the gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_typeString

The type of the gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#host_environmentString

The type of hypervisor environment used by the host.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#last_software_updateString

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.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#next_update_availability_dateString

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.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#software_updates_end_dateString

Date after which this gateway will not receive software updates for new features.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#supported_gateway_capacitiesArray<String>

A list of the metadata cache sizes that the gateway can support based on its current hardware specifications.

Returns:

  • (Array<String>)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#tagsArray<Types::Tag>

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.

Returns:



3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end

#vpc_endpointString

The configuration settings for the virtual private cloud (VPC) endpoint for your gateway.

Returns:

  • (String)


3357
3358
3359
3360
3361
3362
3363
3364
3365
3366
3367
3368
3369
3370
3371
3372
3373
3374
3375
3376
3377
3378
3379
3380
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 3357

class DescribeGatewayInformationOutput < Struct.new(
  :gateway_arn,
  :gateway_id,
  :gateway_name,
  :gateway_timezone,
  :gateway_state,
  :gateway_network_interfaces,
  :gateway_type,
  :next_update_availability_date,
  :last_software_update,
  :ec2_instance_id,
  :ec2_instance_region,
  :tags,
  :vpc_endpoint,
  :cloud_watch_log_group_arn,
  :host_environment,
  :endpoint_type,
  :software_updates_end_date,
  :deprecation_date,
  :gateway_capacity,
  :supported_gateway_capacities)
  SENSITIVE = []
  include Aws::Structure
end