apigateway library

Classes

Api
Creates a new Api in a given project and location. Auto-naming is currently not supported for this resource.
ApiApigatewayV1beta
Creates a new Api in a given project and location. Auto-naming is currently not supported for this resource.
ApiApigatewayV1betaArgs
The set of arguments for Api. The set of arguments for Api.
ApiArgs
The set of arguments for Api. The set of arguments for Api.
ApiConfigIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiConfigIamBindingApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiConfigIamBindingApigatewayV1betaArgs
The set of arguments for ApiConfigIamBinding. The set of arguments for ApiConfigIamBinding.
ApiConfigIamBindingArgs
The set of arguments for ApiConfigIamBinding. The set of arguments for ApiConfigIamBinding.
ApiConfigIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiConfigIamMemberApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiConfigIamMemberApigatewayV1betaArgs
The set of arguments for ApiConfigIamMember. The set of arguments for ApiConfigIamMember.
ApiConfigIamMemberArgs
The set of arguments for ApiConfigIamMember. The set of arguments for ApiConfigIamMember.
ApiConfigIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ApiConfigIamPolicyApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ApiConfigIamPolicyApigatewayV1betaArgs
The set of arguments for ApiConfigIamPolicy. The set of arguments for ApiConfigIamPolicy.
ApiConfigIamPolicyArgs
The set of arguments for ApiConfigIamPolicy. The set of arguments for ApiConfigIamPolicy.
ApigatewayApiConfigFile
A lightweight description of a file.
ApigatewayApiConfigFileApigatewayV1beta
A lightweight description of a file.
ApigatewayApiConfigFileResponse
A lightweight description of a file.
ApigatewayApiConfigFileResponseApigatewayV1beta
A lightweight description of a file.
ApigatewayApiConfigGrpcServiceDefinition
A gRPC service definition.
ApigatewayApiConfigGrpcServiceDefinitionApigatewayV1beta
A gRPC service definition.
ApigatewayApiConfigGrpcServiceDefinitionResponse
A gRPC service definition.
ApigatewayApiConfigGrpcServiceDefinitionResponseApigatewayV1beta
A gRPC service definition.
ApigatewayApiConfigOpenApiDocument
An OpenAPI Specification Document describing an API.
ApigatewayApiConfigOpenApiDocumentApigatewayV1beta
An OpenAPI Specification Document describing an API.
ApigatewayApiConfigOpenApiDocumentResponse
An OpenAPI Specification Document describing an API.
ApigatewayApiConfigOpenApiDocumentResponseApigatewayV1beta
An OpenAPI Specification Document describing an API.
ApigatewayAuditConfig
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
ApigatewayAuditConfigApigatewayV1beta
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
ApigatewayAuditConfigResponse
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
ApigatewayAuditConfigResponseApigatewayV1beta
Specifies the audit configuration for a service. The configuration determines which permission types are logged, and what identities, if any, are exempted from logging. An AuditConfig must have one or more AuditLogConfigs. If there are AuditConfigs for both allServices and a specific service, the union of the two AuditConfigs is used for that service: the log_types specified in each AuditConfig are enabled, and the exempted_members in each AuditLogConfig are exempted. Example Policy with multiple AuditConfigs: { "audit_configs": [ { "service": "allServices", "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" }, { "log_type": "ADMIN_READ" } ] }, { "service": "sampleservice.googleapis.com", "audit_log_configs": [ { "log_type": "DATA_READ" }, { "log_type": "DATA_WRITE", "exempted_members": "user:aliya@example.com" } ] } ] } For sampleservice, this policy enables DATA_READ, DATA_WRITE and ADMIN_READ logging. It also exempts jose@example.com from DATA_READ logging, and aliya@example.com from DATA_WRITE logging.
ApigatewayAuditLogConfig
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
ApigatewayAuditLogConfigApigatewayV1beta
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
ApigatewayAuditLogConfigResponse
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
ApigatewayAuditLogConfigResponseApigatewayV1beta
Provides the configuration for logging a type of permissions. Example: { "audit_log_configs": [ { "log_type": "DATA_READ", "exempted_members": "user:jose@example.com" }, { "log_type": "DATA_WRITE" } ] } This enables 'DATA_READ' and 'DATA_WRITE' logging, while exempting jose@example.com from DATA_READ logging.
ApigatewayBackendConfig
Configuration for all backends.
ApigatewayBackendConfigResponse
Configuration for all backends.
ApigatewayBinding
Associates members, or principals, with a role.
ApigatewayBindingApigatewayV1beta
Associates members, or principals, with a role.
ApigatewayBindingResponse
Associates members, or principals, with a role.
ApigatewayBindingResponseApigatewayV1beta
Associates members, or principals, with a role.
ApigatewayExpr
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ApigatewayExprApigatewayV1beta
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ApigatewayExprResponse
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ApigatewayExprResponseApigatewayV1beta
Represents a textual expression in the Common Expression Language (CEL) syntax. CEL is a C-like expression language. The syntax and semantics of CEL are documented at https://github.com/google/cel-spec. Example (Comparison): title: "Summary size limit" description: "Determines if a summary is less than 100 chars" expression: "document.summary.size() < 100" Example (Equality): title: "Requestor is owner" description: "Determines if requestor is the document owner" expression: "document.owner == request.auth.claims.email" Example (Logic): title: "Public documents" description: "Determine whether the document should be publicly visible" expression: "document.type != 'private' && document.type != 'internal'" Example (Data Manipulation): title: "Notification string" description: "Create a notification string with a timestamp." expression: "'New message received at ' + string(document.create_time)" The exact variables and functions that may be referenced within an expression are determined by the service that evaluates it. See the service documentation for additional information.
ApigatewayGatewayConfig
Configuration settings for Gateways.
ApigatewayGatewayConfigResponse
Configuration settings for Gateways.
ApiIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiIamBindingApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiIamBindingApigatewayV1betaArgs
The set of arguments for ApiIamBinding. The set of arguments for ApiIamBinding.
ApiIamBindingArgs
The set of arguments for ApiIamBinding. The set of arguments for ApiIamBinding.
ApiIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiIamMemberApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
ApiIamMemberApigatewayV1betaArgs
The set of arguments for ApiIamMember. The set of arguments for ApiIamMember.
ApiIamMemberArgs
The set of arguments for ApiIamMember. The set of arguments for ApiIamMember.
ApiIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ApiIamPolicyApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
ApiIamPolicyApigatewayV1betaArgs
The set of arguments for ApiIamPolicy. The set of arguments for ApiIamPolicy.
ApiIamPolicyArgs
The set of arguments for ApiIamPolicy. The set of arguments for ApiIamPolicy.
Config
Creates a new ApiConfig in a given project and location. Auto-naming is currently not supported for this resource.
ConfigApigatewayV1beta
Creates a new ApiConfig in a given project and location. Auto-naming is currently not supported for this resource.
ConfigApigatewayV1betaArgs
The set of arguments for Config. The set of arguments for Config.
ConfigArgs
The set of arguments for Config. The set of arguments for Config.
Gateway
Creates a new Gateway in a given project and location. Auto-naming is currently not supported for this resource.
GatewayApigatewayV1beta
Creates a new Gateway in a given project and location. Auto-naming is currently not supported for this resource.
GatewayApigatewayV1betaArgs
The set of arguments for Gateway. The set of arguments for Gateway.
GatewayArgs
The set of arguments for Gateway. The set of arguments for Gateway.
GatewayIamBinding
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
GatewayIamBindingApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
GatewayIamBindingApigatewayV1betaArgs
The set of arguments for GatewayIamBinding. The set of arguments for GatewayIamBinding.
GatewayIamBindingArgs
The set of arguments for GatewayIamBinding. The set of arguments for GatewayIamBinding.
GatewayIamMember
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
GatewayIamMemberApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors.
GatewayIamMemberApigatewayV1betaArgs
The set of arguments for GatewayIamMember. The set of arguments for GatewayIamMember.
GatewayIamMemberArgs
The set of arguments for GatewayIamMember. The set of arguments for GatewayIamMember.
GatewayIamPolicy
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
GatewayIamPolicyApigatewayV1beta
Sets the access control policy on the specified resource. Replaces any existing policy. Can return NOT_FOUND, INVALID_ARGUMENT, and PERMISSION_DENIED errors. Note - this resource's API doesn't support deletion. When deleted, the resource will persist on Google Cloud even though it will be deleted from Pulumi state.
GatewayIamPolicyApigatewayV1betaArgs
The set of arguments for GatewayIamPolicy. The set of arguments for GatewayIamPolicy.
GatewayIamPolicyArgs
The set of arguments for GatewayIamPolicy. The set of arguments for GatewayIamPolicy.
GetApiApigatewayV1betaArgs
Arguments for getApi. Arguments for getApi.
GetApiApigatewayV1betaResult
Result data returned by getApi.
GetApiArgs
Arguments for getApi. Arguments for getApi.
GetApiConfigIamPolicyApigatewayV1betaArgs
Arguments for getApiConfigIamPolicy. Arguments for getApiConfigIamPolicy.
GetApiConfigIamPolicyApigatewayV1betaResult
Result data returned by getApiConfigIamPolicy.
GetApiConfigIamPolicyArgs
Arguments for getApiConfigIamPolicy. Arguments for getApiConfigIamPolicy.
GetApiConfigIamPolicyResult
Result data returned by getApiConfigIamPolicy.
GetApiIamPolicyApigatewayV1betaArgs
Arguments for getApiIamPolicy. Arguments for getApiIamPolicy.
GetApiIamPolicyApigatewayV1betaResult
Result data returned by getApiIamPolicy.
GetApiIamPolicyArgs
Arguments for getApiIamPolicy. Arguments for getApiIamPolicy.
GetApiIamPolicyResult
Result data returned by getApiIamPolicy.
GetApiResult
Result data returned by getApi.
GetConfigApigatewayV1betaArgs
Arguments for getConfig. Arguments for getConfig.
GetConfigApigatewayV1betaResult
Result data returned by getConfig.
GetConfigArgs
Arguments for getConfig. Arguments for getConfig.
GetConfigResult
Result data returned by getConfig.
GetGatewayApigatewayV1betaArgs
Arguments for getGateway. Arguments for getGateway.
GetGatewayApigatewayV1betaResult
Result data returned by getGateway.
GetGatewayArgs
Arguments for getGateway. Arguments for getGateway.
GetGatewayIamPolicyApigatewayV1betaArgs
Arguments for getGatewayIamPolicy. Arguments for getGatewayIamPolicy.
GetGatewayIamPolicyApigatewayV1betaResult
Result data returned by getGatewayIamPolicy.
GetGatewayIamPolicyArgs
Arguments for getGatewayIamPolicy. Arguments for getGatewayIamPolicy.
GetGatewayIamPolicyResult
Result data returned by getGatewayIamPolicy.
GetGatewayResult
Result data returned by getGateway.

