You are viewing documentation for version 2 of the AWS SDK for Ruby. Version 3 documentation can be found here.
Class: Aws::StorageGateway::Types::ActivateGatewayInput
- Inherits:
-
Struct
- Object
- Struct
- Aws::StorageGateway::Types::ActivateGatewayInput
- Defined in:
- (unknown)
Overview
When passing ActivateGatewayInput as input to an Aws::Client method, you can use a vanilla 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:
Instance Attribute Summary collapse
-
#activation_key ⇒ String
Your gateway activation key.
-
#gateway_name ⇒ String
The name you configured for your gateway.
-
#gateway_region ⇒ String
A value that indicates the AWS Region where you want to store your data.
-
#gateway_timezone ⇒ String
A value that indicates the time zone you want to set for the gateway.
-
#gateway_type ⇒ String
A value that defines the type of gateway to activate.
-
#medium_changer_type ⇒ String
The value that indicates the type of medium changer to use for tape gateway.
-
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that you can assign to the gateway.
-
#tape_drive_type ⇒ String
The value that indicates the type of tape drive to use for tape gateway.
Instance Attribute Details
#activation_key ⇒ String
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 Getting activation key in the AWS Storage Gateway User Guide.
#gateway_name ⇒ String
The name you configured for your gateway.
#gateway_region ⇒ String
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 AWS
Storage Gateway endpoints and quotas in the AWS General Reference.
Valid Values: See AWS Storage Gateway endpoints and quotas in the AWS General Reference.
#gateway_timezone ⇒ String
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.
#gateway_type ⇒ String
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
#medium_changer_type ⇒ String
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
| IBM-03584L32-0402
#tags ⇒ Array<Types::Tag>
A list of up to 50 tags that you can assign to the gateway. Each tag is a key-value pair.
#tape_drive_type ⇒ String
The value that indicates the type of tape drive to use for tape gateway. This field is optional.
Valid Values: IBM-ULT3580-TD5