1// Code generated by smithy-go-codegen DO NOT EDIT.
2
3package waf
4
5import (
6	"context"
7	awsmiddleware "github.com/aws/aws-sdk-go-v2/aws/middleware"
8	"github.com/aws/aws-sdk-go-v2/aws/signer/v4"
9	"github.com/aws/aws-sdk-go-v2/service/waf/types"
10	"github.com/aws/smithy-go/middleware"
11	smithyhttp "github.com/aws/smithy-go/transport/http"
12)
13
14// This is AWS WAF Classic documentation. For more information, see AWS WAF Classic
15// (https://docs.aws.amazon.com/waf/latest/developerguide/classic-waf-chapter.html)
16// in the developer guide. For the latest version of AWS WAF, use the AWS WAFV2 API
17// and see the AWS WAF Developer Guide
18// (https://docs.aws.amazon.com/waf/latest/developerguide/waf-chapter.html). With
19// the latest version, AWS WAF has a single set of endpoints for regional and
20// global use. Creates a RuleGroup. A rule group is a collection of predefined
21// rules that you add to a web ACL. You use UpdateRuleGroup to add rules to the
22// rule group. Rule groups are subject to the following limits:
23//
24// * Three rule
25// groups per account. You can request an increase to this limit by contacting
26// customer support.
27//
28// * One rule group per web ACL.
29//
30// * Ten rules per rule
31// group.
32//
33// For more information about how to use the AWS WAF API to allow or block
34// HTTP requests, see the AWS WAF Developer Guide
35// (https://docs.aws.amazon.com/waf/latest/developerguide/).
36func (c *Client) CreateRuleGroup(ctx context.Context, params *CreateRuleGroupInput, optFns ...func(*Options)) (*CreateRuleGroupOutput, error) {
37	if params == nil {
38		params = &CreateRuleGroupInput{}
39	}
40
41	result, metadata, err := c.invokeOperation(ctx, "CreateRuleGroup", params, optFns, addOperationCreateRuleGroupMiddlewares)
42	if err != nil {
43		return nil, err
44	}
45
46	out := result.(*CreateRuleGroupOutput)
47	out.ResultMetadata = metadata
48	return out, nil
49}
50
51type CreateRuleGroupInput struct {
52
53	// The value returned by the most recent call to GetChangeToken.
54	//
55	// This member is required.
56	ChangeToken *string
57
58	// A friendly name or description for the metrics for this RuleGroup. The name can
59	// contain only alphanumeric characters (A-Z, a-z, 0-9), with maximum length 128
60	// and minimum length one. It can't contain whitespace or metric names reserved for
61	// AWS WAF, including "All" and "Default_Action." You can't change the name of the
62	// metric after you create the RuleGroup.
63	//
64	// This member is required.
65	MetricName *string
66
67	// A friendly name or description of the RuleGroup. You can't change Name after you
68	// create a RuleGroup.
69	//
70	// This member is required.
71	Name *string
72
73	//
74	Tags []types.Tag
75}
76
77type CreateRuleGroupOutput struct {
78
79	// The ChangeToken that you used to submit the CreateRuleGroup request. You can
80	// also use this value to query the status of the request. For more information,
81	// see GetChangeTokenStatus.
82	ChangeToken *string
83
84	// An empty RuleGroup.
85	RuleGroup *types.RuleGroup
86
87	// Metadata pertaining to the operation's result.
88	ResultMetadata middleware.Metadata
89}
90
91func addOperationCreateRuleGroupMiddlewares(stack *middleware.Stack, options Options) (err error) {
92	err = stack.Serialize.Add(&awsAwsjson11_serializeOpCreateRuleGroup{}, middleware.After)
93	if err != nil {
94		return err
95	}
96	err = stack.Deserialize.Add(&awsAwsjson11_deserializeOpCreateRuleGroup{}, middleware.After)
97	if err != nil {
98		return err
99	}
100	if err = addSetLoggerMiddleware(stack, options); err != nil {
101		return err
102	}
103	if err = awsmiddleware.AddClientRequestIDMiddleware(stack); err != nil {
104		return err
105	}
106	if err = smithyhttp.AddComputeContentLengthMiddleware(stack); err != nil {
107		return err
108	}
109	if err = addResolveEndpointMiddleware(stack, options); err != nil {
110		return err
111	}
112	if err = v4.AddComputePayloadSHA256Middleware(stack); err != nil {
113		return err
114	}
115	if err = addRetryMiddlewares(stack, options); err != nil {
116		return err
117	}
118	if err = addHTTPSignerV4Middleware(stack, options); err != nil {
119		return err
120	}
121	if err = awsmiddleware.AddRawResponseToMetadata(stack); err != nil {
122		return err
123	}
124	if err = awsmiddleware.AddRecordResponseTiming(stack); err != nil {
125		return err
126	}
127	if err = addClientUserAgent(stack); err != nil {
128		return err
129	}
130	if err = smithyhttp.AddErrorCloseResponseBodyMiddleware(stack); err != nil {
131		return err
132	}
133	if err = smithyhttp.AddCloseResponseBodyMiddleware(stack); err != nil {
134		return err
135	}
136	if err = addOpCreateRuleGroupValidationMiddleware(stack); err != nil {
137		return err
138	}
139	if err = stack.Initialize.Add(newServiceMetadataMiddleware_opCreateRuleGroup(options.Region), middleware.Before); err != nil {
140		return err
141	}
142	if err = addRequestIDRetrieverMiddleware(stack); err != nil {
143		return err
144	}
145	if err = addResponseErrorMiddleware(stack); err != nil {
146		return err
147	}
148	if err = addRequestResponseLogging(stack, options); err != nil {
149		return err
150	}
151	return nil
152}
153
154func newServiceMetadataMiddleware_opCreateRuleGroup(region string) *awsmiddleware.RegisterServiceMetadata {
155	return &awsmiddleware.RegisterServiceMetadata{
156		Region:        region,
157		ServiceID:     ServiceID,
158		SigningName:   "waf",
159		OperationName: "CreateRuleGroup",
160	}
161}
162