Enums

ApigatewayAuditLogConfigLogType
The log type that this config enables.
ApigatewayAuditLogConfigLogTypeApigatewayV1beta
The log type that this config enables.

Functions

getApi(GetApiArgs args, {InvokeOptions? options}) → Future<GetApiResult>
Gets details of a single Api. args Arguments passed to this invoke. Arguments for getApi. options Invoke options controlling this call.
getApiApigatewayV1beta(GetApiApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetApiApigatewayV1betaResult>
Gets details of a single Api. args Arguments passed to this invoke. Arguments for getApi. options Invoke options controlling this call.
getApiConfigIamPolicy(GetApiConfigIamPolicyArgs args, {InvokeOptions? options}) → Future<GetApiConfigIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getApiConfigIamPolicy. options Invoke options controlling this call.
getApiConfigIamPolicyApigatewayV1beta(GetApiConfigIamPolicyApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetApiConfigIamPolicyApigatewayV1betaResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getApiConfigIamPolicy. options Invoke options controlling this call.
getApiIamPolicy(GetApiIamPolicyArgs args, {InvokeOptions? options}) → Future<GetApiIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getApiIamPolicy. options Invoke options controlling this call.
getApiIamPolicyApigatewayV1beta(GetApiIamPolicyApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetApiIamPolicyApigatewayV1betaResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getApiIamPolicy. options Invoke options controlling this call.
getConfig(GetConfigArgs args, {InvokeOptions? options}) → Future<GetConfigResult>
Gets details of a single ApiConfig. args Arguments passed to this invoke. Arguments for getConfig. options Invoke options controlling this call.
getConfigApigatewayV1beta(GetConfigApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetConfigApigatewayV1betaResult>
Gets details of a single ApiConfig. args Arguments passed to this invoke. Arguments for getConfig. options Invoke options controlling this call.
getGateway(GetGatewayArgs args, {InvokeOptions? options}) → Future<GetGatewayResult>
Gets details of a single Gateway. args Arguments passed to this invoke. Arguments for getGateway. options Invoke options controlling this call.
getGatewayApigatewayV1beta(GetGatewayApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetGatewayApigatewayV1betaResult>
Gets details of a single Gateway. args Arguments passed to this invoke. Arguments for getGateway. options Invoke options controlling this call.
getGatewayIamPolicy(GetGatewayIamPolicyArgs args, {InvokeOptions? options}) → Future<GetGatewayIamPolicyResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getGatewayIamPolicy. options Invoke options controlling this call.
getGatewayIamPolicyApigatewayV1beta(GetGatewayIamPolicyApigatewayV1betaArgs args, {InvokeOptions? options}) → Future<GetGatewayIamPolicyApigatewayV1betaResult>
Gets the access control policy for a resource. Returns an empty policy if the resource exists and does not have a policy set. args Arguments passed to this invoke. Arguments for getGatewayIamPolicy. options Invoke options controlling this call.