[ aws . backup-gateway ]

create-gateway

Description

Creates a backup gateway. After you create a gateway, you can associate it with a server using the AssociateGatewayToServer operation.

See also: AWS API Documentation

See ‘aws help’ for descriptions of global parameters.

Synopsis

  create-gateway
--activation-key <value>
--gateway-display-name <value>
--gateway-type <value>
[--tags <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]

Options

--activation-key (string)

The activation key of the created gateway.

--gateway-display-name (string)

The display name of the created gateway.

--gateway-type (string)

The type of created gateway.

Possible values:

  • BACKUP_VM

--tags (list)

A list of up to 50 tags to assign to the gateway. Each tag is a key-value pair.

(structure)

A key-value pair you can use to manage, filter, and search for your resources. Allowed characters include UTF-8 letters, numbers, spaces, and the following characters: + - = . _ : /.

Key -> (string)

The key part of a tag’s key-value pair. The key can’t start with aws: .

Value -> (string)

The key part of a value’s key-value pair.

Shorthand Syntax:

Key=string,Value=string ...

JSON Syntax:

[
  {
    "Key": "string",
    "Value": "string"
  }
  ...
]

--cli-input-json | --cli-input-yaml (string) Reads arguments from the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton. If other arguments are provided on the command line, those values will override the JSON-provided values. It is not possible to pass arbitrary binary values using a JSON-provided value as the string will be taken literally. This may not be specified along with --cli-input-yaml.

--generate-cli-skeleton (string) Prints a JSON skeleton to standard output without sending an API request. If provided with no value or the value input, prints a sample input JSON that can be used as an argument for --cli-input-json. Similarly, if provided yaml-input it will print a sample input YAML that can be used with --cli-input-yaml. If provided with the value output, it validates the command inputs and returns a sample output JSON for that command.

See ‘aws help’ for descriptions of global parameters.

Output

GatewayArn -> (string)

The Amazon Resource Name (ARN) of the gateway you create.