AWS SDK Version 3 for .NET
API Reference

AWS services or capabilities described in AWS Documentation may vary by region/location. Click Getting Started with Amazon AWS to see specific differences applicable to the China (Beijing) Region.

Container for the parameters to the ActivateGateway operation. Activates the gateway you previously deployed on your host. For more information, see Activate the AWS Storage Gateway. 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.

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

Inheritance Hierarchy

System.Object
  Amazon.Runtime.AmazonWebServiceRequest
    Amazon.StorageGateway.AmazonStorageGatewayRequest
      Amazon.StorageGateway.Model.ActivateGatewayRequest

Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z

Syntax

C#
public class ActivateGatewayRequest : AmazonStorageGatewayRequest
         IAmazonWebServiceRequest

The ActivateGatewayRequest type exposes the following members

Constructors

NameDescription
Public Method ActivateGatewayRequest()

Properties

NameTypeDescription
Public Property ActivationKey System.String

Gets and sets the property ActivationKey.

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.

Public Property GatewayName System.String

Gets and sets the property GatewayName.

The name you configured for your gateway.

Public Property GatewayRegion System.String

Gets and sets the property GatewayRegion.

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"

Public Property GatewayTimezone System.String

Gets and sets the property GatewayTimezone.

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.

Public Property GatewayType System.String

Gets and sets the property 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 STORED.

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

Public Property MediumChangerType System.String

Gets and sets the property 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"

Public Property TapeDriveType System.String

Gets and sets the property TapeDriveType.

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

Valid Values: "IBM-ULT3580-TD5"

Examples

Activates the gateway you previously deployed on your host.

To activate the gateway


var response = client.ActivateGateway(new ActivateGatewayRequest 
{
    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"
});

string gatewayARN = response.GatewayARN;

            

Version Information

.NET Standard:
Supported in: 1.3

.NET Framework:
Supported in: 4.5, 4.0, 3.5

Portable Class Library:
Supported in: Windows Store Apps
Supported in: Windows Phone 8.1
Supported in: Xamarin Android
Supported in: Xamarin iOS (Unified)
Supported in: Xamarin.Forms