Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AWS ¶
type AWS struct {
// ProviderId The ID of the VPC peer on GCP.
ProviderId string `json:"ProviderId"`
// AWSConfigData is the AWS config data required to establish a VPC peering relationship.
AWSConfigData AWSConfigData `json:"AWSConfig"`
}
AWS provides details about the configuration and the ID of the VPC peer on AWS.
type AWSConfigData ¶
type AWSConfigData struct {
// AccountId The numeric AWS Account ID or Owner ID.
AccountId string `json:"accountId"`
// Cidr The AWS VPC CIDR block of network in which your application runs. This cannot overlap with your Capella CIDR Block.
Cidr string `json:"cidr"`
// Region The AWS region where your VPC is deployed.
Region string `json:"region"`
// VpcId The alphanumeric VPC ID which starts with \"vpc-\". This is also known as the networkId.
VpcId string `json:"vpcId"`
}
AWSConfigData is the AWS config data required to establish a VPC peering relationship.
Refer to the docs for other limitations to AWS VPC Peering - [ref](https://docs.aws.amazon.com/vpc/latest/peering/vpc-peering-basics.html#vpc-peering-limitations).
type CreateNetworkPeeringRequest ¶
type CreateNetworkPeeringRequest struct {
// Name is the name of the peering relationship. - The name of the peering relationship must be at least 2 characters long. - The name can not exceed 128 characters.
Name string `json:"name"`
// ProviderConfig The config data for a peering relationship for a cluster on AWS, GCP.
ProviderConfig json.RawMessage `json:"providerConfig"`
// ProviderType Type of the cloud provider for which the peering connection is created. Which are- 1. aws 2. gcp
ProviderType string `json:"providerType"`
}
CreateNetworkPeeringRequest Creates a network peering record for Capella. Capella does not support peering of networks between different cloud providers. For example, you cannot peer GCP VPC that hosts Capella cluster with an AWS VPC hosting an application.
- Create configures a Couchbase Capella private networking with the cloud provider. Setting up a private network enables your application to interact with Couchbase Capella over a private connection by co-locating them through network peering.
In order to access this endpoint, the provided API key must have at least one of the following roles: - Organization Owner - Project Owner - Cluster Owner
To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).
type CreateNetworkPeeringResponse ¶
type CreateNetworkPeeringResponse struct {
// Id is the ID is the unique UUID generated when a VPC record is created.
Id uuid.UUID `json:"id"`
}
CreateNetworkPeeringResponse is the response received from the Capella V4 Public API when asked to create a new network peering connection.
type GCP ¶
type GCP struct {
// ProviderId The ID of the VPC peer on GCP.
ProviderId string `json:"ProviderId"`
// GCPConfigData GCP config data required to establish a VPC peering relationship.
GCPConfigData GCPConfigData `json:"GCPConfig"`
}
GCP provides details about the configuration and the ID of the VPC peer on GCP.
type GCPConfigData ¶
type GCPConfigData struct {
// Cidr The GCP VPC CIDR block of network in which your application runs. This cannot overlap with your Capella CIDR Block.
Cidr string `json:"cidr"`
// NetworkName The name of the network that you want to peer with.
NetworkName string `json:"networkName"`
// ProjectId The unique identifier for your GCP project.
ProjectId string `json:"projectId"`
// ServiceAccount is the ServiceAccount created or assigned on the external VPC project. GCP Service Account with below permissions
// - DNS Admin
// - Compute.NetworkAdmin
// It should be in the form of an email that is shown under `gcloud iam service-accounts list` command.
// [Reference](https://cloud.google.com/iam/docs/creating-managing-service-accounts#creating)
ServiceAccount string `json:"serviceAccount"`
}
GCPConfigData GCP config data required to establish a VPC peering relationship. Refer to the docs for other limitations to GCP VPC Peering - [ref](https://cloud.google.com/vpc/docs/vpc-peering).
type GetNetworkPeeringRecordResponse ¶
type GetNetworkPeeringRecordResponse struct {
Audit api.CouchbaseAuditData `json:"audit"`
// Commands contains the list of commands that the user must execute in order to complete the association of the network.
Commands []string `json:"commands"`
// Id The ID is the unique UUID generated when a VPC record is created.
Id uuid.UUID `json:"id"`
// Name is the name of the peering relationship.
Name string `json:"name"`
// ProviderType Type of the cloud provider for which the peering connection is created. Which are- 1. aws 2. gcp
ProviderType string `json:"providerType"`
// ProviderConfig This provides details about the configuration and the ID of the VPC peer on AWS, GCP.
ProviderConfig json.RawMessage `json:"providerConfig"`
// PeeringStatus communicates the state of the VPC peering relationship. It is the state and reasoning for VPC peer.
Status PeeringStatus `json:"status"`
}
GetNetworkPeeringRecordResponse Fetches the details of the network peering meta data based on the peerID provided.
In order to access this endpoint, the provided API key must have at least one of the following roles: - Organization Owner - Project Owner - Cluster Owner To learn more, see [Organization, Project, and Database Access Overview](https://docs.couchbase.com/cloud/organizations/organization-projects-overview.html).
func (GetNetworkPeeringRecordResponse) AsAWS ¶
func (t GetNetworkPeeringRecordResponse) AsAWS() (AWS, error)
AsAWS returns the union data inside the GetNetworkPeeringRecordResponse as a AWS.
func (GetNetworkPeeringRecordResponse) AsGCP ¶
func (t GetNetworkPeeringRecordResponse) AsGCP() (GCP, error)
AsGCP returns the union data inside the GetNetworkPeeringRecordResponse_ProviderConfig as a GCP.
type PeeringStatus ¶
type PeeringStatus struct {
Reasoning *string `json:"reasoning,omitempty"`
State *string `json:"state,omitempty"`
}
PeeringStatus communicates the state of the VPC peering relationship. It is the state and reasoning for VPC peer.
Source Files