Skip to content

Update Accelerator

globalaccelerator_update_accelerator R Documentation

Update an accelerator to make changes, such as the following:

Description

Update an accelerator to make changes, such as the following:

  • Change the name of the accelerator.

  • Disable the accelerator so that it no longer accepts or routes traffic, or so that you can delete it.

  • Enable the accelerator, if it is disabled.

  • Change the IP address type to dual-stack if it is IPv4, or change the IP address type to IPv4 if it's dual-stack.

Be aware that static IP addresses remain assigned to your accelerator for as long as it exists, even if you disable the accelerator and it no longer accepts or routes traffic. However, when you delete the accelerator, you lose the static IP addresses that are assigned to it, so you can no longer route traffic by using them.

Global Accelerator is a global service that supports endpoints in multiple Amazon Web Services Regions but you must specify the US West (Oregon) Region to create, update, or otherwise work with accelerators. That is, for example, specify ⁠--region us-west-2⁠ on Amazon Web Services CLI commands.

Usage

globalaccelerator_update_accelerator(AcceleratorArn, Name,
  IpAddressType, IpAddresses, Enabled)

Arguments

AcceleratorArn

[required] The Amazon Resource Name (ARN) of the accelerator to update.

Name

The name of the accelerator. The name can have a maximum of 64 characters, must contain only alphanumeric characters, periods (.), or hyphens (-), and must not begin or end with a hyphen or period.

IpAddressType

The IP address type that an accelerator supports. For a standard accelerator, the value can be IPV4 or DUAL_STACK.

IpAddresses

The IP addresses for an accelerator.

Enabled

Indicates whether an accelerator is enabled. The value is true or false. The default value is true.

If the value is set to true, the accelerator cannot be deleted. If set to false, the accelerator can be deleted.

Value

A list with the following syntax: 

list(
  Accelerator = list(
    AcceleratorArn = "string",
    Name = "string",
    IpAddressType = "IPV4"|"DUAL_STACK",
    Enabled = TRUE|FALSE,
    IpSets = list(
      list(
        IpFamily = "string",
        IpAddresses = list(
          "string"
        ),
        IpAddressFamily = "IPv4"|"IPv6"
      )
    ),
    DnsName = "string",
    Status = "DEPLOYED"|"IN_PROGRESS",
    CreatedTime = as.POSIXct(
      "2015-01-01"
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    DualStackDnsName = "string",
    Events = list(
      list(
        Message = "string",
        Timestamp = as.POSIXct(
          "2015-01-01"
        )
      )
    )
  )
)

Request syntax

svc$update_accelerator(
  AcceleratorArn = "string",
  Name = "string",
  IpAddressType = "IPV4"|"DUAL_STACK",
  IpAddresses = list(
    "string"
  ),
  Enabled = TRUE|FALSE
)