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. In the activation process,
you specify information such as the Amazon Web Services Region that 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.
Namespace: Amazon.StorageGateway.Model
Assembly: AWSSDK.StorageGateway.dll
Version: 3.x.y.z
public class ActivateGatewayRequest : AmazonStorageGatewayRequest IAmazonWebServiceRequest
The ActivateGatewayRequest type exposes the following members
Name | Description | |
---|---|---|
ActivateGatewayRequest() |
Name | Type | Description | |
---|---|---|---|
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 For more information, see Getting activation key in the Storage Gateway User Guide. |
|
GatewayName | System.String |
Gets and sets the property GatewayName. The name you configured for your gateway. |
|
GatewayRegion | System.String |
Gets and sets the property GatewayRegion.
A value that indicates the Amazon Web Services Region where you want to store your
data. The gateway Amazon Web Services Region specified must be the same Amazon Web
Services Region as the Amazon Web Services Region in your Valid Values: See Storage Gateway endpoints and quotas in the Amazon Web Services General Reference. |
|
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. |
|
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
Valid Values: |
|
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: |
|
Tags | System.Collections.Generic.List<Amazon.StorageGateway.Model.Tag> |
Gets and sets the property Tags. 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. |
|
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: |
Activates the gateway you previously deployed on your host.
var client = new AmazonStorageGatewayClient(); 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;
.NET Core App:
Supported in: 3.1
.NET Standard:
Supported in: 2.0
.NET Framework:
Supported in: 4.5, 4.0, 3.5