apig

package
v1.64.1 Latest Latest
Warning

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

 Go to latest Published: May 6, 2024 License: MPL-2.0 Imports: 37 Imported by: 2

Documentation

Index

Constants

View Source 
const (
	ApiTypePublic  ApiType = "Public"
	ApiTypePrivate ApiType = "Private"

	RequestMethodGet     RequestMethod = "GET"
	RequestMethodPost    RequestMethod = "POST"
	RequestMethodPut     RequestMethod = "PUT"
	RequestMethodDelete  RequestMethod = "DELETE"
	RequestMethodHead    RequestMethod = "HEAD"
	RequestMethodPatch   RequestMethod = "PATCH"
	RequestMethodOptions RequestMethod = "OPTIONS"
	RequestMethodAny     RequestMethod = "ANY"

	ApiAuthTypeNone       ApiAuthType = "NONE"
	ApiAuthTypeApp        ApiAuthType = "APP"
	ApiAuthTypeIam        ApiAuthType = "IAM"
	ApiAuthTypeAuthorizer ApiAuthType = "AUTHORIZER"

	ParamLocationPath   ParamLocation = "PATH"
	ParamLocationHeader ParamLocation = "HEADER"
	ParamLocationQuery  ParamLocation = "QUERY"

	ParamTypeString ParamType = "STRING"
	ParamTypeNumber ParamType = "NUMBER"

	MatchModePrefix MatchMode = "Prefix"
	MatchModeExact  MatchMode = "Exact"

	InvacationTypeAsync InvacationType = "async"
	InvacationTypeSync  InvacationType = "sync"

	EffectiveModeAll EffectiveMode = "ALL"
	EffectiveModeAny EffectiveMode = "ANY"

	ConditionSourceParam              ConditionSource = "param"
	ConditionSourceSource             ConditionSource = "source"
	ConditionSourceSystem             ConditionSource = "system"
	ConditionSourceCookie             ConditionSource = "cookie"
	ConditionSourceFrontendAuthorizer ConditionSource = "frontend_authorizer"

	ConditionTypeEqual      ConditionType = "Equal"
	ConditionTypeEnumerated ConditionType = "Enumerated"
	ConditionTypeMatching   ConditionType = "Matching"

	ParameterTypeRequest  ParameterType = "REQUEST"
	ParameterTypeConstant ParameterType = "CONSTANT"
	ParameterTypeSystem   ParameterType = "SYSTEM"

	SystemParamTypeFrontend SystemParamType = "frontend"
	SystemParamTypeBackend  SystemParamType = "backend"
	SystemParamTypeInternal SystemParamType = "internal"

	BackendTypeHttp     BackendType = "HTTP"
	BackendTypeFunction BackendType = "FUNCTION"
	BackendTypeMock     BackendType = "MOCK"

	AppCodeAuthTypeDisable AppCodeAuthType = "DISABLE"
	AppCodeAuthTypeEnable  AppCodeAuthType = "HEADER"

	ProtocolTypeTCP   ProtocolType = "TCP"
	ProtocolTypeHTTP  ProtocolType = "HTTP"
	ProtocolTypeHTTPS ProtocolType = "HTTPS"
	ProtocolTypeBoth  ProtocolType = "BOTH"
)
View Source 
const (
	PeriodUnitSecond PeriodUnit = "SECOND"
	PeriodUnitMinute PeriodUnit = "MINUTE"
	PeriodUnitHour   PeriodUnit = "HOUR"
	PeriodUnitDay    PeriodUnit = "DAY"

	PolicyTypeExclusive   PolicyType = "API-based"
	PolicyTypeShared      PolicyType = "API-shared"
	PolicyTypeUser        PolicyType = "USER"
	PolicyTypeApplication PolicyType = "APP"
)

Variables

This section is empty.

Functions

func DataSourceEnvironments added in v1.38.0 

func DataSourceEnvironments() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/envs

func DataSourceGroups added in v1.57.0 

func DataSourceGroups() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups

func GetApiIdByName added in v1.45.0 

func GetApiIdByName(client *golangsdk.ServiceClient, instanceId, name string) (string, error)

GetApigAPIIdByName is a method to get a specifies API ID from a APIG instance by name.

func GetEnvironmentFormServer 

func GetEnvironmentFormServer(client *golangsdk.ServiceClient, instanceId,
	envId string) (*environments.Environment, error)

GetEnvironmentFormServer is a method to get dedicated environment details form server using IDs.

func GetVersionHistories added in v1.30.0 

func GetVersionHistories(c *golangsdk.ServiceClient, instanceId, envId, apiId string) ([]apis.ApiVersionInfo, error)

