This is the multi-page printable view of this section. Click here to print.
List Transit Gateway Rules
1 - 1.2
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
[--rule_type <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (CURRENT)
| Version | Not Before |
|---|---|
| 1.2 | - |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
| rule_type optional | **** | Rule Type | TGW_VPC |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| rule_type | Rule Type | TGW_VPC |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
2 - 1.1
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (SUPPORTED)
| Version | Not Before |
|---|---|
| 1.1 | 20261130 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
3 - 1.0
scpcli vpc transit-gateway-rule list
--transit_gateway_id <value>
[--size <value>]
[--page <value>]
[--sort <value>]
[--id <value>]
[--tgw_connection_vpc_id <value>]
[--tgw_connection_vpc_name <value>]
[--source_type <value>]
[--destination_type <value>]
[--destination_cidr <value>]
[--state <value>]
Description
Get Transit Gateway Rule list.
State ACTIVE (DEPRECATED)
Deprecated versions with Not Before dates that have arrived or expired are no longer supported. We recommend using the latest version.
| Version | Not Before |
|---|---|
| 1.0 | 20251231 |
Parameters
| Name | Type | Description | Example |
|---|---|---|---|
| transit_gateway_id required | string | Transit Gateway ID | fe860e0af0c04dcd8182b84f907f31f4 |
| size optional | integer | size | 20 |
| page optional | integer | page | 0 |
| sort optional | string | sort | created_at:desc |
| id optional | string | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| tgw_connection_vpc_id optional | string | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name optional | string | VPC Name Connected to Transit Gateway. | ConnectedVpcName |
| source_type optional | **** | Source Type | TGW |
| destination_type optional | **** | Destination Type | VPC |
| destination_cidr optional | string | Destination CIDR | 192.167.5.0/24 |
| state optional | **** | State | ACTIVE |
Responses
| Name | Description | Example |
|---|---|---|
| id | Routing Rule ID | 43772aff4539403d9ba74bf1fdaa00c8 |
| account_id | Account ID | f1e6c81a2b054582878cb9724dc2ce9f |
| created_at | Created At | 2024-05-17T00:23:17Z |
| created_by | Created By | 90dddfc2b1e04edba54ba2b41539a9ac |
| description | Description | Routing Rule Description |
| destination_cidr | Destination CIDR | 192.167.5.0/24 |
| destination_resource_id | Destination Resource ID | ceb44ea5ecb34a49b16495f9a63b0718 |
| destination_resource_name | Destination Resource Name | VpcName |
| destination_type | Destination Type | VPC |
| modified_at | Modified At | 2024-05-17T00:23:17Z |
| modified_by | Modified By | 90dddfc2b1e04edba54ba2b41539a9ac |
| source_resource_id | Source Resource ID | 8582cc5d89994a42ad53282fd4a8d8be |
| source_resource_name | Source Resource Name | TgwName |
| source_type | Source Type | TGW |
| state | State | ACTIVE |
| tgw_connection_vpc_id | VPC ID Connected to Transit Gateway. | ffeced8e191c478eabd66b6e2cab8e34 |
| tgw_connection_vpc_name | VPC Name Connected to Transit Gateway. | ConnectedVpcName |