Client

backupgateway

R Documentation

AWS Backup Gateway¶

Description¶

Backup gateway

Backup gateway connects Backup to your hypervisor, so you can create, store, and restore backups of your virtual machines (VMs) anywhere, whether on-premises or in the VMware Cloud (VMC) on Amazon Web Services.

Add on-premises resources by connecting to a hypervisor through a gateway. Backup will automatically discover the resources in your hypervisor.

Use Backup to assign virtual or on-premises resources to a backup plan, or run on-demand backups. Once you have backed up your resources, you can view them and restore them like any resource supported by Backup.

To download the Amazon Web Services software to get started, navigate to the Backup console, choose Gateways, then choose Create gateway.

Usage¶

backupgateway(
  config = list(),
  credentials = list(),
  endpoint = NULL,
  region = NULL
)

Arguments¶

config

Optional configuration of credentials, endpoint, and/or region.

credentials:
- creds:
  - access_key_id: AWS access key ID
  - secret_access_key: AWS secret access key
  - session_token: AWS temporary session token
- profile: The name of a profile to use. If not given, then the default profile is used.
- anonymous: Set anonymous credentials.
endpoint: The complete URL to use for the constructed client.
region: The AWS Region used in instantiating the client.
close_connection: Immediately close all HTTP connections.
timeout: The time in seconds till a timeout exception is thrown when attempting to make a connection. The default is 60 seconds.
s3_force_path_style: Set this to true to force the request to use path-style addressing, i.e. ⁠http://s3.amazonaws.com/BUCKET/KEY⁠.
sts_regional_endpoint: Set sts regional endpoint resolver to regional or legacy https://docs.aws.amazon.com/sdkref/latest/guide/feature-sts-regionalized-endpoints.html

credentials

Optional credentials shorthand for the config parameter

creds:
- access_key_id: AWS access key ID
- secret_access_key: AWS secret access key
- session_token: AWS temporary session token
profile: The name of a profile to use. If not given, then the default profile is used.
anonymous: Set anonymous credentials.

endpoint

Optional shorthand for complete URL to use for the constructed client.

region

Optional shorthand for AWS Region used in instantiating the client.

Value¶

A client for the service. You can call the service's operations using syntax like svc$operation(...), where svc is the name you've assigned to the client. The available operations are listed in the Operations section.

Service syntax¶

svc <- backupgateway(
  config = list(
    credentials = list(
      creds = list(
        access_key_id = "string",
        secret_access_key = "string",
        session_token = "string"
      ),
      profile = "string",
      anonymous = "logical"
    ),
    endpoint = "string",
    region = "string",
    close_connection = "logical",
    timeout = "numeric",
    s3_force_path_style = "logical",
    sts_regional_endpoint = "string"
  ),
  credentials = list(
    creds = list(
      access_key_id = "string",
      secret_access_key = "string",
      session_token = "string"
    ),
    profile = "string",
    anonymous = "logical"
  ),
  endpoint = "string",
  region = "string"
)

Operations¶

associate_gateway_to_server: Associates a backup gateway with your server
create_gateway: Creates a backup gateway
delete_gateway: Deletes a backup gateway
delete_hypervisor: Deletes a hypervisor
disassociate_gateway_from_server: Disassociates a backup gateway from the specified server
get_bandwidth_rate_limit_schedule: Retrieves the bandwidth rate limit schedule for a specified gateway
get_gateway: By providing the ARN (Amazon Resource Name), this API returns the gateway
get_hypervisor: This action requests information about the specified hypervisor to which the gateway will connect
get_hypervisor_property_mappings: This action retrieves the property mappings for the specified hypervisor
get_virtual_machine: By providing the ARN (Amazon Resource Name), this API returns the virtual machine
import_hypervisor_configuration: Connect to a hypervisor by importing its configuration
list_gateways: Lists backup gateways owned by an Amazon Web Services account in an Amazon Web Services Region
list_hypervisors: Lists your hypervisors
list_tags_for_resource: Lists the tags applied to the resource identified by its Amazon Resource Name (ARN)
list_virtual_machines: Lists your virtual machines
put_bandwidth_rate_limit_schedule: This action sets the bandwidth rate limit schedule for a specified gateway
put_hypervisor_property_mappings: This action sets the property mappings for the specified hypervisor
put_maintenance_start_time: Set the maintenance start time for a gateway
start_virtual_machines_metadata_sync: This action sends a request to sync metadata across the specified virtual machines
tag_resource: Tag the resource
test_hypervisor_configuration: Tests your hypervisor configuration to validate that backup gateway can connect with the hypervisor and its resources
untag_resource: Removes tags from the resource
update_gateway_information: Updates a gateway's name
update_gateway_software_now: Updates the gateway virtual machine (VM) software
update_hypervisor: Updates a hypervisor metadata, including its host, username, and password

Examples¶

## Not run: 
svc <- backupgateway()
svc$associate_gateway_to_server(
  Foo = 123
)

## End(Not run)