Class: Aws::StorageGateway::Types::GatewayInfo

Inherits:

Struct

• Object
• Struct
• Aws::StorageGateway::Types::GatewayInfo

Includes:

Aws::Structure

Defined in:

lib/aws-sdk-storagegateway/types.rb

Overview

Describes a gateway object.

See Also:

• AWS API Documentation

Constant Summary

SENSITIVE =

[]

Instance Attribute Summary

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

• #gateway_arn ⇒ String

  The Amazon Resource Name (ARN) of the gateway.

• #gateway_id ⇒ String

  The unique identifier assigned to your gateway during activation.

• #gateway_name ⇒ String

  The name of the gateway.

• #gateway_operational_state ⇒ String

  The state of 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.

• #software_version ⇒ String

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

Instance Attribute Details

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

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_name ⇒ String

The name of the gateway.

Returns:

• (String)

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

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  include Aws::Structure
end

#gateway_operational_state ⇒ String

The state of the gateway.

Valid Values: ‘DISABLED` | `ACTIVE`

Returns:

• (String)

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

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  include Aws::Structure
end

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

[1]: aws.amazon.com/blogs/storage/switch-your-file-share-access-from-amazon-fsx-file-gateway-to-amazon-fsx-for-windows-file-server/

Returns:

• (String)

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

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  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 4240

class GatewayInfo < Struct.new(
  :gateway_id,
  :gateway_arn,
  :gateway_type,
  :gateway_operational_state,
  :gateway_name,
  :ec2_instance_id,
  :ec2_instance_region,
  :host_environment,
  :host_environment_id,
  :deprecation_date,
  :software_version)
  SENSITIVE = []
  include Aws::Structure
end