Update Cross Account Attachment

globalaccelerator_update_cross_account_attachment

R Documentation

Update a cross-account attachment to add or remove principals or resources

Description

Update a cross-account attachment to add or remove principals or resources. When you update an attachment to remove a principal (account ID or accelerator) or a resource, Global Accelerator revokes the permission for specific resources.

For more information, see Working with cross-account attachments and resources in Global Accelerator in the Global Accelerator Developer Guide.

Usage

globalaccelerator_update_cross_account_attachment(AttachmentArn, Name,
  AddPrincipals, RemovePrincipals, AddResources, RemoveResources)

Arguments

AttachmentArn

[required] The Amazon Resource Name (ARN) of the cross-account attachment to update.

Name

The name of the cross-account attachment.

AddPrincipals

The principals to add to the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

To add more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

RemovePrincipals

The principals to remove from the cross-account attachment. A principal is an account or the Amazon Resource Name (ARN) of an accelerator that the attachment gives permission to work with resources from another account. The resources are also listed in the attachment.

To remove more than one principal, separate the account numbers or accelerator ARNs, or both, with commas.

AddResources

The resources to add to the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

To add more than one resource, separate the resource ARNs with commas.

RemoveResources

The resources to remove from the cross-account attachment. A resource listed in a cross-account attachment can be used with an accelerator by the principals that are listed in the attachment.

To remove more than one resource, separate the resource ARNs with commas.

Value

A list with the following syntax:

list(
  CrossAccountAttachment = list(
    AttachmentArn = "string",
    Name = "string",
    Principals = list(
      "string"
    ),
    Resources = list(
      list(
        EndpointId = "string",
        Cidr = "string",
        Region = "string"
      )
    ),
    LastModifiedTime = as.POSIXct(
      "2015-01-01"
    ),
    CreatedTime = as.POSIXct(
      "2015-01-01"
    )
  )
)

Request syntax

svc$update_cross_account_attachment(
  AttachmentArn = "string",
  Name = "string",
  AddPrincipals = list(
    "string"
  ),
  RemovePrincipals = list(
    "string"
  ),
  AddResources = list(
    list(
      EndpointId = "string",
      Cidr = "string",
      Region = "string"
    )
  ),
  RemoveResources = list(
    list(
      EndpointId = "string",
      Cidr = "string",
      Region = "string"
    )
  )
)