privatelink

package
v0.151.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Feb 13, 2026 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func ConnectionStateTypeChoices added in v0.3.0 

func ConnectionStateTypeChoices() []string

func ServicePrivatelinkAwsStateTypeChoices added in v0.151.0 

func ServicePrivatelinkAwsStateTypeChoices() []string

func ServicePrivatelinkAzureConnectionApprovalStateTypeChoices added in v0.3.0 

func ServicePrivatelinkAzureConnectionApprovalStateTypeChoices() []string

func ServicePrivatelinkAzureConnectionStateTypeChoices added in v0.3.0 

func ServicePrivatelinkAzureConnectionStateTypeChoices() []string

func ServicePrivatelinkAzureStateTypeChoices added in v0.3.0 

func ServicePrivatelinkAzureStateTypeChoices() []string

Types

type ConnectionOut 

type ConnectionOut struct {
	DnsName                 string              `json:"dns_name"`                            // The VPC Endpoint DNS name that the Aiven privatelink access route DNS name is using as the value for itsCNAME record. This DNS name resolves to the private IP addresses of the VPC Endpoint's NICs in all configured subnets
	PrivatelinkConnectionId *string             `json:"privatelink_connection_id,omitempty"` // Privatelink connection ID
	State                   ConnectionStateType `json:"state"`                               // The Aiven connection state. The AWS VPC endpoint state is always available for listed connections
	VpcEndpointId           string              `json:"vpc_endpoint_id"`                     // AWS VPC Endpoint ID
}

type ConnectionStateType added in v0.3.0 

type ConnectionStateType string
const (
	ConnectionStateTypeActive              ConnectionStateType = "active"
	ConnectionStateTypeConnected           ConnectionStateType = "connected"
	ConnectionStateTypePendingUserApproval ConnectionStateType = "pending-user-approval"
	ConnectionStateTypeUserApproved        ConnectionStateType = "user-approved"
)

type Handler 

