akamai.AppSecApiConstraintsProtection

Scopes: Security policy

Enables or disables API constraints protection. These constraints specify the action to be taken when designated API endpoints are invoked.

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

Output Options

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

  • output_text. Tabular report showing the current protection settings.

Example Usage

Basic usage

using System.Collections.Generic;
using Pulumi;
using Akamai = Pulumi.Akamai;

return await Deployment.RunAsync(() => 
{
    var configuration = Akamai.GetAppSecConfiguration.Invoke(new()
    {
        Name = "Documentation",
    });

    var protection = new Akamai.AppSecApiConstraintsProtection("protection", new()
    {
        ConfigId = configuration.Apply(getAppSecConfigurationResult => getAppSecConfigurationResult.ConfigId),
        SecurityPolicyId = "gms1_134637",
        Enabled = true,
    });

});
package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &akamai.LookupAppSecConfigurationArgs{
			Name: pulumi.StringRef("Documentation"),
		}, nil)
		if err != nil {
			return err
		}
		_, err = akamai.NewAppSecApiConstraintsProtection(ctx, "protection", &akamai.AppSecApiConstraintsProtectionArgs{
			ConfigId:         *pulumi.Int(configuration.ConfigId),
			SecurityPolicyId: pulumi.String("gms1_134637"),
			Enabled:          pulumi.Bool(true),
		})
		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.GetAppSecConfigurationArgs;
import com.pulumi.akamai.AppSecApiConstraintsProtection;
import com.pulumi.akamai.AppSecApiConstraintsProtectionArgs;
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 configuration = AkamaiFunctions.getAppSecConfiguration(GetAppSecConfigurationArgs.builder()
            .name("Documentation")
            .build());

        var protection = new AppSecApiConstraintsProtection("protection", AppSecApiConstraintsProtectionArgs.builder()        
            .configId(configuration.applyValue(getAppSecConfigurationResult -> getAppSecConfigurationResult.configId()))
            .securityPolicyId("gms1_134637")
            .enabled(true)
            .build());

    }
}
import pulumi
import pulumi_akamai as akamai

configuration = akamai.get_app_sec_configuration(name="Documentation")
protection = akamai.AppSecApiConstraintsProtection("protection",
    config_id=configuration.config_id,
    security_policy_id="gms1_134637",
    enabled=True)
import * as pulumi from "@pulumi/pulumi";
import * as akamai from "@pulumi/akamai";

const configuration = akamai.getAppSecConfiguration({
    name: "Documentation",
});
const protection = new akamai.AppSecApiConstraintsProtection("protection", {
    configId: configuration.then(configuration => configuration.configId),
    securityPolicyId: "gms1_134637",
    enabled: true,
});
resources:
  protection:
    type: akamai:AppSecApiConstraintsProtection
    properties:
      configId: ${configuration.configId}
      securityPolicyId: gms1_134637
      enabled: true
variables:
  configuration:
    fn::invoke:
      Function: akamai:getAppSecConfiguration
      Arguments:
        name: Documentation

Create AppSecApiConstraintsProtection Resource

new AppSecApiConstraintsProtection(name: string, args: AppSecApiConstraintsProtectionArgs, opts?: CustomResourceOptions);
@overload
def AppSecApiConstraintsProtection(resource_name: str,
                                   opts: Optional[ResourceOptions] = None,
                                   config_id: Optional[int] = None,
                                   enabled: Optional[bool] = None,
                                   security_policy_id: Optional[str] = None)
@overload
def AppSecApiConstraintsProtection(resource_name: str,
                                   args: AppSecApiConstraintsProtectionArgs,
                                   opts: Optional[ResourceOptions] = None)
func NewAppSecApiConstraintsProtection(ctx *Context, name string, args AppSecApiConstraintsProtectionArgs, opts ...ResourceOption) (*AppSecApiConstraintsProtection, error)
public AppSecApiConstraintsProtection(string name, AppSecApiConstraintsProtectionArgs args, CustomResourceOptions? opts = null)
public AppSecApiConstraintsProtection(String name, AppSecApiConstraintsProtectionArgs args)
public AppSecApiConstraintsProtection(String name, AppSecApiConstraintsProtectionArgs args, CustomResourceOptions options)
type: akamai:AppSecApiConstraintsProtection
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string
The unique name of the resource.
args AppSecApiConstraintsProtectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
resource_name str
The unique name of the resource.
args AppSecApiConstraintsProtectionArgs
The arguments to resource properties.
opts ResourceOptions
Bag of options to control resource's behavior.
ctx Context
Context object for the current deployment.
name string
The unique name of the resource.
args AppSecApiConstraintsProtectionArgs
The arguments to resource properties.
opts ResourceOption
Bag of options to control resource's behavior.
name string
The unique name of the resource.
args AppSecApiConstraintsProtectionArgs
The arguments to resource properties.
opts CustomResourceOptions
Bag of options to control resource's behavior.
name String
The unique name of the resource.
args AppSecApiConstraintsProtectionArgs
The arguments to resource properties.
options CustomResourceOptions
Bag of options to control resource's behavior.

