redocly logoAPI docs by Redocly

F5 Distributed Cloud Services API for ves.io.schema.views.aws_tgw_site

Download OpenAPI specification:Download

AWS TGW site view defines a required parameters that can be used in CRUD, to create and manage a volterra site in AWS VPC. It can be used to automatically site creation in the AWS TGW.

View will create following child objects.

  • Site

Create AWS TGW site

Shape of the AWS TGW site specification

Examples of this operation
path Parameters
metadata.namespace
required
string

namespace

x-example: "staging" 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 ""

Request Body schema: application/json
required
object (ObjectCreateMetaType)

ObjectCreateMetaType is metadata that can be specified in Create request of an object.

object (CreateSpecType)

Shape of the AWS TGW site specification

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": {
    }
}

Response samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": {
    },
  • "system_metadata": {
    }
}

Replace AWS TGW site

Shape of the AWS TGW site replace specification

Examples of this operation
path Parameters
metadata.namespace
required
string

namespace

x-example: "staging" 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 ""

metadata.name
required
string

name

x-example: "acmecorp-web" The configuration object to be replaced will be looked up by name

Request Body schema: application/json
required
object (ObjectReplaceMetaType)

ObjectReplaceMetaType is metadata that can be specified in Replace request of an object.

object (ReplaceSpecType)

Shape of the AWS TGW site replace specification

Responses

Request samples

Content type
application/json
{
  • "metadata": {
    },
  • "spec": {
    }
}

Response samples

Content type
application/json
{ }

Configure TGW Information

Configure TGW Information like tgw-id, volterra site's vpc-id

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "default" Namespace for the object to be configured

name
required
string

Name

x-example: "aws-tgw-site-1" Name of the object to be configured

Request Body schema: application/json
required
object (DirectConnect Info)

DirectConnect Info

name
string (Name)

Name of the object to be configured

Example: "aws-tgw-site-1"

namespace
string (Namespace)

Namespace for the object to be configured

Example: "default"

object (AWS TGW Information Config)

AWS tgw information like tgw-id and site's vpc-id

Responses

Request samples

Content type
application/json
{
  • "direct_connect_info": {
    },
  • "name": "string",
  • "namespace": "string",
  • "tgw_info": {
    }
}

Response samples

Content type
application/json
{ }

Configure AWS TGW Site VIP Information

Configure AWS TGW Site VIP Information

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "default" Namespace for the object to be configured

name
required
string

Name

x-example: "aws-tgw-site-1" Name of the object to be configured

Request Body schema: application/json
required
name
string (Name)

Name of the object to be configured

Example: "aws-tgw-site-1"

namespace
string (Namespace)

Namespace for the object to be configured

Example: "default"

Array of objects (VIP Params Per AZ)

VIP Parameters per AZ

Example: "master-0"

Validation Rules: ves.io.schema.rules.repeated.num_items: 1,2,3

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "namespace": "string",
  • "vip_params_per_az": [
    ]
}

Response samples

Content type
application/json
{ }

Configure VPC IP prefixes

Configure VPC IP prefix set

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "default" Namespace for the object to be configured

name
required
string

Name

x-example: "aws-tgw-site-1" Name of the object to be configured

Request Body schema: application/json
required
name
string (Name)

Name of the object to be configured

Example: "aws-tgw-site-1"

namespace
string (Namespace)

Namespace for the object to be configured

Example: "default"

vpc_ip_prefixes
object (VPC IP Prefixes)

IP prefixes of subnets in the VPC.

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "namespace": "string",
  • "vpc_ip_prefixes": { }
}

Response samples

Content type
application/json
{ }

Configure VPN Tunnels

Configure VPC IP prefix set

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "default" Namespace for the object to be configured

name
required
string

Name

x-example: "aws-tgw-site-1" Name of the object to be configured

Request Body schema: application/json
required
name
string (Name)

Name of the object to be configured

Example: "aws-tgw-site-1"

namespace
string (Namespace)

Namespace for the object to be configured

Example: "default"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "namespace": "string"
}

Response samples

Content type
application/json
{ }

Validate AWS TGW Config

Validate AWS TGW Config

Examples of this operation
path Parameters
namespace
required
string

Namespace

x-example: "default" Namespace for the object to be configured

name
required
string

Name

x-example: "aws-vpc-site-1" Name of the object to be configured

Request Body schema: application/json
required
name
string (Name)

Name of the object to be configured

Example: "aws-vpc-site-1"

namespace
string (Namespace)

Namespace for the object to be configured

Example: "default"

Responses

Request samples

Content type
application/json
{
  • "name": "string",
  • "namespace": "string"
}

Response samples

Content type
application/json
{ }

List Configure AWS TGW Site

List the set of aws_tgw_site in a namespace

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" Namespace to scope the listing of aws_tgw_site

query Parameters
label_filter
string

x-example: "env in (staging, testing), tier in (web, db)" A LabelSelectorType expression that every item in list response will satisfy

report_fields
Array of strings

x-example: "" Extra fields to return along with summary fields

report_status_fields
Array of strings

x-example: "" Extra status fields to return along with summary fields

Responses

Response samples

Content type
application/json
{
  • "errors": [
    ],
  • "items": [
    ]
}

Get AWS TGW site

Shape of the AWS TGW site specification

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" The namespace in which the configuration object is present

name
required
string

name

x-example: "name" The name of the configuration object to be fetched

query Parameters
response_format
string
Default: "GET_RSP_FORMAT_DEFAULT"
Enum: "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

Response samples

Content type
application/json
{
  • "create_form": {
    },
  • "deleted_referred_objects": [
    ],
  • "disabled_referred_objects": [
    ],
  • "metadata": {
    },
  • "referring_objects": [
    ],
  • "replace_form": {
    },
  • "spec": {
    },
  • "status": [
    ],
  • "system_metadata": {
    }
}

Delete Configure AWS TGW Site

Delete the specified aws_tgw_site

Examples of this operation
path Parameters
namespace
required
string

namespace

x-example: "ns1" Namespace in which the configuration object is present

name
required
string

name

x-example: "name" Name of the configuration object

Request Body schema: application/json
required
fail_if_referred
boolean <boolean> (fail_if_referred)

Fail the delete operation if this object is being referred by other objects

name
string (name)

Name of the configuration object

Example: "name"

namespace
string (namespace)

Namespace in which the configuration object is present

Example: "ns1"

Responses

Request samples

Content type
application/json
{
  • "fail_if_referred": true,
  • "name": "string",
  • "namespace": "string"
}

Response samples

Content type
application/json
null