pulumi-alicloud-kotlin/com.pulumi.alicloud.apigateway.kotlin/ApigatewayFunctions/getService

getService

suspend fun getService(argument: GetServicePlainArgs): GetServiceResult

Using this data source can enable API gateway service automatically. If the service has been enabled, it will return Opened. For information about API Gateway and how to use it, see What is API Gateway.

NOTE: Available in v1.96.0+

Example Usage

package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.alicloud.apigateway.ApigatewayFunctions;
import com.pulumi.alicloud.apigateway.inputs.GetServiceArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }
    public static void stack(Context ctx) {
        final var open = ApigatewayFunctions.getService(GetServiceArgs.builder()
            .enable("On")
            .build());
    }
}
Content copied to clipboard

Return

A collection of values returned by getService.

Parameters

argument

A collection of arguments for invoking getService.

suspend fun getService(enable: String? = null): GetServiceResult

Return

A collection of values returned by getService.

See also

Parameters

enable

Setting the value to On to enable the service. If has been enabled, return the result. Valid values: "On" or "Off". Default to "Off".

NOTE: Setting enable = "On" to open the API gateway service that means you have read and agreed the API Gateway Terms of Service. The service can not closed once it is opened.

suspend fun getService(argument: suspend GetServicePlainArgsBuilder.() -> Unit): GetServiceResult

Return

A collection of values returned by getService.

See also

Parameters

argument

Builder for com.pulumi.alicloud.apigateway.kotlin.inputs.GetServicePlainArgs.