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

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::DescribeGatewayInformationOutput

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-storagegateway/types.rb

Overview

A JSON object containing the following fields:

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[:gateway_network_interfaces]

Instance Attribute Summary

• #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.

• #deprecation_date ⇒ String

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

• #ec2_instance_id ⇒ String

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

• #ec2_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.

• #gateway_arn ⇒ String

  The Amazon Resource Name (ARN) of the gateway.

• #gateway_capacity ⇒ String

  Specifies the size of the gateway’s metadata cache.

• #gateway_id ⇒ String

  The unique identifier assigned to your gateway during activation.

• #gateway_name ⇒ String

  The name you configured for your gateway.

• #gateway_network_interfaces ⇒ Array<Types::NetworkInterface>

  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.

• #host_environment ⇒ String

  The type of hardware or software platform on which the gateway is running.

• #host_environment_id ⇒ String

  A unique identifier for the specific instance of the host platform running the gateway.

• #last_software_update ⇒ String

  The date on which the last software update was applied to the gateway.

• #next_update_availability_date ⇒ String

  The date on which an update to the gateway is available.

• #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<String>

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

• #tags ⇒ Array<Types::Tag>

  A list of up to 50 tags assigned to the gateway, sorted alphabetically by key name.

• #vpc_endpoint ⇒ String

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

Instance Attribute Details

#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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#deprecation_date ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#ec2_instance_id ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#ec2_instance_region ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#endpoint_type ⇒ String

The type of endpoint for your gateway.

Valid Values: ‘STANDARD` | `FIPS`

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_capacity ⇒ String

Specifies the size of the gateway’s metadata cache.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_name ⇒ String

The name you configured for your gateway.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_network_interfaces ⇒ Array<Types::NetworkInterface>

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

Returns:

• (Array<Types::NetworkInterface>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_state ⇒ String

A value that indicates the operating state of the gateway.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_timezone ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#gateway_type ⇒ String

The type of the gateway.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#host_environment ⇒ String

The type of hardware or software platform on which the gateway is running.

<note markdown=“1”> Tape Gateway is no longer available on Snow Family devices.

</note>

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#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.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#software_updates_end_date ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#software_version ⇒ String

The version number of the software running on the gateway appliance.

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#supported_gateway_capacities ⇒ Array<String>

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

Returns:

• (Array<String>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#tags ⇒ Array<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:

• (Array<Types::Tag>)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end

#vpc_endpoint ⇒ String

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

Returns:

• (String)

# File 'lib/aws-sdk-storagegateway/types.rb', line 2978

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,
  :host_environment_id,
  :software_version)
  SENSITIVE = [:gateway_network_interfaces]
  include Aws::Structure
end