paws.storage (version 0.1.4)

storagegateway_activate_gateway: Activates the gateway you previously deployed on your host

Description

Activates the gateway you previously deployed on your host. In the activation process, you specify information such as the region you want to use for storing snapshots or tapes, the time zone for scheduled snapshots the gateway snapshot schedule window, an activation key, and a name for your gateway. The activation process also associates your gateway with your account; for more information, see UpdateGatewayInformation.

Usage

storagegateway_activate_gateway(ActivationKey, GatewayName,
  GatewayTimezone, GatewayRegion, GatewayType, TapeDriveType,
  MediumChangerType, Tags)

Arguments

ActivationKey

[required] 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.

GatewayName

[required] The name you configured for your gateway.

GatewayTimezone

[required] 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.

GatewayRegion

[required] 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: See AWS Storage Gateway Regions and Endpoints in the AWS General Reference.

GatewayType

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"

TapeDriveType

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

Valid Values: "IBM-ULT3580-TD5"

MediumChangerType

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"

Tags

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

Valid characters for key and value are letters, spaces, and numbers representable 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.

Request syntax

svc$activate_gateway(
  ActivationKey = "string",
  GatewayName = "string",
  GatewayTimezone = "string",
  GatewayRegion = "string",
  GatewayType = "string",
  TapeDriveType = "string",
  MediumChangerType = "string",
  Tags = list(
    list(
      Key = "string",
      Value = "string"
    )
  )
)

Details

You must turn on the gateway VM before you can activate your gateway.

Examples

# NOT RUN {
# Activates the gateway you previously deployed on your host.
# }
# NOT RUN {
svc$activate_gateway(
  ActivationKey = "29AV1-3OFV9-VVIUB-NKT0I-LRO6V",
  GatewayName = "My_Gateway",
  GatewayRegion = "us-east-1",
  GatewayTimezone = "GMT-12:00",
  GatewayType = "STORED",
  MediumChangerType = "AWS-Gateway-VTL",
  TapeDriveType = "IBM-ULT3580-TD5"
)
# }
# NOT RUN {
# }