AWS CLI Command Reference

[ aws . globalaccelerator ]

update-cross-account-attachment

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 by doing the following:

  • If the principal is an account ID, Global Accelerator reviews every accelerator in the account and removes cross-account endpoints from all accelerators.
  • If the principal is an accelerator, Global Accelerator reviews just that accelerator and removes cross-account endpoints from it.

If there are overlapping permissions provided by multiple cross-account attachments, Global Accelerator only removes endpoints if there are no current cross-account attachments that provide access permission. For example, if you delete a cross-account attachment that lists an accelerator as a principal, but another cross-account attachment includes the account ID that owns that accelerator, endpoints will not be removed from the accelerator.

See also: AWS API Documentation

Synopsis

  update-cross-account-attachment
--attachment-arn <value>
[--name <value>]
[--add-principals <value>]
[--remove-principals <value>]
[--add-resources <value>]
[--remove-resources <value>]
[--cli-input-json | --cli-input-yaml]
[--generate-cli-skeleton <value>]
[--debug]
[--endpoint-url <value>]
[--no-verify-ssl]
[--no-paginate]
[--output <value>]
[--query <value>]
[--profile <value>]
[--region <value>]
[--version <value>]
[--color <value>]
[--no-sign-request]
[--ca-bundle <value>]
[--cli-read-timeout <value>]
[--cli-connect-timeout <value>]
[--cli-binary-format <value>]
[--no-cli-pager]
[--cli-auto-prompt]
[--no-cli-auto-prompt]

Options

--attachment-arn (string)

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

--name (string)

The name of the cross-account attachment.

--add-principals (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 add the resources from another account, listed in the attachment.

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

(string)

Syntax:

"string" "string" ...

--remove-principals (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 is given permission to add the resources from another account, listed in the cross-account attachment.

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

(string)

Syntax:

"string" "string" ...

--add-resources (list)

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

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

(structure)

An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.

EndpointId -> (string)

The endpoint ID for the endpoint (Amazon Web Services resource).

Region -> (string)

The Amazon Web Services Region where a resource is located.

Shorthand Syntax:

EndpointId=string,Region=string ...

JSON Syntax:

[
  {
    "EndpointId": "string",
    "Region": "string"
  }
  ...
]

--remove-resources (list)

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

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

(structure)

An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.

EndpointId -> (string)

The endpoint ID for the endpoint (Amazon Web Services resource).

Region -> (string)

The Amazon Web Services Region where a resource is located.

Shorthand Syntax:

EndpointId=string,Region=string ...

JSON Syntax:

[
  {
    "EndpointId": "string",
    "Region": "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. The generated JSON skeleton is not stable between versions of the AWS CLI and there are no backwards compatibility guarantees in the JSON skeleton generated.

Global Options

--debug (boolean)

Turn on debug logging.

--endpoint-url (string)

Override command’s default URL with the given URL.

--no-verify-ssl (boolean)

By default, the AWS CLI uses SSL when communicating with AWS services. For each SSL connection, the AWS CLI will verify SSL certificates. This option overrides the default behavior of verifying SSL certificates.

--no-paginate (boolean)

Disable automatic pagination.

--output (string)

The formatting style for command output.

  • json
  • text
  • table
  • yaml
  • yaml-stream

--query (string)

A JMESPath query to use in filtering the response data.

--profile (string)

Use a specific profile from your credential file.

--region (string)

The region to use. Overrides config/env settings.

--version (string)

Display the version of this tool.

--color (string)

Turn on/off color output.

  • on
  • off
  • auto

--no-sign-request (boolean)

Do not sign requests. Credentials will not be loaded if this argument is provided.

--ca-bundle (string)

The CA certificate bundle to use when verifying SSL certificates. Overrides config/env settings.

--cli-read-timeout (int)

The maximum socket read time in seconds. If the value is set to 0, the socket read will be blocking and not timeout. The default value is 60 seconds.

--cli-connect-timeout (int)

The maximum socket connect time in seconds. If the value is set to 0, the socket connect will be blocking and not timeout. The default value is 60 seconds.

--cli-binary-format (string)

The formatting style to be used for binary blobs. The default format is base64. The base64 format expects binary blobs to be provided as a base64 encoded string. The raw-in-base64-out format preserves compatibility with AWS CLI V1 behavior and binary values must be passed literally. When providing contents from a file that map to a binary blob fileb:// will always be treated as binary and use the file contents directly regardless of the cli-binary-format setting. When using file:// the file contents will need to properly formatted for the configured cli-binary-format.

  • base64
  • raw-in-base64-out

--no-cli-pager (boolean)

Disable cli pager for output.

--cli-auto-prompt (boolean)

Automatically prompt for CLI input parameters.

--no-cli-auto-prompt (boolean)

Disable automatically prompt for CLI input parameters.

Output

CrossAccountAttachment -> (structure)

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.

(structure)

An Amazon Web Services resource that is supported by Global Accelerator and can be added as an endpoint for an accelerator.

EndpointId -> (string)

The endpoint ID for the endpoint (Amazon Web Services resource).

Region -> (string)

The Amazon Web Services Region where a resource is located.

LastModifiedTime -> (timestamp)

The date and time that the cross-account attachment was last modified.

CreatedTime -> (timestamp)

The date and time that the cross-account attachment was created.
© Copyright 2018, Amazon Web Services. Created using Sphinx.