AWS CLI version 2, the latest major version of AWS CLI, is now stable and recommended for general use. To view this page for the AWS CLI version 2, click here. For more information see the AWS CLI version 2 installation instructions and migration guide.
[ aws . globalaccelerator ]
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 .
See also: AWS API Documentation
update-cross-account-attachment
--attachment-arn <value>
[--name <value>]
[--add-principals <value>]
[--remove-principals <value>]
[--add-resources <value>]
[--remove-resources <value>]
[--cli-input-json <value>]
[--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>]
--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 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)
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 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)
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 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.
(structure)
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.
Shorthand Syntax:
EndpointId=string,Cidr=string,Region=string ...
JSON Syntax:
[
{
"EndpointId": "string",
"Cidr": "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 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.
(structure)
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.
Shorthand Syntax:
EndpointId=string,Cidr=string,Region=string ...
JSON Syntax:
[
{
"EndpointId": "string",
"Cidr": "string",
"Region": "string"
}
...
]
--cli-input-json
(string)
Performs service operation based on the JSON string provided. The JSON string follows the format provided by --generate-cli-skeleton
. If other arguments are provided on the command line, the CLI 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.
--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
. If provided with the value output
, it validates the command inputs and returns a sample output JSON for that command.
--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. If automatic pagination is disabled, the AWS CLI will only make one call, for the first page of results.
--output
(string)
The formatting style for command output.
--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.
--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.
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)
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 -> (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.