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",
  tags: [
    {
      key: "TagKey", # required
      value: "TagValue", # required
    },
  ],
}

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.

For more information, see https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html in the Storage Gateway User Guide.

Returns:

  • (String)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

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

#gateway_nameString

The name you configured for your gateway.

Returns:

  • (String)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

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

#gateway_regionString

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

Valid Values: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.

Returns:

  • (String)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type,
  :tags)
  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)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type,
  :tags)
  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 CACHED.

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

Returns:

  • (String)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type,
  :tags)
  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)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

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

#tagsArray<Types::Tag>

A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.

Valid characters for key and value are letters, spaces, and numbers that can be represented in UTF-8 format, and the following special characters: + - = . _ : / @. The maximum length of a tag's key is 128 characters, and the maximum length for a tag's value is 256 characters.

Returns:



127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

class ActivateGatewayInput < Struct.new(
  :activation_key,
  :gateway_name,
  :gateway_timezone,
  :gateway_region,
  :gateway_type,
  :tape_drive_type,
  :medium_changer_type,
  :tags)
  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)


127
128
129
130
131
132
133
134
135
136
137
# File 'gems/aws-sdk-storagegateway/lib/aws-sdk-storagegateway/types.rb', line 127

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