Skip to content

Create update-vpc-link.rst #9405

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 2 commits into
base: develop
Choose a base branch
from
Open

Create update-vpc-link.rst #9405

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
db69919
Create update-vpc-link.rst
sjpandruju Mar 26, 2025
32c790d
Update update-vpc-link.rst
sjpandruju Oct 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
47 changes: 47 additions & 0 deletions awscli/examples/apigateway/update-vpc-link.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
**Example 1: To update an existing VPC link name**

The following ``update-vpc-link`` example updates the name of the specified VPC link. ::

aws apigateway update-vpc-link \
--vpc-link-id ab3de6 \
--patch-operations op=replace,path=/name,value=my-vpc-link

Output::

{
"id": "ab3de6",
"name": "my-vpc-link",
"targetArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
],
"status": "AVAILABLE",
"statusMessage": "Your vpc link is ready for use",
"tags": {}
}

For more information, see `Updating existing VPC link <https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html>`__ in the *AWS CLI Command Reference*.


**Example 2: To update an existing VPC link name and description**

The following ``update-vpc-link`` example updates name of the specified VPC link. ::

aws apigateway update-vpc-link \
--vpc-link-id ab3de6 \
--patch-operations op=replace,path=/name,value=my-vpc-link op=replace,path=/description,value="My custom description"

Output::

{
"id": "ab3de6",
"name": "my-vpc-link",
"description": "My custom description",
"targetArns": [
"arn:aws:elasticloadbalancing:us-east-1:123456789012:loadbalancer/net/my-lb/12a456s89aaa12345"
],
"status": "AVAILABLE",
"statusMessage": "Your vpc link is ready for use",
"tags": {}
}

For more information, see `Updating existing VPC link <https://docs.aws.amazon.com/cli/latest/reference/apigateway/update-vpc-link.html>`__ in the *AWS CLI Command Reference*.