GetVersionHistories is a function that obtains version histories by APIG IDs.

func InstanceStateRefreshFunc added in v1.43.0 

func InstanceStateRefreshFunc(client *golangsdk.ServiceClient, instanceId string, targets []string) resource.StateRefreshFunc

func ResourceAclPolicy added in v1.47.0 

func ResourceAclPolicy() *schema.Resource

ResourceAclPolicy is a provider resource of the APIG ACL policy. @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/acls/{acl_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/acls

func ResourceAclPolicyAssociate added in v1.48.0 

func ResourceAclPolicyAssociate() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings/binded-apis @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/acl-bindings

func ResourceApiPublishmentCreate added in v1.44.2 

func ResourceApiPublishmentCreate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics

ResourceApiPublishmentCreate is a function that uses terraform configuration to publish new versions or switch historical versions.

func ResourceApiPublishmentDelete added in v1.44.2 

func ResourceApiPublishmentDelete(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics

func ResourceApiPublishmentRead added in v1.44.2 

func ResourceApiPublishmentRead(_ context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics

ResourceApiPublishmentRead is a method to obtain informations of API publishment and save to the local storage.

func ResourceApiPublishmentUpdate added in v1.44.2 

func ResourceApiPublishmentUpdate(ctx context.Context, d *schema.ResourceData, meta interface{}) diag.Diagnostics

func ResourceApigAPIV2 added in v1.27.1 

func ResourceApigAPIV2() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apis @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/apis

func ResourceApigApiPublishment added in v1.30.0 

func ResourceApigApiPublishment() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apis/{api_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/apis/action @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/apis/publish/{api_id}

func ResourceApigApplicationV2 

func ResourceApigApplicationV2() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/apps @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/secret/{app_id}

func ResourceApigCustomAuthorizerV2 added in v1.27.1 

func ResourceApigCustomAuthorizerV2() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/authorizers/{authorizer_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/authorizers @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/authorizers

func ResourceApigEnvironmentV2 

func ResourceApigEnvironmentV2() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/envs/{env_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/envs @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/envs

func ResourceApigGroupV2 

func ResourceApigGroupV2() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/env-variables @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/env-variables @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/env-variables/{env_variable_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/api-groups/{group_id}/domains/{domain_id}

func ResourceApigInstanceV2 

func ResourceApigInstanceV2() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/eip @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/eip @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/nat-eip @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/nat-eip @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/nat-eip @API APIG GET /v2/{project_id}/apigw/instances/{instance_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id} @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/instance-tags/action @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/instance-tags @API APIG POST /v2/{project_id}/apigw/instances @API EIP GET /v1/{project_id}/publicips @API APIG POST /v2/{project_id}/apigw/instances{instance_id}/ingress-eip @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/ingress-eip

func ResourceApigResponseV2 

func ResourceApigResponseV2() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instanceId}/api-groups/{group_id}/gateway-responses/{response_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instanceId}/api-groups/{group_id}/gateway-responses/{response_id} @API APIG DELETE /v2/{project_id}/apigw/instances/{instanceId}/api-groups/{group_id}/gateway-responses/{response_id} @API APIG GET /v2/{project_id}/apigw/instances/{instanceId}/api-groups/{group_id}/gateway-responses @API APIG POST /v2/{project_id}/apigw/instances/{instanceId}/api-groups/{group_id}/gateway-responses

func ResourceApigThrottlingPolicyV2 added in v1.27.1 

func ResourceApigThrottlingPolicyV2() *schema.Resource

ResourceApigThrottlingPolicyV2 is a provider resource of the APIG throttling policy. @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/throttles @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/throttles @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_Id} @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttles/{throttle_id}/throttle-specials/{strategy_Id}

func ResourceAppAuth added in v1.55.0 

func ResourceAppAuth() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/app-auths/{app_auth_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/app-auths @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/binded-apis @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/app-auths/unbinded-apis

func ResourceAppcode added in v1.55.0 

func ResourceAppcode() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes/{app_code_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/apps/{app_id}/app-codes

func ResourceCertificate added in v1.53.0 

func ResourceCertificate() *schema.Resource

@API APIG POST /v2/{project_id}/apigw/certificates @API APIG DELETE /v2/{project_id}/apigw/certificates/{certificate_id} @API APIG GET /v2/{project_id}/apigw/certificates/{certificate_id} @API APIG PUT /v2/{project_id}/apigw/certificates/{certificate_id}

func ResourceChannel added in v1.48.0 

func ResourceChannel() *schema.Resource

@API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels/{vpc_channel_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/vpc-channels

func ResourceEndpointWhiteList added in v1.58.0 

func ResourceEndpointWhiteList() *schema.Resource

@API APIG POST /v2/{project_id}/apigw/instances/{instanceId}/vpc-endpoint/permissions/batch-add @API APIG POST /v2/{project_id}/apigw/instances/{instanceId}/vpc-endpoint/permissions/batch-delete @API APIG GET /v2/{project_id}/apigw/instances/{instanceId}/vpc-endpoint/permissions

func ResourceInstanceRoutes added in v1.47.0 

func ResourceInstanceRoutes() *schema.Resource

@API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/features @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/features

func ResourcePlugin added in v1.49.0 

func ResourcePlugin() *schema.Resource

ResourcePlugin defines the provider resource of the APIG plugin. @API APIG DELETE /v2/{project_id}/apigw/instances/{instanceId}/plugins/{plugin_id} @API APIG GET /v2/{project_id}/apigw/instances/{instanceId}/plugins/{plugin_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instanceId}/plugins/{plugin_id} @API APIG POST /v2/{project_id}/apigw/instances/{instanceId}/plugins

func ResourcePluginAssociate added in v1.49.0 

func ResourcePluginAssociate() *schema.Resource

ResourcePluginAssociate defines the provider resource of the APIG plugin binding. @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/detach @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attached-apis @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/plugins/{plugin_id}/attach

func ResourceSignature added in v1.48.0 

func ResourceSignature() *schema.Resource

ResourceSignature is a provider resource of the APIG signature. @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id} @API APIG PUT /v2/{project_id}/apigw/instances/{instance_id}/signs/{sign_id} @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/signs @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/signs

func ResourceSignatureAssociate added in v1.48.0 

func ResourceSignatureAssociate() *schema.Resource

ResourceSignatureAssociate is a provider resource of the API signature. @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings @API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/binded-apis @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/sign-bindings/{sign_bindings_id}

func ResourceThrottlingPolicyAssociate added in v1.38.0 

func ResourceThrottlingPolicyAssociate() *schema.Resource

@API APIG GET /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/binded-apis @API APIG DELETE /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings/{throttle_binding_id} @API APIG POST /v2/{project_id}/apigw/instances/{instance_id}/throttle-bindings

Types

type ApiAuthType added in v1.45.0 

type ApiAuthType string

type ApiType added in v1.45.0 

type ApiType string

type AppCodeAuthType added in v1.45.0 

type AppCodeAuthType string

type AuthType added in v1.45.0 

type AuthType string
const (
	AuthTypeFrontend AuthType = "FRONTEND"
	AuthTypeBackend  AuthType = "BACKEND"
)

type BackendType added in v1.45.0 

type BackendType string

type ConditionSource added in v1.45.0 

type ConditionSource string

type ConditionType added in v1.45.0 

type ConditionType string

type Edition added in v1.43.0 

type Edition string // The edition of the dedicated instance.

const (
	// IPv4 Editions
	EditionBasic        Edition = "BASIC"        // Basic Edition instance.
	EditionProfessional Edition = "PROFESSIONAL" // Professional Edition instance.
	EditionEnterprise   Edition = "ENTERPRISE"   // Enterprise Edition instance.
	EditionPlatinum     Edition = "PLATINUM"     // Platinum Edition instance.
	// IPv6 Editions
	Ipv6EditionBasic        Edition = "BASIC_IPv6"        // IPv6 instance of the Basic Edition.
	Ipv6EditionProfessional Edition = "PROFESSIONAL_IPv6" // IPv6 instance of the Professional Edition.
	Ipv6EditionEnterprise   Edition = "ENTERPRISE_IPv6"   // IPv6 instance of the Enterprise Edition.
	Ipv6EditionPlatinum     Edition = "PLATINUM_IPv6"     // IPv6 instance of the Platinum Edition.
)

type EffectiveMode added in v1.45.0 

type EffectiveMode string

type InvacationType added in v1.45.0 

type InvacationType string

type MatchMode added in v1.45.0 

type MatchMode string

type ParamLocation added in v1.45.0 

type ParamLocation string

type ParamType added in v1.45.0 

type ParamType string

type ParameterType added in v1.45.0 

type ParameterType string

type PeriodUnit added in v1.44.2 

type PeriodUnit string

type PolicyType added in v1.44.2 

type PolicyType string

type ProtocolType added in v1.44.0 

type ProtocolType string

type ProviderType added in v1.43.0 

type ProviderType string // The type of the loadbalancer provider.

type RequestMethod added in v1.45.0 

type RequestMethod string

type SecretAction added in v1.44.1 

type SecretAction string
const (
	SecretActionReset SecretAction = "RESET"
)

type SystemParamType added in v1.45.0 

type SystemParamType string

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.