GET AWS TGW site.

GET

/api/config/namespaces/{namespace}/aws_tgw_sites/{name}

const url = 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/aws_tgw_sites/example?response_format=GET_RSP_FORMAT_DEFAULT';
const options = {method: 'GET', headers: {Authorization: '<Authorization>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url 'https://example-corp.console.ves.volterra.io/api/v1/api/production/us-east-1/namespaces/default/api/config/namespaces/example/aws_tgw_sites/example?response_format=GET_RSP_FORMAT_DEFAULT' \
  --header 'Authorization: <Authorization>'

Shape of the AWS TGW site specification.

Examples of this operation.

Authorizations

ApiToken

Parameters

Path Parameters

namespace

required

string

Namespace The namespace in which the configuration object is present.

name

required

string

Name The name of the configuration object to be fetched.

Query Parameters

response_format

string

default: GET_RSP_FORMAT_DEFAULT

Allowed values: GET_RSP_FORMAT_DEFAULT GET_RSP_FORMAT_FOR_CREATE GET_RSP_FORMAT_FOR_REPLACE GET_RSP_FORMAT_STATUS GET_RSP_FORMAT_READ GET_RSP_FORMAT_REFERRING_OBJECTS GET_RSP_FORMAT_BROKEN_REFERENCES

The format in which the configuration object is to be fetched. This could be for example

in GetSpec form for the contents of object
in CreateRequest form to create a new similar object
to ReplaceRequest form to replace changeable values

Default format of returned resource Response should be in CreateRequest format Response should be in ReplaceRequest format Response should be in StatusObject(s) format Response should be in format of GetSpecType Response should have other objects referring to this object Response should have deleted and disabled objects referrred by this object.

Responses

200

A successful response.

application/json

GetResponse is the shape of a read aws_tgw_site

This is the output message of the ‘GET’ RPC.

object

create_form

object

metadata

object

annotations

annotations

Annotations is an unstructured key value map stored with a resource that may be set by external tools to store and retrieve arbitrary metadata. They are not queryable and should be preserved when modifying objects.

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

This is the name of configuration object. It has to be unique within the namespace. It can only be specified during create API and cannot be changed during replace API. The value of name has to follow DNS-1035 format. Required: YES.

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

spec

object

aws_parameters

object

admin_password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

URL of the secret. Currently supported URL schemes is string:///. For string:/// scheme, Secret needs to be encoded Base64 format. When asked for this secret, caller will GET Secret bytes after Base64 decoding. Required: YES.

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

X-displayName: “Key” Key of the individual secret. Vault Secrets are stored as key-value pair. If user is only interested in one value from the map, this field should be set to the corresponding key. If not provided entire secret will be returned.

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

X-displayName: “Version” Version of the secret to be fetched. As vault secrets are versioned, user can specify this field to fetch specific version. If not provided latest version will be returned.

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

aws_cred

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

aws_region

AWS Region

AWS Region of your services VPC, where F5XC site will be deployed. Required: YES.

string

<= 1024 characters

az_nodes

Nodes

Only Single AZ or Three AZ(s) nodes are supported currently.

Required: YES.

Array<object>

Two Interface Node

Parameters for creating two interface Node in one AZ.

object

aws_az_name

AWS AZ

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

inside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

outside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

reserved_inside_subnet

object

workload_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

custom_security_group

object

inside_security_group_id

Inside Security Group ID

Security Group ID to be attached to SLI(Site Local Inside) Interface.

string

<= 20 characters

outside_security_group_id

Outside Security Group ID

Security Group ID to be attached to SLO(Site Local Outside) Interface.

string

<= 20 characters

disable_internet_vip

object

disk_size

Node Disk size

Node disk size for all node in the F5XC site. Unit is GiB.

integer format: int64

enable_internet_vip

object

existing_tgw

object

tgw_asn

TGW ASN

TGW ASN.

integer format: int64

tgw_id

Existing TGW ID

Existing TGW ID.

string

<= 64 characters

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

f5xc_security_group

object

instance_type

AWS Instance Type

Instance size based on the performance. Required: YES.

string

<= 64 characters

new_tgw

object

system_generated

object

user_assigned

object

tgw_asn

TGW ASN

TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.

integer format: int64

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

new_vpc

object

autogenerate

object

name_tag

name_tag

Exclusive with [autogenerate] Specify the VPC Name.

string

<= 64 characters

primary_ipv4

Primary IPv4 CIDR block

IPv4 CIDR block for this VPC. It has to be private address space. The Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block. Required: YES.

string

<= 1024 characters

allocate_ipv6

Allocate IPv6 CIDR block

X-displayName: “Allocate IPv6 CIDR block from AWS” Allocate IPv6 CIDR block from AWS.

boolean format: boolean

no_worker_nodes

object

nodes_per_az

Desired Worker Nodes Per AZ

Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.

integer format: int64

reserved_tgw_cidr

object

ssh_key

Public SSH key

Public SSH key for accessing nodes of the site. Required: YES.

string

>= 1 characters <= 8192 characters

tgw_cidr

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

total_nodes

Total Number of Worker Nodes for a Site

Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ’s used in the Site.

integer format: int64

vpc_id

Existing VPC ID

Exclusive with [new_vpc] Existing VPC ID.

string

<= 64 characters

disable_encryption

object

enable_encryption

object

kms_key_id

KMS Key ID

AWS KMS Key to be used to encrypt the disk attached to the VM

Required: YES.

string

<= 1024 characters

block_all_services

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

Allowed values: VIRTUAL_NETWORK_SITE_LOCAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE VIRTUAL_NETWORK_PER_SITE VIRTUAL_NETWORK_PUBLIC VIRTUAL_NETWORK_GLOBAL VIRTUAL_NETWORK_SITE_SERVICE VIRTUAL_NETWORK_VER_INTERNAL VIRTUAL_NETWORK_SITE_LOCAL_INSIDE_OUTSIDE VIRTUAL_NETWORK_IP_AUTO VIRTUAL_NETWORK_VOLTADN_PRIVATE_NETWORK VIRTUAL_NETWORK_SRV6_NETWORK VIRTUAL_NETWORK_IP_FABRIC VIRTUAL_NETWORK_SEGMENT VIRTUAL_NETWORK_MANAGEMENT

ssh

object

web_user_interface

object

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

default_blocked_services

object

direct_connect_disabled

object

direct_connect_enabled

object

auto_asn

object

custom_asn

Custom ASN

Exclusive with [auto_asn] Custom Autonomous System Number.

integer format: int64

hosted_vifs

object

site_registration_over_direct_connect

object

cloudlink_network_name

Private ADN Network

Establish private connectivity with the F5 Distributed Cloud Global Network using a Private ADN network. To provision a Private ADN network, please contact F5 Distributed Cloud support. Required: YES.

string

<= 64 characters

site_registration_over_internet

object

vif_list

List of Hosted VIF Config

List of Hosted VIF Config.

Array<object>

<= 30 items

HostedVIFRegionObject

AWS Direct Connect Hosted VIF Config Per Region Object.

object

other_region

Other Region

Exclusive with [same_as_site_region] Other Region.

string

<= 1024 characters

same_as_site_region

object

vif_id

VIF ID

AWS Direct Connect VIF ID that needs to be connected to the site Required: YES.

string

<= 1024 characters

standard_vifs

object

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Seconds to wait before initiating upgrade on the next set of nodes. Setting it to 0 will wait indefinitely for all services on nodes to be upgraded gracefully before proceeding to the next set of nodes. (Warning: It may block upgrade if services on a node cannot be gracefully upgraded. It is recommended to use the default value).

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

log_receiver

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

logs_streaming_disabled

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

default_os_version

object

operating_system_version

Operating System Version

Exclusive with [default_os_version] Specify a OS version to be used e.g. 9.2024.6.

string

<= 20 characters

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

private_connectivity

object

cloud_link

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside

object

outside

object

default_sw_version

object

volterra_software_version

F5XC Software Version

Exclusive with [default_sw_version] Specify a F5XC Software Version to be used e.g. Crt-20210329-1002.

string

<= 20 characters

tags

AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.

object

tgw_security

object

active_east_west_service_policies

object

service_policies

service_policies

A list of references to service_policy objects.

Array<object>

<= 32 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

east_west_service_policy_allow_all

object

forward_proxy_allow_all

object

no_east_west_policy

object

no_forward_proxy

object

no_network_policy

object

vn_config

object

allowed_vip_port

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

allowed_vip_port_sli

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

dc_cluster_group_inside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

dc_cluster_group_outside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

slo_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

This type establishes a ‘direct reference’ from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name for public API and Uid for private API This type of reference is called direct because the relation is explicit and concrete (as opposed to selector reference which builds a group based on labels of selectee objects)

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

IPv6 Address in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ The address can be compacted by suppressing zeros e.g. ‘2001:db8:0:0:0:0:2:1’ becomes ‘2001:db8::2:1’ or ‘2001:db8:0:0:0:2:0:0’ becomes ‘2001:db8::2::’

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

Prefix part of the IPv6 subnet given in form of string. IPv6 address must be specified as hexadecimal numbers separated by ’:’ e.g. “2001:db8:0:0:0:2:0:0” The address can be compacted by suppressing zeros e.g. “2001:db8::2::”

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

no_dc_cluster_group

object

no_global_network

object

no_inside_static_routes

object

no_outside_static_routes

object

outside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

vpc_attachments

object

vpc_list

vpc_list

List of VPC attachments to transit gateway.

Array<object>

<= 128 items

VPC attachment

VPC attachments to transit gateway.

object

labels

Labels

Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.

object

vpc_id

VPC ID

Information about existing VPC.

string

<= 64 characters

deleted_referred_objects

deleted_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

disabled_referred_objects

disabled_referred_objects

The set of deleted objects that are referred by this object.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

metadata

object

annotations

annotations

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

referring_objects

referring_objects

The set of objects that are referring to this object in their spec.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

replace_form

object

metadata

object

annotations

annotations

object

description

description

Human readable description for the object.

string

>= 21 characters <= 1200 characters

disable

disable

A value of true will administratively disable the object.

boolean format: boolean

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the user. Values specified here will be used by selector expression.

object

name

name

string

>= 6 characters <= 1024 characters

namespace

namespace

This defines the workspace within which each the configuration object is to be created. Must be a DNS_LABEL format. For a namespace object itself, namespace value will be ""

string

>= 6 characters <= 1024 characters

spec

object

aws_parameters

object

aws_cred

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

aws_region

AWS Region

AWS Region of your services VPC, where F5XC site will be deployed. Required: YES.

string

<= 1024 characters

az_nodes

Only Single AZ or Three AZ(s) nodes are supported currently.

Required: YES.

Array<object>

Two Interface Node

Parameters for creating two interface Node in one AZ.

object

aws_az_name

AWS AZ

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

inside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

outside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

reserved_inside_subnet

object

workload_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

custom_security_group

object

inside_security_group_id

Inside Security Group ID

Security Group ID to be attached to SLI(Site Local Inside) Interface.

string

<= 20 characters

outside_security_group_id

Outside Security Group ID

Security Group ID to be attached to SLO(Site Local Outside) Interface.

string

<= 20 characters

disable_internet_vip

object

disk_size

Node Disk size

Node disk size for all node in the F5XC site. Unit is GiB.

integer format: int64

enable_internet_vip

object

existing_tgw

object

tgw_asn

TGW ASN

TGW ASN.

integer format: int64

tgw_id

Existing TGW ID

Existing TGW ID.

string

<= 64 characters

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

f5xc_security_group

object

instance_type

Instance size based on the performance. Required: YES.

string

<= 64 characters

new_tgw

object

system_generated

object

user_assigned

object

tgw_asn

TGW ASN

TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.

integer format: int64

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

new_vpc

object

autogenerate

object

name_tag

name_tag

Exclusive with [autogenerate] Specify the VPC Name.

string

<= 64 characters

primary_ipv4

Primary IPv4 CIDR block

IPv4 CIDR block for this VPC. It has to be private address space. The Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block. Required: YES.

string

<= 1024 characters

allocate_ipv6

Allocate IPv6 CIDR block

X-displayName: “Allocate IPv6 CIDR block from AWS” Allocate IPv6 CIDR block from AWS.

boolean format: boolean

no_worker_nodes

object

nodes_per_az

Desired Worker Nodes Per AZ

Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.

integer format: int64

ssh_key

Public SSH key

Public SSH key for accessing nodes of the site. Required: YES.

string

>= 1 characters <= 8192 characters

total_nodes

Total Number of Worker Nodes for a Site

Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ’s used in the Site.

integer format: int64

vpc_id

Existing VPC ID

Exclusive with [new_vpc] Existing VPC ID.

string

<= 64 characters

block_all_services

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

ssh

object

web_user_interface

object

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

default_blocked_services

object

direct_connect_disabled

object

direct_connect_enabled

object

auto_asn

object

custom_asn

Custom ASN

Exclusive with [auto_asn] Custom Autonomous System Number.

integer format: int64

hosted_vifs

object

site_registration_over_direct_connect

object

cloudlink_network_name

Private ADN Network

string

<= 64 characters

site_registration_over_internet

object

vif_list

List of Hosted VIF Config

List of Hosted VIF Config.

Array<object>

<= 30 items

HostedVIFRegionObject

AWS Direct Connect Hosted VIF Config Per Region Object.

object

other_region

Other Region

Exclusive with [same_as_site_region] Other Region.

string

<= 1024 characters

same_as_site_region

object

vif_id

VIF ID

AWS Direct Connect VIF ID that needs to be connected to the site Required: YES.

string

<= 1024 characters

standard_vifs

object

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

log_receiver

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

logs_streaming_disabled

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

private_connectivity

object

cloud_link

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside

object

outside

object

tgw_security

object

active_east_west_service_policies

object

service_policies

service_policies

A list of references to service_policy objects.

Array<object>

<= 32 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

east_west_service_policy_allow_all

object

forward_proxy_allow_all

object

no_east_west_policy

object

no_forward_proxy

object

no_network_policy

object

vn_config

object

allowed_vip_port

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

allowed_vip_port_sli

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

dc_cluster_group_inside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

dc_cluster_group_outside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

slo_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

no_dc_cluster_group

object

no_global_network

object

no_inside_static_routes

object

no_outside_static_routes

object

outside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

vpc_attachments

object

vpc_list

vpc_list

List of VPC attachments to transit gateway.

Array<object>

<= 128 items

VPC attachment

VPC attachments to transit gateway.

object

labels

Labels

Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.

object

vpc_id

VPC ID

Information about existing VPC.

string

<= 64 characters

spec

object

aws_parameters

object

admin_password

object

blindfold_secret_info

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

clear_secret_info

object

provider

Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

>= 3 characters <= 1024 characters

url

URL

string format: uri

<= 131072 characters

blindfold_secret_info_internal

object

decryption_provider

Decryption Provider

Name of the Secret Management Access object that contains information about the backend Secret Management service.

string

<= 1024 characters

location

Location

Location is the uri_ref. It could be in URL format for string:/// Or it could be a path if the store provider is an HTTP/HTTPS location Required: YES.

string

>= 4 characters <= 1024 characters

store_provider

Store Provider

Name of the Secret Management Access object that contains information about the store to GET encrypted bytes This field needs to be provided only if the URL scheme is not string:///.

string

<= 1024 characters

secret_encoding_type

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

vault_secret_info

object

key

Key

string

>= 7 characters <= 1024 characters

location

Location

X-displayName: “Location” x-required Path to secret in Vault.

string

>= 4 characters <= 1024 characters

provider

Provider

X-displayName: “Provider” x-required Name of the Secret Management Access object that contains information about the backend Vault.

string

>= 3 characters <= 1024 characters

secret_encoding

string

default: EncodingNone

Allowed values: EncodingNone EncodingBase64

version

Version

integer format: int64

>= 1 characters <= 1 characters

wingman_secret_info

object

name

Name

X-displayName: “Name” x-required Name of the secret.

string

>= 6 characters <= 1024 characters

aws_cred

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

aws_region

AWS Region

AWS Region of your services VPC, where F5XC site will be deployed. Required: YES.

string

<= 1024 characters

az_nodes

Nodes

Only Single AZ or Three AZ(s) nodes are supported currently.

Required: YES.

Array<object>

Two Interface Node

Parameters for creating two interface Node in one AZ.

object

aws_az_name

AWS AZ

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

inside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

outside_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

reserved_inside_subnet

object

workload_subnet

object

existing_subnet_id

Existing Subnet ID

Exclusive with [subnet_param] Information about existing subnet ID.

string

<= 64 characters

subnet_param

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

custom_security_group

object

inside_security_group_id

Inside Security Group ID

Security Group ID to be attached to SLI(Site Local Inside) Interface.

string

<= 20 characters

outside_security_group_id

Outside Security Group ID

Security Group ID to be attached to SLO(Site Local Outside) Interface.

string

<= 20 characters

disable_internet_vip

object

disk_size

Node Disk size

Node disk size for all node in the F5XC site. Unit is GiB.

integer format: int64

enable_internet_vip

object

existing_tgw

object

tgw_asn

TGW ASN

TGW ASN.

integer format: int64

tgw_id

Existing TGW ID

Existing TGW ID.

string

<= 64 characters

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

f5xc_security_group

object

instance_type

AWS Instance Type

Instance size based on the performance. Required: YES.

string

<= 64 characters

new_tgw

object

system_generated

object

user_assigned

object

tgw_asn

TGW ASN

TGW ASN. Allowed range for 16-bit private ASNs include 64512 to 65534.

integer format: int64

volterra_site_asn

F5XC Site ASN

F5XC Site ASN.

integer format: int64

new_vpc

object

autogenerate

object

name_tag

name_tag

Exclusive with [autogenerate] Specify the VPC Name.

string

<= 64 characters

primary_ipv4

Primary IPv4 CIDR block

IPv4 CIDR block for this VPC. It has to be private address space. The Primary IPv4 block cannot be modified. All subnets prefixes in this VPC must be part of this CIDR block. Required: YES.

string

<= 1024 characters

allocate_ipv6

Allocate IPv6 CIDR block

X-displayName: “Allocate IPv6 CIDR block from AWS” Allocate IPv6 CIDR block from AWS.

boolean format: boolean

no_worker_nodes

object

nodes_per_az

Desired Worker Nodes Per AZ

Exclusive with [no_worker_nodes total_nodes] Desired Worker Nodes Per AZ. Max limit is up to 21.

integer format: int64

reserved_tgw_cidr

object

ssh_key

Public SSH key

Public SSH key for accessing nodes of the site. Required: YES.

string

>= 1 characters <= 8192 characters

tgw_cidr

object

ipv4

IPv4 Subnet

IPv4 subnet prefix for this subnet Required: YES.

string format: ipv4

<= 1024 characters

total_nodes

Total Number of Worker Nodes for a Site

Exclusive with [no_worker_nodes nodes_per_az] Total number of worker nodes to be deployed across all AZ’s used in the Site.

integer format: int64

vpc_id

Existing VPC ID

Exclusive with [new_vpc] Existing VPC ID.

string

<= 64 characters

disable_encryption

object

enable_encryption

object

kms_key_id

KMS Key ID

AWS KMS Key to be used to encrypt the disk attached to the VM

Required: YES.

string

<= 1024 characters

block_all_services

object

blocked_services

object

blocked_sevice

Disable Node Local Services

Blocking or denial configuration

Array<object>

Disable Node Local Service

Disable a node local service on this site.

object

dns

object

network_type

string

default: VIRTUAL_NETWORK_SITE_LOCAL

ssh

object

web_user_interface

object

coordinates

object

latitude

latitude

Latitude of the site location.

number format: float

longitude

longitude

Longitude of site location.

number format: float

custom_dns

object

inside_nameserver

inside_nameserver

Optional DNS server IP to be used for name resolution in inside network.

string

<= 1024 characters

outside_nameserver

outside_nameserver

Optional DNS server IP to be used for name resolution in outside network.

string

<= 1024 characters

default_blocked_services

object

direct_connect_disabled

object

direct_connect_enabled

object

auto_asn

object

custom_asn

Custom ASN

Exclusive with [auto_asn] Custom Autonomous System Number.

integer format: int64

hosted_vifs

object

site_registration_over_direct_connect

object

cloudlink_network_name

Private ADN Network

string

<= 64 characters

site_registration_over_internet

object

vif_list

List of Hosted VIF Config

List of Hosted VIF Config.

Array<object>

<= 30 items

HostedVIFRegionObject

AWS Direct Connect Hosted VIF Config Per Region Object.

object

other_region

Other Region

Exclusive with [same_as_site_region] Other Region.

string

<= 1024 characters

same_as_site_region

object

vif_id

VIF ID

AWS Direct Connect VIF ID that needs to be connected to the site Required: YES.

string

<= 1024 characters

standard_vifs

object

direct_connect_info

object

asn

AWS Side ASN

The autonomous system (AS) number on the AWS side for Border Gateway Protocol (BGP) configuration.

integer format: int64

direct_connect_gateway_id

DirectConnect Gateway ID

DirectConnect Gateway ID Required: YES.

string

<= 1024 characters

vgw_id

Virtual Private Gateway ID

Virtual Private Gateway ID Required: YES.

string

<= 1024 characters

error_description

Description of error on site.

string

<= 1024 characters

kubernetes_upgrade_drain

object

disable_upgrade_drain

object

enable_upgrade_drain

object

disable_vega_upgrade_mode

object

drain_max_unavailable_node_count

Node Batch Size Count

Exclusive with []

integer format: int64

drain_node_timeout

Upgrade Wait Time

Required: YES.

integer format: int64

enable_vega_upgrade_mode

object

log_receiver

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

logs_streaming_disabled

object

offline_survivability_mode

object

enable_offline_survivability_mode

object

no_offline_survivability_mode

object

performance_enhancement_mode

object

perf_mode_l3_enhanced

object

jumbo

object

no_jumbo

object

perf_mode_l7_enhanced

object

private_connectivity

object

cloud_link

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside

object

outside

object

site_errors

Errors on site including suggested action.

Array<object>

Site Error

Site Error.

object

error_description

Error Description

Error Description.

string

<= 1024 characters

suggested_action

Suggested Action

Suggested Action.

string

<= 1024 characters

site_state

string

default: ONLINE

Allowed values: ONLINE PROVISIONING UPGRADING STANDBY FAILED REREGISTRATION WAITINGNODES DECOMMISSIONING WAITING_FOR_REGISTRATION ORCHESTRATION_IN_PROGRESS ORCHESTRATION_COMPLETE ERROR_IN_ORCHESTRATION DELETING_CLOUD_RESOURCES DELETED_CLOUD_RESOURCES ERROR_DELETING_CLOUD_RESOURCES VALIDATION_IN_PROGRESS VALIDATION_SUCCESS VALIDATION_FAILED FAILED_INACTIVE UPDATING_CLOUD_RESOURCES ERROR_UPDATING_CLOUD_RESOURCES ORCHESTRATION_QUEUED UPDATE_QUEUED DELETE_QUEUED

suggested_action

Suggested action for customer on error.

string

<= 1024 characters

tags

AWS Tags is a label consisting of a user-defined key and value. It helps to manage, identify, organize, search for, and filter resources in AWS console.

object

tgw_info

object

private_ips

AWS Node Private IPs

AWS Private IPs used by the nodes Required: YES.

Array<string>

public_ips

AWS Node Elastic IPs

AWS Elastic IPs used by the nodes Required: YES.

Array<string>

subnet_ids

AWS Subnet Ids Info

AWS Subnet IDs used by F5 Distributed Cloud site

Required: YES.

Array<object>

AWS Subnets Ids

AWS Subnet IDs used by F5 Distributed Cloud site.

object

az_name

AZ Name

AWS availability zone, must be consistent with the selected AWS region.

string

<= 1024 characters

inside_subnet

object

az_name

AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

Subnet ID

Subnet ID

string

>= 1 <= 4094 <= 64 characters

ipv4_prefix

Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string

<= 1024 characters

inside_subnet_id

Inside Subnet ID

Inside subnet ID used by F5 Distributed Cloud site.

string

<= 1024 characters

outside_subnet

object

az_name

AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

Subnet ID

Subnet ID

string

>= 1 <= 4094 <= 64 characters

ipv4_prefix

Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string

<= 1024 characters

outside_subnet_id

Outside Subnet ID

Outside subnet ID used by F5 Distributed Cloud site.

string

<= 1024 characters

workload_subnet

object

az_name

AZ Name

AWS availability zone, must be consistent with the selected AWS region. Required: YES.

string

<= 1024 characters

Subnet ID

Subnet ID

string

>= 1 <= 4094 <= 64 characters

ipv4_prefix

Subnet CIDR block

Subnet CIDR block. It has to be private address space. Required: YES.

string

<= 1024 characters

workload_subnet_id

Workload Subnet ID

Workload subnet ID used by F5 Distributed Cloud site.

string

<= 1024 characters

tgw_id

TGW ID

TGW ID populated by AWS Required: YES.

string

<= 1024 characters

vpc_id

VPC ID

VPC ID where the F5 Distributed Cloud site exists Required: YES.

string

<= 1024 characters

vpc_name

VPC Name

VPC Name where the F5 Distributed Cloud site exists.

string

<= 1024 characters

tgw_security

object

active_east_west_service_policies

object

service_policies

service_policies

A list of references to service_policy objects.

Array<object>

<= 32 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_enhanced_firewall_policies

object

enhanced_firewall_policies

Enhanced Firewall Policy

Ordered List of Enhanced Firewall Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_forward_proxy_policies

object

forward_proxy_policies

Forward Proxy Policies

Ordered List of Forward Proxy Policies active

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

active_network_policies

object

network_policies

Firewall Policy

Ordered List of Firewall Policies active for this network firewall

Required: YES.

Array<object>

>= 1 items <= 128 items

ObjectRefType

This type establishes a direct reference from one object(the referrer) to another(the referred). Such a reference is in form of tenant/namespace/name.

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

east_west_service_policy_allow_all

object

forward_proxy_allow_all

object

no_east_west_policy

object

no_forward_proxy

object

no_network_policy

object

tunnel_type

string

default: TUNNEL_IPSEC

Allowed values: TUNNEL_IPSEC TUNNEL_GRE

validation_state

string

default: VALIDATION_STATE_NONE

Allowed values: VALIDATION_STATE_NONE VALIDATION_IN_PROGRESS VALIDATION_FAILED VALIDATION_SUCCEEDED

vip_params_per_az

VIP Parameters Per AZ.

Array<object>

Publish VIP Params Per AZ

Per AZ parameters needed to publish VIP for public cloud sites.

object

az_name

AZ Name

Name of the Availability zone.

string

<= 1024 characters

inside_vip

Inside VIP(s)

List of Inside VIPs for an AZ.

Array<string>

<= 3 items

inside_vip_cname

Inside VIP CNAME

CNAME value for the inside VIP, These are usually public cloud generated CNAME.

string

<= 256 characters

inside_vip_v6

Inside IPv6 VIP(s)

Optional list of Inside IPv6 VIPs for an AZ.

Array<string>

<= 3 items

outside_vip

Outside VIP(s)

List of Outside VIPs for an AZ Required: YES.

Array<string>

>= 1 items <= 3 items

outside_vip_cname

Outside VIP CNAME

CNAME value for the outside VIP These are usually public cloud generated CNAME.

string

<= 256 characters

outside_vip_v6

Outside IPv6 VIP(s)

Optional list of Outside IPv6 VIPs for an AZ.

Array<string>

<= 3 items

vn_config

object

allowed_vip_port

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

allowed_vip_port_sli

object

custom_ports

object

port_ranges

Port Ranges

Port Ranges Required: YES.

string

>= 1 characters <= 512 characters

disable_allowed_vip_port

object

use_http_https_port

object

use_http_port

object

use_https_port

object

dc_cluster_group_inside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

dc_cluster_group_outside_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

global_network_list

object

global_network_connections

Global Network Connections

Global network connections

Required: YES.

Array<object>

>= 1 items <= 8 items

Global Network Connection

Global network connection.

object

sli_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

slo_to_global_dr

object

global_vn

object

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name. Required: YES.

string

>= 1 characters <= 128 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 64 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 64 characters

inside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

no_dc_cluster_group

object

no_global_network

object

no_inside_static_routes

object

no_outside_static_routes

object

outside_static_routes

object

static_route_list

List of Static Routes

List of Static routes

Required: YES.

Array<object>

>= 1 items <= 64 items

Site Static Route Config Modes

Different ways to configure static routes.

object

custom_static_route

object

attrs

Attributes

List of route attributes associated with the static route.

Array<string>

<= 4 items

Allowed values: ROUTE_ATTR_NO_OP ROUTE_ATTR_ADVERTISE ROUTE_ATTR_INSTALL_HOST ROUTE_ATTR_INSTALL_FORWARDING ROUTE_ATTR_MERGE_ONLY

labels

Static Route labels

Add Labels for this Static Route, these labels can be used in network policy.

object

nexthop

object

interface

Network Interface

Nexthop is network interface when type is “Network-Interface”

Array<object>

<= 1 items

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

nexthop_address

object

ipv4

object

addr

IPv4 Address

IPv4 Address in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

addr

IPv6 Address

string

<= 1024 characters

type

string

default: NEXT_HOP_DEFAULT_GATEWAY

Allowed values: NEXT_HOP_DEFAULT_GATEWAY NEXT_HOP_USE_CONFIGURED NEXT_HOP_NETWORK_INTERFACE

subnets

Subnets

List of route prefixes

Required: YES.

Array<object>

<= 256 items

IP Subnet

IP Address used to specify an IPv4 or IPv6 subnet addresses.

object

ipv4

object

plen

Prefix Length

Prefix-length of the IPv4 subnet. Must be <= 32.

integer format: int64

prefix

Prefix

Prefix part of the IPv4 subnet in string form with dot-decimal notation.

string

<= 1024 characters

ipv6

object

plen

Prefix length

Prefix length of the IPv6 subnet. Must be <= 128.

integer format: int64

prefix

Prefix

string

<= 1024 characters

simple_static_route

Simple Static Route

Exclusive with [custom_static_route] Use simple static route for prefix pointing to single interface in the network.

string

<= 1024 characters

sm_connection_public_ip

object

sm_connection_pvt_ip

object

vpc_attachments

object

vpc_list

vpc_list

List of VPC attachments to transit gateway.

Array<object>

<= 128 items

VPC attachment

VPC attachments to transit gateway.

object

labels

Labels

Add labels for the VPC attachment. These labels can then be used in policies such as enhanced firewall.

object

vpc_id

VPC ID

Information about existing VPC.

string

<= 64 characters

status

status

The status reported by different services for this configuration object.

Array<object>

>= 17 characters <= 17 characters

StatusObject

Most recently observed status of object.

object

conditions

conditions

Conditions represent the normalized status values for configuration object.

Array<object>

ConditionType

Conditions are used in the object status to describe the current state of the object, e.g. Ready, Succeeded, etc.

object

hostname

hostname

Hostname of the instance of the site that sent the status.

string

<= 1024 characters

last_update_time

last_update_time

Last time the condition was updated.

string format: date-time

<= 1024 characters

reason

reason

X-reason: “Insufficient memory in data plane” A human readable string explaining the reason for reaching this condition.

string

>= 27 characters <= 1024 characters

service_name

service name

Name of the service that sent the status.

string

<= 1024 characters

status

status

Status of the condition “Success” Validtion has succeded. Requested operation was successful. “Failed” Validation has failed. “Incomplete” Validation of configuration has failed due to missing configuration. “Installed” Validation has passed and configuration has been installed in data path or K8s “Down” Configuration is operationally down. E.g. Down interface “Disabled” Configuration is administratively disabled i.e. objectmetatype.disable = true. “NotApplicable” Configuration is not applicable e.g. Tenant service_policy_set(s) in system namespace are not applicable on REs.

string

>= 17 characters <= 1024 characters

type

type

Type of the condition “Validation” represents validation user given configuration object “Operational” represents operational status of a given configuration object.

string

<= 1024 characters

deployment

object

apply_status

object

apply_state

string

default: APPLIED

Allowed values: APPLIED APPLY_ERRORED APPLY_INIT_ERRORED APPLYING APPLY_PLANNING APPLY_PLAN_ERRORED APPLY_QUEUED

container_version

container_version

Container image version.

string

<= 1024 characters

destroy_state

string

default: DESTROYED

Allowed values: DESTROYED DESTROY_ERRORED DESTROYING DESTROY_QUEUED

error_output

error_output

Error output of terraform run.

string

<= 1024 characters

infra_state

string

default: PROVISIONED

Allowed values: PROVISIONED TIMED_OUT ERRORED PROVISIONING

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this status was last modified.

string format: date-time

<= 1024 characters

suggested_action

suggested_action

Suggested action for customer on error.

string

<= 1024 characters

tf_output

tf_output

The value of an “output” variable from the terraform state file.

string

<= 1024 characters

tf_stdout

tf_stdout

The stdout of terraform apply command.

string

<= 1024 characters

expected_container_version

Expected container version

Container version expected.

string

<= 1024 characters

plan_status

object

error_output

error_output

Error output of terraform run.

string

<= 1024 characters

infra_state

string

default: PROVISIONED

Allowed values: PROVISIONED TIMED_OUT ERRORED PROVISIONING

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this status was last modified.

string format: date-time

<= 1024 characters

plan_state

string

default: PLANNING

Allowed values: PLANNING PLAN_ERRORED NO_CHANGES HAS_CHANGES DISCARDED PLAN_INIT_ERRORED PLAN_QUEUED

suggested_action

suggested_action

Suggested action for customer on error.

string

<= 1024 characters

tf_plan_output

tf_plan_output

Terraform “plan” command output. Terraform performs a refresh, unless explicitly disabled, and then determines what actions are necessary to achieve the desired state specified in the configuration files.

string

<= 1024 characters

metadata

object

creation_timestamp

creation_timestamp

Creation_timestamp is when the status object was created. It is used to find/tie-break for latest status object from same origin.

string format: date-time

<= 1024 characters

creator_class

creator_class

Class of creator which created this StatusObject. This will be service’s DNS FQDN. This will be set by the system based on client certificate information.

string

<= 1024 characters

creator_id

creator_id

ID of creator which created this StatusObject. This will be a concrete identifier for service (e.g. Identifying the environment also). This will be set by the system based on client certificate information.

string

<= 1024 characters

publish

string

default: STATUS_DO_NOT_PUBLISH

Allowed values: STATUS_DO_NOT_PUBLISH STATUS_PUBLISH

status_id

status_id

Status_id is a field used by the generator to distinguish (if necessary) between two status objects for the same config object from the same site and same service and potentially same daemon(creator-ID)

string

<= 1024 characters

uid

uid

Uid is the unique in time and space value for a StatusObject.

string format: uuid

>= 36 characters <= 1024 characters

vtrp_id

vtrp_id

Origin of this status exchanged by VTRP.

string

<= 1024 characters

vtrp_stale

vtrp_stale

Indicate whether mars deems this object to be stale via graceful restart timer information.

boolean format: boolean

object_refs

object_refs

AWS TGW view object direct reference.

Array<object>

ObjectRefType

object

kind

kind

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then kind will hold the referred object’s kind (e.g. “route”)

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

tenant

tenant

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then tenant will hold the referred object’s(e.g. Route’s) tenant.

string

>= 6 characters <= 1024 characters

uid

uid

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then uid will hold the referred object’s(e.g. Route’s) uid.

string format: uuid

>= 36 characters <= 1024 characters

resource_share_status

object

allow_external_principles

Allow External Principles

Manage Sharing Outside AWS Organization.

boolean format: boolean

creation_time

Resource Share Creation Time

Resource Share Creation Time.

string format: date-time

<= 1024 characters

deployment_status

Attachment Deployment Status

Attachment Deployment Status.

string

<= 1024 characters

invitation_status

Resource Share Invitation State

Resource Share Invitation State.

string

<= 1024 characters

last_updated_time

Resource Share Last Update Time

Resource Share Last Update Time.

string format: date-time

<= 1024 characters

owner_account_id

Resource Share Owner Account ID

Resource Share Owner Account ID.

string

<= 1024 characters

receiver_account_id

Resource Share Acceptor Account ID

Resource Share Acceptor Account ID.

Array<string>

resource_share_arn

Resource Share ARN

Resource Share ARN.

string

<= 1024 characters

resource_share_invitation_arn

Resource Share Invititation ARN

Resource Share Invititation ARN.

string

<= 1024 characters

resource_share_name

Resource Share Name

Resource Share Name.

string

<= 1024 characters

status

Resource Share State

Resource Share State.

string

>= 17 characters <= 1024 characters

tags

Resource Share Tags

Resource Share Tags.

object

tgw

object

status_msg

TGW Deployment Status

X-displayName “TGW Deployment Status” TGW Deployment Status.

string

<= 1024 characters

tags

TGW Tags

TGW Tags

object

tgw_amazon_asn

AWS Side ASN of TGW

AWS Side ASN of TGW.

string format: int64

<= 1024 characters

tgw_arn

TGW ARN

TGW ARN

string

<= 1024 characters

tgw_cidrs

TGW CIDRs

X-displayName “TGW CIDRs” TGW CIDRs.

Array<string>

tgw_creation_time

TGW creation time

TGW Creation Time.

string format: date-time

<= 1024 characters

tgw_id

TGW ID

TGW ID

string

<= 1024 characters

tgw_owner_account

TGW Owner

TGW Owner Account.

string

<= 1024 characters

tgw_region

TGW Region

TGW Region.

string

<= 1024 characters

tgw_state

TGW State

TGW State

string

<= 1024 characters

vpc_attachments

object

attachment_status

AWS VPC Attachment Status Type

AWS Attachment Status Type.

Array<object>

AWS VPC Attachment Status Type

AWS Attachment Status Type.

object

association_route_table_id

Association route table ID

Association route table ID.

string

<= 1024 characters

association_state

Association state

Transit Gateway route table association state.

string

<= 1024 characters

creation_time

Attachment Creation Time

Attachment Creation Time.

string format: date-time

<= 1024 characters

deployment_status

Additional VPC attachment deployment status

Additional VPC attachment deployment status.

string

<= 1024 characters

installed_routes

object

route_tables

List of route tables

Route Tables

Required: YES.

Array<object>

>= 1 items <= 200 items

AWS Route Table

AWS Route Table.

object

route_table_id

Route table ID

Route table ID.

string

<= 64 characters

static_routes

static_routes

List of Static Routes Required: YES.

Array<string>

>= 1 items <= 50 items

subnets

Subnets

Network Interfaces created along with the attachment.

Array<object>

SubnetStatusType for AWS VPC Attachment

Network Interface Status.

object

availability_zone

Availability Zone x-displayName: "Availability Zone"

Availability Zone.

string

<= 1024 characters

interface_type

Interface Type x-displayName: "Interface Type"

Interface Type.

string

<= 1024 characters

network_interface_id

Network Interface ID

Network Interface ID.

string

<= 1024 characters

private_ipv4_address

Private IPV4 Address x-displayName: "Private IPV4 Address"

Private IPv4 Address.

string

<= 1024 characters

status

Status x-displayName: "Status"

Status

string

>= 17 characters <= 1024 characters

subnet_id

Subnet ID x-displayName: "Subnet ID"

Subnet ID

string

<= 1024 characters

tags

Attachment Tags

Attachment Tags.

object

tgw_attachment_id

TGW Attachment ID

TGW Attachment ID.

string

<= 1024 characters

tgw_attachment_name

TGW Attachment Name

TGW Attachment Name.

string

<= 1024 characters

vpc_cidr

VPC CIDR

VPC CIDR

string

<= 1024 characters

vpc_deployment_state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

vpc_id

VPC ID

VPC ID

string

<= 1024 characters

vpc_name

VPC Name

VPC Name

string

<= 1024 characters

vpc_owner_id

VPC Owner Account

VPC Owner Account.

string

<= 1024 characters

connect_attachment_status

AWS Connect Attachment Status Type

AWS Connect Attachment Status Type.

Array<object>

<= 1 items

AWS Connect Attachment Status Type

AWS Connect Attachment Status Type.

object

association_route_table_id

Association route table ID

Association route table ID.

string

<= 1024 characters

association_state

Association state

Transit Gateway route table association state.

string

<= 1024 characters

connect_deployment_state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

deployment_status

Deployment Status

Additional information related to the connect attachment deployment.

string

<= 1024 characters

peers

Connect Peers

Connect Peers.

Array<object>

AWS Connect Peer Status Type

AWS Connect Peer Status Type.

object

connect_attachment_id

Connect attachment ID

Connect attachment ID.

string

<= 1024 characters

connect_peer_deployment_state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

connect_peer_id

Connect Peer ID

Connect Peer ID.

string

<= 1024 characters

deployment_status

Deployment Status

Additional information related to the connect peer attachment deployment.

string

<= 1024 characters

name

Connect Peer Name

Connect Peer Name.

string

>= 6 characters <= 1024 characters

tags

Connect Peer Tags

Connect Peer Tags.

object

peer_gre_address

Peer GRE Address

Network address or location

string

<= 1024 characters

transit_gateway_gre_address

Transit Gateway GRE Address

Network address or location

string

<= 1024 characters

protocol

Connect protocol

Connect protocol.

string

<= 1024 characters

tags

Attachment Tags

Attachment Tags.

object

transit_gateway_asn

Transit Gateway ASN

Transit Gateway ASN.

string

<= 1024 characters

transit_gateway_attachment_id

Transit Gateway Attachment ID

Transit Gateway Attachment ID.

string

<= 1024 characters

transit_gateway_attachment_name

Transit Gateway Attachment Name

Transit Gateway Attachment Name.

string

<= 1024 characters

transit_gateway_id

Transit Gateway ID

Transit Gateway ID.

string

<= 1024 characters

transport_attachment_id

Transport attachment ID

Transport attachment ID.

string

<= 1024 characters

tgw_route_table_status

AWS Transit Gateway Route Table Status Type

AWS Transit Gateway Route Table Status Type.

Array<object>

<= 2 items

AWS Transit Gateway Route Table Status Type

AWS Transit Gateway Route Table Status Type.

object

associations

Assciations

Associations.

Array<object>

AWS Transit Gateway Route Table Associations

AWS Transit Gateway Route Table Associations.

object

attachment_id

Attachment ID

Attachment ID.

string

<= 1024 characters

deployment_status

Deployment Status

Additional information related to the TGW routing.

string

<= 1024 characters

resource_id

Resource ID

Resource ID.

string

<= 1024 characters

resource_type

Resource type

Resource type.

string

<= 1024 characters

state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

deployment_status

Deployment Status

Additional information related to the TGW routing.

string

<= 1024 characters

propagations

Propagations

Propagations.

Array<object>

AWS Transit Gateway Route Table Associations

AWS Transit Gateway Route Table Associations.

object

attachment_id

Attachment ID

Attachment ID.

string

<= 1024 characters

deployment_status

Deployment Status

Additional information related to the TGW routing.

string

<= 1024 characters

resource_id

Resource ID

Resource ID.

string

<= 1024 characters

resource_type

Resource type

Resource type.

string

<= 1024 characters

state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

tags

Attachment Tags

Attachment Tags.

object

tgw_rt_deployment_state

string

default: AVAILABLE

Allowed values: AVAILABLE PENDING FAILED DELETED DELETING INITIATED

transit_gateway_id

Transit Gateway ID

Transit Gateway ID.

string

<= 1024 characters

transit_gateway_route_table_id

Transit gateway route table ID

Transit gateway route table ID.

string

<= 1024 characters

transit_gateway_route_table_name

Transit gateway route table Name

Transit gateway route table Name.

string

<= 1024 characters

system_metadata

object

creation_timestamp

creation_timestamp

CreationTimestamp is a timestamp representing the server time when this object was created. It is not guaranteed to be set in happens-before order across separate operations. Clients may not set this value. It is represented in RFC3339 form and is in UTC.

string format: date-time

<= 1024 characters

creator_class

creator_class

A value identifying the class of the user or service which created this configuration object.

string

<= 1024 characters

creator_id

creator_id

A value identifying the exact user or service that created this configuration object.

string

<= 1024 characters

deletion_timestamp

deletion_timestamp

DeletionTimestamp is RFC 3339 date and time at which this resource will be deleted. This field is set by the server when a graceful deletion is requested by the user, and is not directly settable by a client. The resource is expected to be deleted (no longer visible from resource lists, and not reachable by name) after the time in this field, once the finalizers list is empty. As long as the finalizers list contains items, deletion is blocked. Once the deletionTimestamp is set, this value may not be unset or be set further into the future, although it may be shortened or the resource may be deleted prior to this time. For example, a user may request that a pod is deleted in 30 seconds. The Kubelet will react by sending a graceful termination signal to the containers in the pod. After that 30 seconds, the Kubelet will send a hard termination signal (SIGKILL) to the container and after cleanup, remove the pod from the API. In the presence of network partitions, this object may still exist after this timestamp, until an administrator or automated process can determine the resource is fully terminated. If not set, graceful deletion of the object has not been requested.

Populated by the system when a graceful deletion is requested. Read-only.

string format: date-time

<= 1024 characters

finalizers

finalizers

Must be empty before the object is deleted from the registry. Each entry is an identifier for the responsible component that will remove the entry from the list. If the deletionTimestamp of the object is non-nil, entries in this list can only be removed.

Array<string>

initializers

object

pending

pending

Pending is a list of initializers that must execute in order before this object is initialized. When the last pending initializer is removed, and no failing result is set, the initializers struct will be set to nil and the object is considered as initialized and visible to all clients.

Array<object>

InitializerType

Initializer is information about an initializer that has not yet completed.

object

name

name

Name of the service that is responsible for initializing this object.

string

>= 6 characters <= 1024 characters

result

object

code

code

Suggested HTTP return code for this status, 0 if not set.

integer format: int32

reason

reason

A human-readable description of why this operation is in the “Failure” status. If this value is empty there is no information available.

string

>= 27 characters <= 1024 characters

status

status

Status of the operation. One of: “Success” or “Failure”.

string

>= 17 characters <= 1024 characters

labels

labels

Map of string keys and values that can be used to organize and categorize (scope and select) objects as chosen by the operator or software. Values here can be interpreted by software(backend or frontend) to enable certain behavior e.g. Things marked as soft-deleted(restorable).

object

modification_timestamp

modification_timestamp

ModificationTimestamp is a timestamp representing the server time when this object was last modified.

string format: date-time

<= 1024 characters

object_index

object_index

Unique index for the object. Some objects need a unique integer index to be allocated for each object type. This field will be populated for all objects that need it and will be zero otherwise.

integer format: int64

owner_view

object

kind

kind

Kind of the view object.

string

>= 12 characters <= 1024 characters

name

name

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then name will hold the referred object’s(e.g. Route’s) name.

string

>= 6 characters <= 1024 characters

namespace

namespace

When a configuration object(e.g. Virtual_host) refers to another(e.g route) then namespace will hold the referred object’s(e.g. Route’s) namespace.

string

>= 6 characters <= 1024 characters

uid

uid

UID of the view object.

string format: uuid

>= 36 characters <= 1024 characters

tenant

tenant

Tenant to which this configuration object belongs to. The value for this is found from presented credentials.

string

>= 6 characters <= 1024 characters

uid

uid

Uid is the unique in time and space value for this object. It is generated by the server on successful creation of an object and is not allowed to change on Replace API. The value of is taken from uid field of ObjectMetaType, if provided.

string format: uuid

>= 36 characters <= 1024 characters

Example

{
  "create_form": {
    "spec": {
      "aws_parameters": {
        "admin_password": {
          "secret_encoding_type": "EncodingNone",
          "vault_secret_info": {
            "secret_encoding": "EncodingNone"
          }
        }
      },
      "blocked_services": {
        "blocked_sevice": [
          {
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        ]
      },
      "vn_config": {
        "inside_static_routes": {
          "static_route_list": [
            {
              "custom_static_route": {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ],
                "nexthop": {
                  "type": "NEXT_HOP_DEFAULT_GATEWAY"
                }
              }
            }
          ]
        },
        "outside_static_routes": {
          "static_route_list": [
            {
              "custom_static_route": {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ],
                "nexthop": {
                  "type": "NEXT_HOP_DEFAULT_GATEWAY"
                }
              }
            }
          ]
        }
      }
    }
  },
  "replace_form": {
    "spec": {
      "blocked_services": {
        "blocked_sevice": [
          {
            "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
          }
        ]
      },
      "vn_config": {
        "inside_static_routes": {
          "static_route_list": [
            {
              "custom_static_route": {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ],
                "nexthop": {
                  "type": "NEXT_HOP_DEFAULT_GATEWAY"
                }
              }
            }
          ]
        },
        "outside_static_routes": {
          "static_route_list": [
            {
              "custom_static_route": {
                "attrs": [
                  "ROUTE_ATTR_NO_OP"
                ],
                "nexthop": {
                  "type": "NEXT_HOP_DEFAULT_GATEWAY"
                }
              }
            }
          ]
        }
      }
    }
  },
  "spec": {
    "aws_parameters": {
      "admin_password": {
        "secret_encoding_type": "EncodingNone",
        "vault_secret_info": {
          "secret_encoding": "EncodingNone"
        }
      }
    },
    "blocked_services": {
      "blocked_sevice": [
        {
          "network_type": "VIRTUAL_NETWORK_SITE_LOCAL"
        }
      ]
    },
    "site_state": "ONLINE",
    "tunnel_type": "TUNNEL_IPSEC",
    "validation_state": "VALIDATION_STATE_NONE",
    "vn_config": {
      "inside_static_routes": {
        "static_route_list": [
          {
            "custom_static_route": {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ],
              "nexthop": {
                "type": "NEXT_HOP_DEFAULT_GATEWAY"
              }
            }
          }
        ]
      },
      "outside_static_routes": {
        "static_route_list": [
          {
            "custom_static_route": {
              "attrs": [
                "ROUTE_ATTR_NO_OP"
              ],
              "nexthop": {
                "type": "NEXT_HOP_DEFAULT_GATEWAY"
              }
            }
          }
        ]
      }
    }
  },
  "status": [
    {
      "deployment": {
        "apply_status": {
          "apply_state": "APPLIED",
          "destroy_state": "DESTROYED",
          "infra_state": "PROVISIONED"
        },
        "plan_status": {
          "infra_state": "PROVISIONED",
          "plan_state": "PLANNING"
        }
      },
      "metadata": {
        "publish": "STATUS_DO_NOT_PUBLISH"
      },
      "vpc_attachments": {
        "attachment_status": [
          {
            "vpc_deployment_state": "AVAILABLE"
          }
        ],
        "connect_attachment_status": [
          {
            "connect_deployment_state": "AVAILABLE",
            "peers": [
              {
                "connect_peer_deployment_state": "AVAILABLE"
              }
            ]
          }
        ],
        "tgw_route_table_status": [
          {
            "associations": [
              {
                "state": "AVAILABLE"
              }
            ],
            "propagations": [
              {
                "state": "AVAILABLE"
              }
            ],
            "tgw_rt_deployment_state": "AVAILABLE"
          }
        ]
      }
    }
  ]
}

401

Returned when operation is not authorized.

application/json

string format: string

Example^generated

example

403

Returned when there is no permission to access resource.

application/json

string format: string

Example^generated

example

404

Returned when resource is not found.

application/json

string format: string

Example^generated

example

409

Returned when operation on resource is conflicting with current value.

application/json

string format: string

Example^generated

example

429

Returned when operation has been rejected as it is happening too frequently.

application/json

string format: string

Example^generated

example

500

Returned when server encountered an error in processing API.

application/json

string format: string

Example^generated

example

503

Returned when service is unavailable temporarily.

application/json

string format: string

Example^generated

example

504

Returned when server timed out processing request.

application/json

string format: string

Example^generated

example

GET AWS TGW site.

Authorizations

Parameters

Path Parameters

Query Parameters

Responses

200

Example

401

Examplegenerated

403

Examplegenerated

404

Examplegenerated

409

Examplegenerated

429

Examplegenerated

500

Examplegenerated

503

Examplegenerated

504

Examplegenerated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated

Example^generated