Akamai

v3.0.0 published on Monday, Jul 25, 2022 by Pulumi

getAppSecApiEndpoints

Scopes: Security configuration; security policy

Returns information about the API endpoints associated with a security policy or configuration. The returned information is described in the Endpoint members section of the Application Security API documentation.

Related API Endpoint: /appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/api-endpoints

Output Options

The following options can be used to determine the information returned, and how that returned information is formatted:

  • id_list. List of API endpoint IDs.
  • json. JSON-formatted list of information about the API endpoints.
  • output_text. Tabular report showing the ID and name of the API endpoints.

Example Usage

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var apiEndpoints = Output.Create(Akamai.GetAppSecApiEndpoints.InvokeAsync(new Akamai.GetAppSecApiEndpointsArgs
        {
            ApiName = "Contracts",
            ConfigId = 58843,
        }));
    }

}
package main

import (
	"github.com/pulumi/pulumi-akamai/sdk/v3/go/akamai"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := akamai.GetAppSecApiEndpoints(ctx, &GetAppSecApiEndpointsArgs{
			ApiName:  pulumi.StringRef("Contracts"),
			ConfigId: 58843,
		}, nil)
		if err != nil {
			return err
		}
		return nil
	})
}
package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.akamai.AkamaiFunctions;
import com.pulumi.akamai.inputs.GetAppSecApiEndpointsArgs;
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 apiEndpoints = AkamaiFunctions.getAppSecApiEndpoints(GetAppSecApiEndpointsArgs.builder()
            .apiName("Contracts")
            .configId(58843)
            .build());

    }
}
import pulumi
import pulumi_akamai as akamai

api_endpoints = akamai.get_app_sec_api_endpoints(api_name="Contracts",
    config_id=58843)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const apiEndpoints = pulumi.output(akamai.getAppSecApiEndpoints({
    apiName: "Contracts",
    configId: 58843,
}));
variables:
  apiEndpoints:
    Fn::Invoke:
      Function: akamai:getAppSecApiEndpoints
      Arguments:
        apiName: Contracts
        configId: 58843

Using getAppSecApiEndpoints

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getAppSecApiEndpoints(args: GetAppSecApiEndpointsArgs, opts?: InvokeOptions): Promise<GetAppSecApiEndpointsResult>
function getAppSecApiEndpointsOutput(args: GetAppSecApiEndpointsOutputArgs, opts?: InvokeOptions): Output<GetAppSecApiEndpointsResult>
def get_app_sec_api_endpoints(api_name: Optional[str] = None,
                              config_id: Optional[int] = None,
                              security_policy_id: Optional[str] = None,
                              opts: Optional[InvokeOptions] = None) -> GetAppSecApiEndpointsResult
def get_app_sec_api_endpoints_output(api_name: Optional[pulumi.Input[str]] = None,
                              config_id: Optional[pulumi.Input[int]] = None,
                              security_policy_id: Optional[pulumi.Input[str]] = None,
                              opts: Optional[InvokeOptions] = None) -> Output[GetAppSecApiEndpointsResult]
func GetAppSecApiEndpoints(ctx *Context, args *GetAppSecApiEndpointsArgs, opts ...InvokeOption) (*GetAppSecApiEndpointsResult, error)
func GetAppSecApiEndpointsOutput(ctx *Context, args *GetAppSecApiEndpointsOutputArgs, opts ...InvokeOption) GetAppSecApiEndpointsResultOutput

> Note: This function is named GetAppSecApiEndpoints in the Go SDK.

public static class GetAppSecApiEndpoints 
{
    public static Task<GetAppSecApiEndpointsResult> InvokeAsync(GetAppSecApiEndpointsArgs args, InvokeOptions? opts = null)
    public static Output<GetAppSecApiEndpointsResult> Invoke(GetAppSecApiEndpointsInvokeArgs args, InvokeOptions? opts = null)
}
public static CompletableFuture<GetAppSecApiEndpointsResult> getAppSecApiEndpoints(GetAppSecApiEndpointsArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet
Fn::Invoke:
  Function: akamai:index/getAppSecApiEndpoints:getAppSecApiEndpoints
  Arguments:
    # Arguments dictionary

The following arguments are supported:

ConfigId int

. Unique identifier of the security configuration associated with the API endpoints.

ApiName string

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

SecurityPolicyId string

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

ConfigId int

. Unique identifier of the security configuration associated with the API endpoints.

ApiName string

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

SecurityPolicyId string

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

configId Integer

. Unique identifier of the security configuration associated with the API endpoints.

apiName String

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

securityPolicyId String

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

configId number

. Unique identifier of the security configuration associated with the API endpoints.

apiName string

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

securityPolicyId string

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

config_id int

. Unique identifier of the security configuration associated with the API endpoints.

api_name str

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

security_policy_id str

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

configId Number

. Unique identifier of the security configuration associated with the API endpoints.

apiName String

. Name of the API endpoint you want to return information for. If not included, information is returned for all your API endpoints.

securityPolicyId String

. Unique identifier of the security policy associated with the API endpoints. If not included, information is returned for all your security policies.

getAppSecApiEndpoints Result

The following output properties are available:

ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

IdLists List<int>
Json string
OutputText string
ApiName string
SecurityPolicyId string
ConfigId int
Id string

The provider-assigned unique ID for this managed resource.

IdLists []int
Json string
OutputText string
ApiName string
SecurityPolicyId string
configId Integer
id String

The provider-assigned unique ID for this managed resource.

idLists List<Integer>
json String
outputText String
apiName String
securityPolicyId String
configId number
id string

The provider-assigned unique ID for this managed resource.

idLists number[]
json string
outputText string
apiName string
securityPolicyId string
config_id int
id str

The provider-assigned unique ID for this managed resource.

id_lists Sequence[int]
json str
output_text str
api_name str
security_policy_id str
configId Number
id String

The provider-assigned unique ID for this managed resource.

idLists List<Number>
json String
outputText String
apiName String
securityPolicyId String

Package Details

Repository
https://github.com/pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.