GlobalAccelerator / Client / update_cross_account_attachment

update_cross_account_attachment#

GlobalAccelerator.Client.update_cross_account_attachment(**kwargs)#

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.

Request Syntax

response = client.update_cross_account_attachment(
    AttachmentArn='string',
    Name='string',
    AddPrincipals=[
        'string',
    ],
    RemovePrincipals=[
        'string',
    ],
    AddResources=[
        {
            'EndpointId': 'string',
            'Cidr': 'string',
            'Region': 'string'
        },
    ],
    RemoveResources=[
        {
            'EndpointId': 'string',
            'Cidr': 'string',
            'Region': 'string'
        },
    ]
)

Parameters:

AttachmentArn (string) –
[REQUIRED]

The Amazon Resource Name (ARN) of the cross-account attachment to update.
Name (string) – The name of the cross-account attachment.
AddPrincipals (list) –
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.
- (string) –
RemovePrincipals (list) –
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.
- (string) –
AddResources (list) –
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.
- (dict) –
  
  A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.
  - EndpointId (string) –
    
    The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.
    
    An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
  - Cidr (string) –
    
    An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator
    
    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  - Region (string) –
    
    The Amazon Web Services Region where a shared endpoint resource is located.
RemoveResources (list) –
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.
- (dict) –
  
  A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.
  - EndpointId (string) –
    
    The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.
    
    An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
  - Cidr (string) –
    
    An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator
    
    For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
  - Region (string) –
    
    The Amazon Web Services Region where a shared endpoint resource is located.

Return type:

dict

Returns:

Response Syntax

{
    'CrossAccountAttachment': {
        'AttachmentArn': 'string',
        'Name': 'string',
        'Principals': [
            'string',
        ],
        'Resources': [
            {
                'EndpointId': 'string',
                'Cidr': 'string',
                'Region': 'string'
            },
        ],
        'LastModifiedTime': datetime(2015, 1, 1),
        'CreatedTime': datetime(2015, 1, 1)
    }
}

Response Structure

(dict) –
- CrossAccountAttachment (dict) –
  
  Information about the updated cross-account attachment.
  - AttachmentArn (string) –
    
    The Amazon Resource Name (ARN) of the cross-account attachment.
  - Name (string) –
    
    The name of the cross-account attachment.
  - Principals (list) –
    
    The principals included in the cross-account attachment.
    - (string) –
  - Resources (list) –
    
    The resources included in the cross-account attachment.
    - (dict) –
      
      A resource is one of the following: the ARN for an Amazon Web Services resource that is supported by Global Accelerator to be added as an endpoint, or a CIDR range that specifies a bring your own IP (BYOIP) address pool.
      - EndpointId (string) –
        
        The endpoint ID for the endpoint that is specified as a Amazon Web Services resource.
        
        An endpoint ID for the cross-account feature is the ARN of an Amazon Web Services resource, such as a Network Load Balancer, that Global Accelerator supports as an endpoint for an accelerator.
      - Cidr (string) –
        
        An IP address range, in CIDR format, that is specified as resource. The address must be provisioned and advertised in Global Accelerator by following the bring your own IP address (BYOIP) process for Global Accelerator
        
        For more information, see Bring your own IP addresses (BYOIP) in the Global Accelerator Developer Guide.
      - Region (string) –
        
        The Amazon Web Services Region where a shared endpoint resource is located.
  - LastModifiedTime (datetime) –
    
    The date and time that the cross-account attachment was last modified.
  - CreatedTime (datetime) –
    
    The date and time that the cross-account attachment was created.

Exceptions

GlobalAccelerator.Client.exceptions.AttachmentNotFoundException
GlobalAccelerator.Client.exceptions.AccessDeniedException
GlobalAccelerator.Client.exceptions.InternalServiceErrorException
GlobalAccelerator.Client.exceptions.InvalidArgumentException
GlobalAccelerator.Client.exceptions.LimitExceededException
GlobalAccelerator.Client.exceptions.TransactionInProgressException