getAppSecCustomRules.go

// Code generated by the Pulumi Terraform Bridge (tfgen) Tool DO NOT EDIT.
// *** WARNING: Do not edit by hand unless you're certain you know what you are doing! ***

package akamai

import (
	"context"
	"reflect"

	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

// **Scopes**: Security configuration; custom rule
//
// Returns a list of the custom rules defined for a security configuration; you can also use this resource to return information for an individual custom rule. Custom rules are rules you have created yourself and are not part of the Kona Rule Set.
//
// **Related API Endpoint**:[/appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/custom-rules](https://techdocs.akamai.com/application-security/reference/get-custom-rules)
//
// ## Example Usage
//
// Basic usage:
//
// ```go
// 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 {
//			configuration, err := akamai.LookupAppSecConfiguration(ctx, &GetAppSecConfigurationArgs{
//				Name: pulumi.StringRef("Documentation"),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			customRules, err := akamai.GetAppSecCustomRules(ctx, &GetAppSecCustomRulesArgs{
//				ConfigId: configuration.ConfigId,
//			}, nil)
//			if err != nil {
//				return err
//			}
//			ctx.Export("customRulesOutputText", customRules.OutputText)
//			ctx.Export("customRulesJson", customRules.Json)
//			ctx.Export("customRulesConfigId", customRules.ConfigId)
//			specificCustomRule, err := akamai.GetAppSecCustomRules(ctx, &GetAppSecCustomRulesArgs{
//				ConfigId:     configuration.ConfigId,
//				CustomRuleId: pulumi.IntRef(60029316),
//			}, nil)
//			if err != nil {
//				return err
//			}
//			ctx.Export("specificCustomRuleJson", specificCustomRule.Json)
//			return nil
//		})
//	}
//
// ```
// ## Output Options
//
// The following options can be used to determine the information returned, and how that returned information is formatted:
//
// - `outputText`. Tabular report showing the ID and name of the custom rule information.
// - `json`. JSON-formatted report of the custom rule information.
func GetAppSecCustomRules(ctx *pulumi.Context, args *GetAppSecCustomRulesArgs, opts ...pulumi.InvokeOption) (*GetAppSecCustomRulesResult, error) {
	var rv GetAppSecCustomRulesResult
	err := ctx.Invoke("akamai:index/getAppSecCustomRules:getAppSecCustomRules", args, &rv, opts...)
	if err != nil {
		return nil, err
	}
	return &rv, nil
}

// A collection of arguments for invoking getAppSecCustomRules.
type GetAppSecCustomRulesArgs struct {
	// . Unique identifier of the security configuration associated with the custom rules.
	ConfigId int `pulumi:"configId"`
	// . Unique identifier of the custom rule you want to return information for. If not included, information is returned for all your custom rules.
	CustomRuleId *int `pulumi:"customRuleId"`
}

// A collection of values returned by getAppSecCustomRules.
type GetAppSecCustomRulesResult struct {
	ConfigId     int  `pulumi:"configId"`
	CustomRuleId *int `pulumi:"customRuleId"`
	// The provider-assigned unique ID for this managed resource.
	Id         string `pulumi:"id"`
	Json       string `pulumi:"json"`
	OutputText string `pulumi:"outputText"`
}

func GetAppSecCustomRulesOutput(ctx *pulumi.Context, args GetAppSecCustomRulesOutputArgs, opts ...pulumi.InvokeOption) GetAppSecCustomRulesResultOutput {
	return pulumi.ToOutputWithContext(context.Background(), args).
		ApplyT(func(v interface{}) (GetAppSecCustomRulesResult, error) {
			args := v.(GetAppSecCustomRulesArgs)
			r, err := GetAppSecCustomRules(ctx, &args, opts...)
			var s GetAppSecCustomRulesResult
			if r != nil {
				s = *r
			}
			return s, err
		}).(GetAppSecCustomRulesResultOutput)
}

// A collection of arguments for invoking getAppSecCustomRules.
type GetAppSecCustomRulesOutputArgs struct {
	// . Unique identifier of the security configuration associated with the custom rules.
	ConfigId pulumi.IntInput `pulumi:"configId"`
	// . Unique identifier of the custom rule you want to return information for. If not included, information is returned for all your custom rules.
	CustomRuleId pulumi.IntPtrInput `pulumi:"customRuleId"`
}

func (GetAppSecCustomRulesOutputArgs) ElementType() reflect.Type {
	return reflect.TypeOf((*GetAppSecCustomRulesArgs)(nil)).Elem()
}

// A collection of values returned by getAppSecCustomRules.
type GetAppSecCustomRulesResultOutput struct{ *pulumi.OutputState }

func (GetAppSecCustomRulesResultOutput) ElementType() reflect.Type {
	return reflect.TypeOf((*GetAppSecCustomRulesResult)(nil)).Elem()
}

func (o GetAppSecCustomRulesResultOutput) ToGetAppSecCustomRulesResultOutput() GetAppSecCustomRulesResultOutput {
	return o
}

func (o GetAppSecCustomRulesResultOutput) ToGetAppSecCustomRulesResultOutputWithContext(ctx context.Context) GetAppSecCustomRulesResultOutput {
	return o
}

func (o GetAppSecCustomRulesResultOutput) ConfigId() pulumi.IntOutput {
	return o.ApplyT(func(v GetAppSecCustomRulesResult) int { return v.ConfigId }).(pulumi.IntOutput)
}

func (o GetAppSecCustomRulesResultOutput) CustomRuleId() pulumi.IntPtrOutput {
	return o.ApplyT(func(v GetAppSecCustomRulesResult) *int { return v.CustomRuleId }).(pulumi.IntPtrOutput)
}

// The provider-assigned unique ID for this managed resource.
func (o GetAppSecCustomRulesResultOutput) Id() pulumi.StringOutput {
	return o.ApplyT(func(v GetAppSecCustomRulesResult) string { return v.Id }).(pulumi.StringOutput)
}

func (o GetAppSecCustomRulesResultOutput) Json() pulumi.StringOutput {
	return o.ApplyT(func(v GetAppSecCustomRulesResult) string { return v.Json }).(pulumi.StringOutput)
}

func (o GetAppSecCustomRulesResultOutput) OutputText() pulumi.StringOutput {
	return o.ApplyT(func(v GetAppSecCustomRulesResult) string { return v.OutputText }).(pulumi.StringOutput)
}

func init() {
	pulumi.RegisterOutputType(GetAppSecCustomRulesResultOutput{})
}