type Handler interface {
	// PublicPrivatelinkAvailabilityList list privatelink clouds and prices
	// GET /v1/tenants/{tenant}/privatelink-availability
	// https://api.aiven.io/doc/#tag/Cloud_platforms/operation/PublicPrivatelinkAvailabilityList
	PublicPrivatelinkAvailabilityList(ctx context.Context, tenant string) ([]PrivatelinkAvailabilityOut, error)

	// ServicePrivatelinkAWSConnectionList list VPC Endpoint connections for an AWS Privatelink Endpoint Service
	// GET /v1/project/{project}/service/{service_name}/privatelink/aws/connections
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAWSConnectionList
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAWSConnectionList(ctx context.Context, project string, serviceName string) ([]ConnectionOut, error)

	// ServicePrivatelinkAWSCreate create an AWS Privatelink Endpoint Service
	// POST /v1/project/{project}/service/{service_name}/privatelink/aws
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAWSCreate
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAWSCreate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAwsCreateIn) (*ServicePrivatelinkAwsCreateOut, error)

	// ServicePrivatelinkAWSDelete delete an AWS Privatelink Endpoint Service
	// DELETE /v1/project/{project}/service/{service_name}/privatelink/aws
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAWSDelete
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAWSDelete(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAwsDeleteOut, error)

	// ServicePrivatelinkAWSGet get AWS Privatelink Endpoint Service information
	// GET /v1/project/{project}/service/{service_name}/privatelink/aws
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAWSGet
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAWSGet(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAwsGetOut, error)

	// ServicePrivatelinkAWSUpdate update an AWS Privatelink Endpoint Service
	// PUT /v1/project/{project}/service/{service_name}/privatelink/aws
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAWSUpdate
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAWSUpdate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAwsUpdateIn) (*ServicePrivatelinkAwsUpdateOut, error)

	// ServicePrivatelinkAzureConnectionApproval approve an Azure private endpoint connection pending user approval
	// POST /v1/project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}/approve
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureConnectionApproval
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureConnectionApproval(ctx context.Context, project string, serviceName string, privatelinkConnectionId string) (*ServicePrivatelinkAzureConnectionApprovalOut, error)

	// ServicePrivatelinkAzureConnectionList list private endpoint connections for an Azure Privatelink Service
	// GET /v1/project/{project}/service/{service_name}/privatelink/azure/connections
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureConnectionList
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureConnectionList(ctx context.Context, project string, serviceName string) ([]ServicePrivatelinkAzureConnectionListOut, error)

	// ServicePrivatelinkAzureConnectionUpdate update a private endpoint connection for an Azure Privatelink Service
	// PUT /v1/project/{project}/service/{service_name}/privatelink/azure/connections/{privatelink_connection_id}
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureConnectionUpdate
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureConnectionUpdate(ctx context.Context, project string, serviceName string, privatelinkConnectionId string, in *ServicePrivatelinkAzureConnectionUpdateIn) (*ServicePrivatelinkAzureConnectionUpdateOut, error)

	// ServicePrivatelinkAzureCreate create an Azure Privatelink Service
	// POST /v1/project/{project}/service/{service_name}/privatelink/azure
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureCreate
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureCreate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAzureCreateIn) (*ServicePrivatelinkAzureCreateOut, error)

	// ServicePrivatelinkAzureDelete delete an Azure Privatelink Service
	// DELETE /v1/project/{project}/service/{service_name}/privatelink/azure
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureDelete
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureDelete(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAzureDeleteOut, error)

	// ServicePrivatelinkAzureGet get Azure Privatelink Service information
	// GET /v1/project/{project}/service/{service_name}/privatelink/azure
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureGet
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureGet(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAzureGetOut, error)

	// ServicePrivatelinkAzureUpdate update an Azure Privatelink Service
	// PUT /v1/project/{project}/service/{service_name}/privatelink/azure
	// https://api.aiven.io/doc/#tag/Service/operation/ServicePrivatelinkAzureUpdate
	// Required roles or permissions: service:configuration:write
	ServicePrivatelinkAzureUpdate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAzureUpdateIn) (*ServicePrivatelinkAzureUpdateOut, error)
}

type PrivatelinkAvailabilityOut 

type PrivatelinkAvailabilityOut struct {
	CloudName string `json:"cloud_name"` // Target cloud
	PriceUsd  string `json:"price_usd"`  // Hourly privatelink price in this cloud region
}

type PrivatelinkHandler 

type PrivatelinkHandler struct {
	// contains filtered or unexported fields
}

func NewHandler 

func NewHandler(doer doer) PrivatelinkHandler

func (*PrivatelinkHandler) PublicPrivatelinkAvailabilityList 

