CustomerGatewayAssociation customerGatewayAssociation
The customer gateway association.
LinkAssociation linkAssociation
The link association.
TransitGatewayConnectPeerAssociation transitGatewayConnectPeerAssociation
The transit gateway Connect peer association.
String connectionId
The ID of the connection.
String connectionArn
The Amazon Resource Name (ARN) of the connection.
String globalNetworkId
The ID of the global network.
String deviceId
The ID of the first device in the connection.
String connectedDeviceId
The ID of the second device in the connection.
String linkId
The ID of the link for the first device in the connection.
String connectedLinkId
The ID of the link for the second device in the connection.
String description
The description of the connection.
Date createdAt
The date and time that the connection was created.
String state
The state of the connection.
List<E> tags
The tags for the connection.
String globalNetworkId
The ID of the global network.
String deviceId
The ID of the first device in the connection.
String connectedDeviceId
The ID of the second device in the connection.
String linkId
The ID of the link for the first device.
String connectedLinkId
The ID of the link for the second device.
String description
A description of the connection.
Length Constraints: Maximum length of 256 characters.
List<E> tags
The tags to apply to the resource during creation.
Connection connection
Information about the connection.
String globalNetworkId
The ID of the global network.
AWSLocation aWSLocation
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
String description
A description of the device.
Constraints: Maximum length of 256 characters.
String type
The type of the device.
String vendor
The vendor of the device.
Constraints: Maximum length of 128 characters.
String model
The model of the device.
Constraints: Maximum length of 128 characters.
String serialNumber
The serial number of the device.
Constraints: Maximum length of 128 characters.
Location location
The location of the device.
String siteId
The ID of the site.
List<E> tags
The tags to apply to the resource during creation.
Device device
Information about the device.
GlobalNetwork globalNetwork
Information about the global network object.
String globalNetworkId
The ID of the global network.
String description
A description of the link.
Constraints: Maximum length of 256 characters.
String type
The type of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
Bandwidth bandwidth
The upload speed and download speed in Mbps.
String provider
The provider of the link.
Constraints: Maximum length of 128 characters. Cannot include the following characters: | \ ^
String siteId
The ID of the site.
List<E> tags
The tags to apply to the resource during creation.
Link link
Information about the link.
String globalNetworkId
The ID of the global network.
String description
A description of your site.
Constraints: Maximum length of 256 characters.
Location location
The site location. This information is used for visualization in the Network Manager console. If you specify the address, the latitude and longitude are automatically calculated.
Address: The physical address of the site.
Latitude: The latitude of the site.
Longitude: The longitude of the site.
List<E> tags
The tags to apply to the resource during creation.
Site site
Information about the site.
Connection connection
Information about the connection.
Device device
Information about the device.
String globalNetworkId
The ID of the global network.
GlobalNetwork globalNetwork
Information about the global network.
Link link
Information about the link.
Site site
Information about the site.
TransitGatewayRegistration transitGatewayRegistration
The transit gateway registration information.
String deviceId
The ID of the device.
String deviceArn
The Amazon Resource Name (ARN) of the device.
String globalNetworkId
The ID of the global network.
AWSLocation aWSLocation
The Amazon Web Services location of the device.
String description
The description of the device.
String type
The device type.
String vendor
The device vendor.
String model
The device model.
String serialNumber
The device serial number.
Location location
The site location.
String siteId
The site ID.
Date createdAt
The date and time that the site was created.
String state
The device state.
List<E> tags
The tags for the device.
CustomerGatewayAssociation customerGatewayAssociation
Information about the customer gateway association.
LinkAssociation linkAssociation
Information about the link association.
TransitGatewayConnectPeerAssociation transitGatewayConnectPeerAssociation
The transit gateway Connect peer association.
String globalNetworkId
The ID of the global network.
List<E> connectionIds
One or more connection IDs.
String deviceId
The ID of the device.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
List<E> customerGatewayArns
One or more customer gateway Amazon Resource Names (ARNs). The maximum is 10.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
List<E> deviceIds
One or more device IDs. The maximum is 10.
String siteId
The ID of the site.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
List<E> linkIds
One or more link IDs. The maximum is 10.
String siteId
The ID of the site.
String type
The link type.
String provider
The link provider.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
String resourceType
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
String registeredGatewayArn
The ARN of the registered gateway.
String awsRegion
The Amazon Web Services Region.
String accountId
The Amazon Web Services account ID.
String resourceType
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
String resourceArn
The ARN of the gateway.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
String registeredGatewayArn
The ARN of the gateway.
String awsRegion
The Amazon Web Services Region.
String accountId
The Amazon Web Services account ID.
String resourceType
The resource type.
The following are the supported resource types for Direct Connect:
dxcon - The definition model is Connection.
dx-gateway - The definition model is DirectConnectGateway.
dx-vif - The definition model is VirtualInterface.
The following are the supported resource types for Network Manager:
connection - The definition model is Connection.
device - The definition model is Device.
link - The definition model is Link.
site - The definition model is Site.
The following are the supported resource types for Amazon VPC:
customer-gateway - The definition model is CustomerGateway.
transit-gateway - The definition model is TransitGateway.
transit-gateway-attachment - The definition model is TransitGatewayAttachment.
transit-gateway-connect-peer - The definition model is TransitGatewayConnectPeer.
transit-gateway-route-table - The definition model is TransitGatewayRouteTable.
vpn-connection - The definition model is VpnConnection.
String resourceArn
The ARN of the resource.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
RouteTableIdentifier routeTableIdentifier
The ID of the route table.
List<E> exactCidrMatches
An exact CIDR block.
List<E> longestPrefixMatches
The most specific route that matches the traffic (longest prefix match).
List<E> subnetOfMatches
The routes with a subnet that match the specified CIDR filter.
List<E> supernetOfMatches
The routes with a CIDR that encompasses the CIDR filter. Example: If you specify 10.0.1.0/30, then the result returns 10.0.1.0/29.
List<E> prefixListIds
The IDs of the prefix lists.
List<E> states
The route states.
List<E> types
The route types.
Map<K,V> destinationFilters
Filter by route table destination. Possible Values: TRANSIT_GATEWAY_ATTACHMENT_ID, RESOURCE_ID, or RESOURCE_TYPE.
String globalNetworkId
The ID of the global network.
String registeredGatewayArn
The ARN of the gateway.
String awsRegion
The Amazon Web Services Region.
String accountId
The Amazon Web Services account ID.
String resourceType
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
String resourceArn
The ARN of the resource.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
RouteAnalysis routeAnalysis
The route analysis.
String globalNetworkId
The ID of the global network.
List<E> transitGatewayConnectPeerArns
One or more transit gateway Connect peer Amazon Resource Names (ARNs).
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
List<E> transitGatewayArns
The Amazon Resource Names (ARNs) of one or more transit gateways. The maximum is 10.
Integer maxResults
The maximum number of results to return.
String nextToken
The token for the next page of results.
String globalNetworkId
The ID of the global network.
String globalNetworkArn
The Amazon Resource Name (ARN) of the global network.
String description
The description of the global network.
Date createdAt
The date and time that the global network was created.
String state
The state of the global network.
List<E> tags
The tags for the global network.
Integer retryAfterSeconds
Indicates when to retry the request.
String linkId
The ID of the link.
String linkArn
The Amazon Resource Name (ARN) of the link.
String globalNetworkId
The ID of the global network.
String siteId
The ID of the site.
String description
The description of the link.
String type
The type of the link.
Bandwidth bandwidth
The bandwidth for the link.
String provider
The provider of the link.
Date createdAt
The date and time that the link was created.
String state
The state of the link.
List<E> tags
The tags for the link.
String resourceArn
The Amazon Resource Name (ARN) of the resource.
String registeredGatewayArn
The ARN of the gateway.
String awsRegion
The Amazon Web Services Region.
String accountId
The Amazon Web Services account ID.
String resourceType
The resource type.
The following are the supported resource types for Direct Connect:
dxcon
dx-gateway
dx-vif
The following are the supported resource types for Network Manager:
connection
device
link
site
The following are the supported resource types for Amazon VPC:
customer-gateway
transit-gateway
transit-gateway-attachment
transit-gateway-connect-peer
transit-gateway-route-table
vpn-connection
String resourceId
The ID of the resource.
String resourceArn
The ARN of the resource.
String definition
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
Date definitionTimestamp
The time that the resource definition was retrieved.
List<E> tags
The tags.
Map<K,V> metadata
The resource metadata.
String registeredGatewayArn
The ARN of the gateway.
String resourceArn
The ARN of the resource.
String resourceType
The resource type.
String definition
Information about the resource, in JSON format. Network Manager gets this information by describing the resource using its Describe API call.
String nameTag
The value for the Name tag.
Boolean isMiddlebox
Indicates whether this is a middlebox appliance.
String destinationCidrBlock
A unique identifier for the route, such as a CIDR block.
List<E> destinations
The destinations.
String prefixListId
The ID of the prefix list.
String state
The route state. The possible values are active and blackhole.
String type
The route type. The possible values are propagated and static.
String registeredGatewayArn
The ARN of the gateway.
String awsRegion
The Amazon Web Services Region.
String accountId
The Amazon Web Services account ID.
String resourceType
The resource type.
String resourceId
The ID of the resource.
String resourceArn
The ARN of the resource.
String address
The address.
ConnectionHealth health
The connection health.
Integer sequence
The sequence number in the path. The destination is 0.
NetworkResourceSummary resource
The resource.
String destinationCidrBlock
The destination CIDR block in the route table.
TransitGatewayRegistration transitGatewayRegistration
Information about the transit gateway registration.
String globalNetworkId
The ID of the global network.
String ownerAccountId
The ID of the AWS account that created the route analysis.
String routeAnalysisId
The ID of the route analysis.
Date startTimestamp
The time that the analysis started.
String status
The status of the route analysis.
RouteAnalysisEndpointOptions source
The source.
RouteAnalysisEndpointOptions destination
The destination.
Boolean includeReturnPath
Indicates whether to analyze the return path. The return path is not analyzed if the forward path analysis does not succeed.
Boolean useMiddleboxes
Indicates whether to include the location of middlebox appliances in the route analysis.
RouteAnalysisPath forwardPath
The forward path.
RouteAnalysisPath returnPath
The return path.
String resultCode
The result of the analysis. If the status is NOT_CONNECTED, check the reason code.
String reasonCode
The reason code. Available only if a connection is not found.
BLACKHOLE_ROUTE_FOR_DESTINATION_FOUND - Found a black hole route with the destination CIDR block.
CYCLIC_PATH_DETECTED - Found the same resource multiple times while traversing the path.
INACTIVE_ROUTE_FOR_DESTINATION_FOUND - Found an inactive route with the destination CIDR block.
MAX_HOPS_EXCEEDED - Analysis exceeded 64 hops without finding the destination.
ROUTE_NOT_FOUND - Cannot find a route table with the destination CIDR block.
TGW_ATTACH_ARN_NO_MATCH - Found an attachment, but not with the correct destination ARN.
TGW_ATTACH_NOT_FOUND - Cannot find an attachment.
TGW_ATTACH_NOT_IN_TGW - Found an attachment, but not to the correct transit gateway.
TGW_ATTACH_STABLE_ROUTE_TABLE_NOT_FOUND - The state of the route table association is not
associated.
Map<K,V> reasonContext
Additional information about the path. Available only if a connection is not found.
RouteAnalysisCompletion completionStatus
The status of the analysis at completion.
List<E> path
The route analysis path.
String transitGatewayRouteTableArn
The ARN of the transit gateway route table.
String siteId
The ID of the site.
String siteArn
The Amazon Resource Name (ARN) of the site.
String globalNetworkId
The ID of the global network.
String description
The description of the site.
Location location
The location of the site.
Date createdAt
The date and time that the site was created.
String state
The state of the site.
List<E> tags
The tags for the site.
String globalNetworkId
The ID of the global network.
RouteAnalysisEndpointOptionsSpecification source
The source from which traffic originates.
RouteAnalysisEndpointOptionsSpecification destination
The destination.
Boolean includeReturnPath
Indicates whether to analyze the return path. The default is false.
Boolean useMiddleboxes
Indicates whether to include the location of middlebox appliances in the route analysis. The default is
false.
RouteAnalysis routeAnalysis
The route analysis.
Integer retryAfterSeconds
Indicates when to retry the request.
String transitGatewayConnectPeerArn
The Amazon Resource Name (ARN) of the transit gateway Connect peer.
String globalNetworkId
The ID of the global network.
String deviceId
The ID of the device.
String linkId
The ID of the link.
String state
The state of the association.
String globalNetworkId
The ID of the global network.
String transitGatewayArn
The Amazon Resource Name (ARN) of the transit gateway.
TransitGatewayRegistrationStateReason state
The state of the transit gateway registration.
String globalNetworkId
The ID of the global network.
String connectionId
The ID of the connection.
String linkId
The ID of the link for the first device in the connection.
String connectedLinkId
The ID of the link for the second device in the connection.
String description
A description of the connection.
Length Constraints: Maximum length of 256 characters.
Connection connection
Information about the connection.
String globalNetworkId
The ID of the global network.
String deviceId
The ID of the device.
AWSLocation aWSLocation
The Amazon Web Services location of the device, if applicable. For an on-premises device, you can omit this parameter.
String description
A description of the device.
Constraints: Maximum length of 256 characters.
String type
The type of the device.
String vendor
The vendor of the device.
Constraints: Maximum length of 128 characters.
String model
The model of the device.
Constraints: Maximum length of 128 characters.
String serialNumber
The serial number of the device.
Constraints: Maximum length of 128 characters.
Location location
String siteId
The ID of the site.
Device device
Information about the device.
GlobalNetwork globalNetwork
Information about the global network object.
String globalNetworkId
The ID of the global network.
String linkId
The ID of the link.
String description
A description of the link.
Constraints: Maximum length of 256 characters.
String type
The type of the link.
Constraints: Maximum length of 128 characters.
Bandwidth bandwidth
The upload and download speed in Mbps.
String provider
The provider of the link.
Constraints: Maximum length of 128 characters.
Link link
Information about the link.
String globalNetworkId
The ID of the global network.
String siteId
The ID of your site.
String description
A description of your site.
Constraints: Maximum length of 256 characters.
Location location
The site location:
Address: The physical address of the site.
Latitude: The latitude of the site.
Longitude: The longitude of the site.
Site site
Information about the site.
Copyright © 2021. All rights reserved.