You are viewing documentation for version 3 of the AWS SDK for Ruby. Version 2 documentation can be found here.

Class: Aws::StorageGateway::Types::ActivateGatewayInput

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

Overview

Note:

When making an API call, you may pass ActivateGatewayInput data as a hash:

{
  activation_key: "ActivationKey", # required
  gateway_name: "GatewayName", # required
  gateway_timezone: "GatewayTimezone", # required
  gateway_region: "RegionId", # required
  gateway_type: "GatewayType",
  tape_drive_type: "TapeDriveType",
  medium_changer_type: "MediumChangerType",
}

A JSON object containing one or more of the following fields:

  • ActivateGatewayInput$ActivationKey

  • ActivateGatewayInput$GatewayName

  • ActivateGatewayInput$GatewayRegion

  • ActivateGatewayInput$GatewayTimezone

  • ActivateGatewayInput$GatewayType

  • ActivateGatewayInput$TapeDriveType

  • ActivateGatewayInput$MediumChangerType

Instance Attribute Summary collapse

Instance Attribute Details

#activation_keyString

Your gateway activation key. You can obtain the activation key by sending an HTTP GET request with redirects enabled to the gateway IP address (port 80). The redirect URL returned in the response provides you the activation key for your gateway in the query string parameter activationKey. It may also include other activation-related parameters, however, these are merely defaults -- the arguments you pass to the ActivateGateway API call determine the actual configuration of your gateway.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#gateway_nameString

The name you configured for your gateway.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#gateway_regionString

A value that indicates the region where you want to store your data. The gateway region specified must be the same region as the region in your Host header in the request. For more information about available regions and endpoints for AWS Storage Gateway, see Regions and Endpoints in the Amazon Web Services Glossary.

Valid Values: "us-east-1", "us-east-2", "us-west-1", "us-west-2", "ca-central-1", "eu-west-1", "eu-central-1", "eu-west-2", "ap-northeast-1", "ap-northeast-2", "ap-southeast-1", "ap-southeast-2", "ap-south-1", "sa-east-1"

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#gateway_timezoneString

A value that indicates the time zone you want to set for the gateway. The time zone is of the format "GMT-hr:mm" or "GMT+hr:mm". For example, GMT-4:00 indicates the time is 4 hours behind GMT. GMT+2:00 indicates the time is 2 hours ahead of GMT. The time zone is used, for example, for scheduling snapshots and your gateway's maintenance schedule.

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#gateway_typeString

A value that defines the type of gateway to activate. The type specified is critical to all later functions of the gateway and cannot be changed after activation. The default value is STORED.

Valid Values: "STORED", "CACHED", "VTL", "FILE_S3"

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#medium_changer_typeString

The value that indicates the type of medium changer to use for tape gateway. This field is optional.

Valid Values: "STK-L700", "AWS-Gateway-VTL"

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end

#tape_drive_typeString

The value that indicates the type of tape drive to use for tape gateway. This field is optional.

Valid Values: "IBM-ULT3580-TD5"

Returns:

  • (String)


106
107
108
109
110
111
112
113
114
115
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 106

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type)
  include Aws::Structure
end