func (h *PrivatelinkHandler) PublicPrivatelinkAvailabilityList(ctx context.Context, tenant string) ([]PrivatelinkAvailabilityOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAWSConnectionList 

func (h *PrivatelinkHandler) ServicePrivatelinkAWSConnectionList(ctx context.Context, project string, serviceName string) ([]ConnectionOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAWSCreate 

func (h *PrivatelinkHandler) ServicePrivatelinkAWSCreate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAwsCreateIn) (*ServicePrivatelinkAwsCreateOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAWSDelete 

func (h *PrivatelinkHandler) ServicePrivatelinkAWSDelete(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAwsDeleteOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAWSGet 

func (h *PrivatelinkHandler) ServicePrivatelinkAWSGet(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAwsGetOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAWSUpdate 

func (h *PrivatelinkHandler) ServicePrivatelinkAWSUpdate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAwsUpdateIn) (*ServicePrivatelinkAwsUpdateOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureConnectionApproval 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureConnectionApproval(ctx context.Context, project string, serviceName string, privatelinkConnectionId string) (*ServicePrivatelinkAzureConnectionApprovalOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureConnectionList 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureConnectionList(ctx context.Context, project string, serviceName string) ([]ServicePrivatelinkAzureConnectionListOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureConnectionUpdate 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureConnectionUpdate(ctx context.Context, project string, serviceName string, privatelinkConnectionId string, in *ServicePrivatelinkAzureConnectionUpdateIn) (*ServicePrivatelinkAzureConnectionUpdateOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureCreate 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureCreate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAzureCreateIn) (*ServicePrivatelinkAzureCreateOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureDelete 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureDelete(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAzureDeleteOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureGet 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureGet(ctx context.Context, project string, serviceName string) (*ServicePrivatelinkAzureGetOut, error)

func (*PrivatelinkHandler) ServicePrivatelinkAzureUpdate 

func (h *PrivatelinkHandler) ServicePrivatelinkAzureUpdate(ctx context.Context, project string, serviceName string, in *ServicePrivatelinkAzureUpdateIn) (*ServicePrivatelinkAzureUpdateOut, error)

type ServicePrivatelinkAwsCreateIn added in v0.151.0 

type ServicePrivatelinkAwsCreateIn struct {
	Principals []string `json:"principals"` // ARNs of principals allowed connecting to the service
}

ServicePrivatelinkAwsCreateIn ServicePrivatelinkAWSCreateRequestBody

type ServicePrivatelinkAwsCreateOut added in v0.151.0 

type ServicePrivatelinkAwsCreateOut struct {
	AwsServiceId   *string                        `json:"aws_service_id,omitempty"`   // AWS VPC endpoint service ID
	AwsServiceName *string                        `json:"aws_service_name,omitempty"` // AWS VPC endpoint service name
	Principals     []string                       `json:"principals"`                 // ARNs of principals allowed connecting to the service
	State          ServicePrivatelinkAwsStateType `json:"state"`                      // Privatelink resource state
}

ServicePrivatelinkAwsCreateOut ServicePrivatelinkAWSCreateResponse

type ServicePrivatelinkAwsDeleteOut added in v0.151.0 

type ServicePrivatelinkAwsDeleteOut struct {
	AwsServiceId   *string                        `json:"aws_service_id,omitempty"`   // AWS VPC endpoint service ID
	AwsServiceName *string                        `json:"aws_service_name,omitempty"` // AWS VPC endpoint service name
	Principals     []string                       `json:"principals"`                 // ARNs of principals allowed connecting to the service
	State          ServicePrivatelinkAwsStateType `json:"state"`                      // Privatelink resource state
}

ServicePrivatelinkAwsDeleteOut ServicePrivatelinkAWSDeleteResponse

type ServicePrivatelinkAwsGetOut added in v0.151.0 

type ServicePrivatelinkAwsGetOut struct {
	AwsServiceId   *string                        `json:"aws_service_id,omitempty"`   // AWS VPC endpoint service ID
	AwsServiceName *string                        `json:"aws_service_name,omitempty"` // AWS VPC endpoint service name
	Principals     []string                       `json:"principals"`                 // ARNs of principals allowed connecting to the service
	State          ServicePrivatelinkAwsStateType `json:"state"`                      // Privatelink resource state
}

ServicePrivatelinkAwsGetOut ServicePrivatelinkAWSGetResponse

type ServicePrivatelinkAwsStateType added in v0.151.0 

type ServicePrivatelinkAwsStateType string
const (
	ServicePrivatelinkAwsStateTypeActive   ServicePrivatelinkAwsStateType = "active"
	ServicePrivatelinkAwsStateTypeCreating ServicePrivatelinkAwsStateType = "creating"
	ServicePrivatelinkAwsStateTypeDeleting ServicePrivatelinkAwsStateType = "deleting"
)

type ServicePrivatelinkAwsUpdateIn added in v0.151.0 

type ServicePrivatelinkAwsUpdateIn struct {
	Principals []string `json:"principals"` // ARNs of principals allowed connecting to the service
}

ServicePrivatelinkAwsUpdateIn ServicePrivatelinkAWSUpdateRequestBody

type ServicePrivatelinkAwsUpdateOut added in v0.151.0 

type ServicePrivatelinkAwsUpdateOut struct {
	AwsServiceId   *string                        `json:"aws_service_id,omitempty"`   // AWS VPC endpoint service ID
	AwsServiceName *string                        `json:"aws_service_name,omitempty"` // AWS VPC endpoint service name
	Principals     []string                       `json:"principals"`                 // ARNs of principals allowed connecting to the service
	State          ServicePrivatelinkAwsStateType `json:"state"`                      // Privatelink resource state
}

ServicePrivatelinkAwsUpdateOut ServicePrivatelinkAWSUpdateResponse

type ServicePrivatelinkAzureConnectionApprovalOut 

type ServicePrivatelinkAzureConnectionApprovalOut struct {
	PrivateEndpointId       string                                             `json:"private_endpoint_id"`                 // Azure private endpoint ID
	PrivatelinkConnectionId *string                                            `json:"privatelink_connection_id,omitempty"` // Privatelink connection ID
	State                   ServicePrivatelinkAzureConnectionApprovalStateType `json:"state"`                               // The Aiven connection state. The Azure connection status has a separate value
	UserIpAddress           string                                             `json:"user_ip_address"`                     // (Private) IP address of Privatelink endpoint
}

ServicePrivatelinkAzureConnectionApprovalOut ServicePrivatelinkAzureConnectionApprovalResponse

type ServicePrivatelinkAzureConnectionApprovalStateType added in v0.3.0 

type ServicePrivatelinkAzureConnectionApprovalStateType string
const (
	ServicePrivatelinkAzureConnectionApprovalStateTypeActive              ServicePrivatelinkAzureConnectionApprovalStateType = "active"
	ServicePrivatelinkAzureConnectionApprovalStateTypeConnected           ServicePrivatelinkAzureConnectionApprovalStateType = "connected"
	ServicePrivatelinkAzureConnectionApprovalStateTypePendingUserApproval ServicePrivatelinkAzureConnectionApprovalStateType = "pending-user-approval"
	ServicePrivatelinkAzureConnectionApprovalStateTypeUserApproved        ServicePrivatelinkAzureConnectionApprovalStateType = "user-approved"
)

type ServicePrivatelinkAzureConnectionListOut added in v0.36.0 

type ServicePrivatelinkAzureConnectionListOut struct {
	PrivateEndpointId       string              `json:"private_endpoint_id"`                 // Azure private endpoint ID
	PrivatelinkConnectionId *string             `json:"privatelink_connection_id,omitempty"` // Privatelink connection ID
	State                   ConnectionStateType `json:"state"`                               // The Aiven connection state. The Azure connection status has a separate value
	UserIpAddress           string              `json:"user_ip_address"`                     // (Private) IP address of Privatelink endpoint
}

type ServicePrivatelinkAzureConnectionStateType added in v0.3.0 

type ServicePrivatelinkAzureConnectionStateType string
const (
	ServicePrivatelinkAzureConnectionStateTypeActive              ServicePrivatelinkAzureConnectionStateType = "active"
	ServicePrivatelinkAzureConnectionStateTypeConnected           ServicePrivatelinkAzureConnectionStateType = "connected"
	ServicePrivatelinkAzureConnectionStateTypePendingUserApproval ServicePrivatelinkAzureConnectionStateType = "pending-user-approval"
	ServicePrivatelinkAzureConnectionStateTypeUserApproved        ServicePrivatelinkAzureConnectionStateType = "user-approved"
)

type ServicePrivatelinkAzureConnectionUpdateIn 

type ServicePrivatelinkAzureConnectionUpdateIn struct {
	UserIpAddress string `json:"user_ip_address"` // (Private) IP address of Privatelink endpoint
}

ServicePrivatelinkAzureConnectionUpdateIn ServicePrivatelinkAzureConnectionUpdateRequestBody

type ServicePrivatelinkAzureConnectionUpdateOut 

type ServicePrivatelinkAzureConnectionUpdateOut struct {
	PrivateEndpointId       string                                     `json:"private_endpoint_id"`                 // Azure private endpoint ID
	PrivatelinkConnectionId *string                                    `json:"privatelink_connection_id,omitempty"` // Privatelink connection ID
	State                   ServicePrivatelinkAzureConnectionStateType `json:"state"`                               // The Aiven connection state. The Azure connection status has a separate value
	UserIpAddress           string                                     `json:"user_ip_address"`                     // (Private) IP address of Privatelink endpoint
}

ServicePrivatelinkAzureConnectionUpdateOut ServicePrivatelinkAzureConnectionUpdateResponse

type ServicePrivatelinkAzureCreateIn 

type ServicePrivatelinkAzureCreateIn struct {
	UserSubscriptionIds []string `json:"user_subscription_ids"` // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureCreateIn ServicePrivatelinkAzureCreateRequestBody

type ServicePrivatelinkAzureCreateOut 

type ServicePrivatelinkAzureCreateOut struct {
	AzureServiceAlias   *string                          `json:"azure_service_alias,omitempty"` // Azure Privatelink service alias
	AzureServiceId      *string                          `json:"azure_service_id,omitempty"`    // Azure Privatelink service ID
	State               ServicePrivatelinkAzureStateType `json:"state"`                         // Privatelink resource state
	UserSubscriptionIds []string                         `json:"user_subscription_ids"`         // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureCreateOut ServicePrivatelinkAzureCreateResponse

type ServicePrivatelinkAzureDeleteOut 

type ServicePrivatelinkAzureDeleteOut struct {
	AzureServiceAlias   *string                          `json:"azure_service_alias,omitempty"` // Azure Privatelink service alias
	AzureServiceId      *string                          `json:"azure_service_id,omitempty"`    // Azure Privatelink service ID
	State               ServicePrivatelinkAzureStateType `json:"state"`                         // Privatelink resource state
	UserSubscriptionIds []string                         `json:"user_subscription_ids"`         // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureDeleteOut ServicePrivatelinkAzureDeleteResponse

type ServicePrivatelinkAzureGetOut 

type ServicePrivatelinkAzureGetOut struct {
	AzureServiceAlias   *string                          `json:"azure_service_alias,omitempty"` // Azure Privatelink service alias
	AzureServiceId      *string                          `json:"azure_service_id,omitempty"`    // Azure Privatelink service ID
	State               ServicePrivatelinkAzureStateType `json:"state"`                         // Privatelink resource state
	UserSubscriptionIds []string                         `json:"user_subscription_ids"`         // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureGetOut ServicePrivatelinkAzureGetResponse

type ServicePrivatelinkAzureStateType added in v0.3.0 

type ServicePrivatelinkAzureStateType string
const (
	ServicePrivatelinkAzureStateTypeActive   ServicePrivatelinkAzureStateType = "active"
	ServicePrivatelinkAzureStateTypeCreating ServicePrivatelinkAzureStateType = "creating"
	ServicePrivatelinkAzureStateTypeDeleting ServicePrivatelinkAzureStateType = "deleting"
)

type ServicePrivatelinkAzureUpdateIn 

type ServicePrivatelinkAzureUpdateIn struct {
	UserSubscriptionIds []string `json:"user_subscription_ids"` // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureUpdateIn ServicePrivatelinkAzureUpdateRequestBody

type ServicePrivatelinkAzureUpdateOut 

type ServicePrivatelinkAzureUpdateOut struct {
	AzureServiceAlias   *string                          `json:"azure_service_alias,omitempty"` // Azure Privatelink service alias
	AzureServiceId      *string                          `json:"azure_service_id,omitempty"`    // Azure Privatelink service ID
	State               ServicePrivatelinkAzureStateType `json:"state"`                         // Privatelink resource state
	UserSubscriptionIds []string                         `json:"user_subscription_ids"`         // IDs of Azure subscriptions allowed to connect to the service
}

ServicePrivatelinkAzureUpdateOut ServicePrivatelinkAzureUpdateResponse

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.