Update Gateway Information

storagegateway_update_gateway_information

R Documentation

Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size¶

Description¶

Updates a gateway's metadata, which includes the gateway's name, time zone, and metadata cache size. To specify which gateway to update, use the Amazon Resource Name (ARN) of the gateway in your request.

For gateways activated after September 2, 2015, the gateway's ARN contains the gateway ID rather than the gateway name. However, changing the name of the gateway has no effect on the gateway's ARN.

Usage¶

storagegateway_update_gateway_information(GatewayARN, GatewayName,
  GatewayTimezone, CloudWatchLogGroupARN, GatewayCapacity)

Arguments¶

GatewayARN

[required]

GatewayName

GatewayTimezone

A value that indicates the time zone of the gateway.

CloudWatchLogGroupARN

The Amazon Resource Name (ARN) of the Amazon CloudWatch log group that you want to use to monitor and log events in the gateway.

For more information, see What is Amazon CloudWatch Logs?

GatewayCapacity

Specifies the size of the gateway's metadata cache. This setting impacts gateway performance and hardware recommendations. For more information, see Performance guidance for gateways with multiple file shares in the Amazon S3 File Gateway User Guide.

Value¶

A list with the following syntax:

list(
  GatewayARN = "string",
  GatewayName = "string"
)

Request syntax¶

svc$update_gateway_information(
  GatewayARN = "string",
  GatewayName = "string",
  GatewayTimezone = "string",
  CloudWatchLogGroupARN = "string",
  GatewayCapacity = "Small"|"Medium"|"Large"
)

Examples¶

## Not run: 
# Updates a gateway's metadata, which includes the gateway's name and time
# zone.
svc$update_gateway_information(
  GatewayARN = "arn:aws:storagegateway:us-east-1:111122223333:gateway/sgw-12A3456B",
  GatewayName = "MyGateway2",
  GatewayTimezone = "GMT-12:00"
)

## End(Not run)