AppSecApiConstraintsProtection Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The AppSecApiConstraintsProtection resource accepts the following input properties:

ConfigId int

Unique identifier of the security configuration

Enabled bool

Whether to enable API constraints protection

SecurityPolicyId string

Unique identifier of the security policy

ConfigId int

Unique identifier of the security configuration

Enabled bool

Whether to enable API constraints protection

SecurityPolicyId string

Unique identifier of the security policy

configId Integer

Unique identifier of the security configuration

enabled Boolean

Whether to enable API constraints protection

securityPolicyId String

Unique identifier of the security policy

configId number

Unique identifier of the security configuration

enabled boolean

Whether to enable API constraints protection

securityPolicyId string

Unique identifier of the security policy

config_id int

Unique identifier of the security configuration

enabled bool

Whether to enable API constraints protection

security_policy_id str

Unique identifier of the security policy

configId Number

Unique identifier of the security configuration

enabled Boolean

Whether to enable API constraints protection

securityPolicyId String

Unique identifier of the security policy

Outputs

All input properties are implicitly available as output properties. Additionally, the AppSecApiConstraintsProtection resource produces the following output properties:

Id string

The provider-assigned unique ID for this managed resource.

OutputText string

Text representation

Id string

The provider-assigned unique ID for this managed resource.

OutputText string

Text representation

id String

The provider-assigned unique ID for this managed resource.

outputText String

Text representation

id string

The provider-assigned unique ID for this managed resource.

outputText string

Text representation

id str

The provider-assigned unique ID for this managed resource.

output_text str

Text representation

id String

The provider-assigned unique ID for this managed resource.

outputText String

Text representation

Look up Existing AppSecApiConstraintsProtection Resource

Get an existing AppSecApiConstraintsProtection resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: AppSecApiConstraintsProtectionState, opts?: CustomResourceOptions): AppSecApiConstraintsProtection
@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        config_id: Optional[int] = None,
        enabled: Optional[bool] = None,
        output_text: Optional[str] = None,
        security_policy_id: Optional[str] = None) -> AppSecApiConstraintsProtection
func GetAppSecApiConstraintsProtection(ctx *Context, name string, id IDInput, state *AppSecApiConstraintsProtectionState, opts ...ResourceOption) (*AppSecApiConstraintsProtection, error)
public static AppSecApiConstraintsProtection Get(string name, Input<string> id, AppSecApiConstraintsProtectionState? state, CustomResourceOptions? opts = null)
public static AppSecApiConstraintsProtection get(String name, Output<String> id, AppSecApiConstraintsProtectionState state, CustomResourceOptions options)
Resource lookup is not supported in YAML
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
resource_name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
name
The unique name of the resulting resource.
id
The unique provider ID of the resource to lookup.
state
Any extra arguments used during the lookup.
opts
A bag of options that control this resource's behavior.
The following state arguments are supported:
ConfigId int

Unique identifier of the security configuration

Enabled bool

Whether to enable API constraints protection

OutputText string

Text representation

SecurityPolicyId string

Unique identifier of the security policy

ConfigId int

Unique identifier of the security configuration

Enabled bool

Whether to enable API constraints protection

OutputText string

Text representation

SecurityPolicyId string

Unique identifier of the security policy

configId Integer

Unique identifier of the security configuration

enabled Boolean

Whether to enable API constraints protection

outputText String

Text representation

securityPolicyId String

Unique identifier of the security policy

configId number

Unique identifier of the security configuration

enabled boolean

Whether to enable API constraints protection

outputText string

Text representation

securityPolicyId string

Unique identifier of the security policy

config_id int

Unique identifier of the security configuration

enabled bool

Whether to enable API constraints protection

output_text str

Text representation

security_policy_id str

Unique identifier of the security policy

configId Number

Unique identifier of the security configuration

enabled Boolean

Whether to enable API constraints protection

outputText String

Text representation

securityPolicyId String

Unique identifier of the security policy

Package Details

Repository
Akamai pulumi/pulumi-akamai
License
Apache-2.0
Notes

This Pulumi package is based on the akamai Terraform Provider.