← All packages

Akamai

Pulumi Official
Package maintained by Pulumi
v2.9.0 published on Wednesday, Apr 6, 2022 by Pulumi
Source code
  1. Pulumi Registry
  2. Akamai
  3. Akamai
  4. AppSecApiConstraintsProtection

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

using Pulumi;
using Akamai = Pulumi.Akamai;

class MyStack : Stack
{
    public MyStack()
    {
        var configuration = Output.Create(Akamai.GetAppSecConfiguration.InvokeAsync(new Akamai.GetAppSecConfigurationArgs
        {
            Name = "Documentation",
        }));
        var protection = new Akamai.AppSecApiConstraintsProtection("protection", new Akamai.AppSecApiConstraintsProtectionArgs
        {
            ConfigId = configuration.Apply(configuration => configuration.ConfigId),
            SecurityPolicyId = "gms1_134637",
            Enabled = true,
        });
    }

}

package main

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

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		configuration, err := akamai.LookupAppSecConfiguration(ctx, &GetAppSecConfigurationArgs{
			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
	})
}

Coming soon!

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,
});

Coming soon!

Create a 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 Integer
enabled Boolean
securityPolicyId String
configId number
enabled boolean
securityPolicyId string
configId Number
enabled Boolean
securityPolicyId String

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 Export representation

Id string

The provider-assigned unique ID for this managed resource.

OutputText string

Text Export representation

id String

The provider-assigned unique ID for this managed resource.

outputText String

Text Export representation

id string

The provider-assigned unique ID for this managed resource.

outputText string

Text Export representation

id str

The provider-assigned unique ID for this managed resource.

output_text str

Text Export representation

id String

The provider-assigned unique ID for this managed resource.

outputText String

Text Export representation

Look up an 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
Enabled bool
OutputText string

Text Export representation

SecurityPolicyId string
ConfigId int
Enabled bool
OutputText string

Text Export representation

SecurityPolicyId string
configId Integer
enabled Boolean
outputText String

Text Export representation

securityPolicyId String
configId number
enabled boolean
outputText string

Text Export representation

securityPolicyId string
config_id int
enabled bool
output_text str

Text Export representation

security_policy_id str
configId Number
enabled Boolean
outputText String

Text Export representation

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.