1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215
|
// Code generated by smithy-go-codegen DO NOT EDIT.
package storagegateway
import (
"context"
"fmt"
awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
"github.com/aws/aws-sdk-go-v2/service/storagegateway/types"
"github.com/aws/smithy-go/middleware"
smithyhttp "github.com/aws/smithy-go/transport/http"
)
// 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.
func (c *Client) ActivateGateway(ctx context.Context, params *ActivateGatewayInput, optFns ...func(*Options)) (*ActivateGatewayOutput, error) {
if params == nil {
params = &ActivateGatewayInput{}
}
result, metadata, err := c.invokeOperation(ctx, "ActivateGateway", params, optFns, c.addOperationActivateGatewayMiddlewares)
if err != nil {
return nil, err
}
out := result.(*ActivateGatewayOutput)
out.ResultMetadata = metadata
return out, nil
}
// A JSON object containing one or more of the following fields:
// - ActivateGatewayInput$ActivationKey
// - ActivateGatewayInput$GatewayName
// - ActivateGatewayInput$GatewayRegion
// - ActivateGatewayInput$GatewayTimezone
// - ActivateGatewayInput$GatewayType
// - ActivateGatewayInput$MediumChangerType
// - ActivateGatewayInput$TapeDriveType
type ActivateGatewayInput struct {
// 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 (https://docs.aws.amazon.com/storagegateway/latest/userguide/get-activation-key.html)
// in the Storage Gateway User Guide.
//
// This member is required.
ActivationKey *string
// The name you configured for your gateway.
//
// This member is required.
GatewayName *string
// 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 Host
// header in the request. For more information about available Amazon Web Services
// Regions and endpoints for Storage Gateway, see Storage Gateway endpoints and
// quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web
// Services General Reference. Valid Values: See Storage Gateway endpoints and
// quotas (https://docs.aws.amazon.com/general/latest/gr/sg.html) in the Amazon Web
// Services General Reference.
//
// This member is required.
GatewayRegion *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.
//
// This member is required.
GatewayTimezone *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 |
// VTL_SNOW | FILE_S3 | FILE_FSX_SMB
GatewayType *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
MediumChangerType *string
// 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.
Tags []types.Tag
// The value that indicates the type of tape drive to use for tape gateway. This
// field is optional. Valid Values: IBM-ULT3580-TD5
TapeDriveType *string
noSmithyDocumentSerde
}
// Storage Gateway returns the Amazon Resource Name (ARN) of the activated
// gateway. It is a string made of information such as your account, gateway name,
// and Amazon Web Services Region. This ARN is used to reference the gateway in
// other API operations as well as resource-based authorization. For gateways
// activated prior to September 02, 2015, the gateway ARN contains the gateway name
// rather than the gateway ID. Changing the name of the gateway has no effect on
// the gateway ARN.
type ActivateGatewayOutput struct {
// The Amazon Resource Name (ARN) of the gateway. Use the ListGateways operation
// to return a list of gateways for your account and Amazon Web Services Region.
GatewayARN *string
// Metadata pertaining to the operation's result.
ResultMetadata middleware.Metadata
noSmithyDocumentSerde
}
func (c *Client) addOperationActivateGatewayMiddlewares(stack *middleware.Stack, options Options) (err error) {
if err := stack.Serialize.Add(&setOperationInputMiddleware{}, middleware.After); err != nil {
return err
}
err = stack.Serialize.Add(&awsAwsjson11_serializeOpActivateGateway{}, middleware.After)
if err != nil {
return err
}
err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpActivateGateway{}, middleware.After)
if err != nil {
return err
}
if err := addProtocolFinalizerMiddlewares(stack, options, "ActivateGateway"); err != nil {
return fmt.Errorf("add protocol finalizers: %v", err)
}
if err = addlegacyEndpointContextSetter(stack, options); err != nil {
return err
}
if err = addSetLoggerMiddleware(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
return err
}
if err = addResolveEndpointMiddleware(stack, options); err != nil {
return err
}
if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
return err
}
if err = addRetryMiddlewares(stack, options); err != nil {
return err
}
if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
return err
}
if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
return err
}
if err = addClientUserAgent(stack, options); err != nil {
return err
}
if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
return err
}
if err = addSetLegacyContextSigningOptionsMiddleware(stack); err != nil {
return err
}
if err = addOpActivateGatewayValidationMiddleware(stack); err != nil {
return err
}
if err = stack.Initialize.Add(newServiceMetadataMiddleware_opActivateGateway(options.Region), middleware.Before); err != nil {
return err
}
if err = awsmiddleware.AddRecursionDetection(stack); err != nil {
return err
}
if err = addRequestIDRetrieverMiddleware(stack); err != nil {
return err
}
if err = addResponseErrorMiddleware(stack); err != nil {
return err
}
if err = addRequestResponseLogging(stack, options); err != nil {
return err
}
if err = addDisableHTTPSMiddleware(stack, options); err != nil {
return err
}
return nil
}
func newServiceMetadataMiddleware_opActivateGateway(region string) *awsmiddleware.RegisterServiceMetadata {
return &awsmiddleware.RegisterServiceMetadata{
Region: region,
ServiceID: ServiceID,
OperationName: "ActivateGateway",
}
}
|