Copyright | (c) 2013-2023 Brendan Hay |
---|---|
License | Mozilla Public License, v. 2.0. |
Maintainer | Brendan Hay |
Stability | auto-generated |
Portability | non-portable (GHC extensions) |
Safe Haskell | Safe-Inferred |
Language | Haskell2010 |
High-level information about a rule group, returned by operations like create and describe. You can use the information provided in the metadata to retrieve and manage a rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
Synopsis
- data DescribeRuleGroupMetadata = DescribeRuleGroupMetadata' {}
- newDescribeRuleGroupMetadata :: DescribeRuleGroupMetadata
- describeRuleGroupMetadata_ruleGroupArn :: Lens' DescribeRuleGroupMetadata (Maybe Text)
- describeRuleGroupMetadata_ruleGroupName :: Lens' DescribeRuleGroupMetadata (Maybe Text)
- describeRuleGroupMetadata_type :: Lens' DescribeRuleGroupMetadata (Maybe RuleGroupType)
- data DescribeRuleGroupMetadataResponse = DescribeRuleGroupMetadataResponse' {}
- newDescribeRuleGroupMetadataResponse :: Int -> Text -> Text -> DescribeRuleGroupMetadataResponse
- describeRuleGroupMetadataResponse_capacity :: Lens' DescribeRuleGroupMetadataResponse (Maybe Int)
- describeRuleGroupMetadataResponse_description :: Lens' DescribeRuleGroupMetadataResponse (Maybe Text)
- describeRuleGroupMetadataResponse_lastModifiedTime :: Lens' DescribeRuleGroupMetadataResponse (Maybe UTCTime)
- describeRuleGroupMetadataResponse_statefulRuleOptions :: Lens' DescribeRuleGroupMetadataResponse (Maybe StatefulRuleOptions)
- describeRuleGroupMetadataResponse_type :: Lens' DescribeRuleGroupMetadataResponse (Maybe RuleGroupType)
- describeRuleGroupMetadataResponse_httpStatus :: Lens' DescribeRuleGroupMetadataResponse Int
- describeRuleGroupMetadataResponse_ruleGroupArn :: Lens' DescribeRuleGroupMetadataResponse Text
- describeRuleGroupMetadataResponse_ruleGroupName :: Lens' DescribeRuleGroupMetadataResponse Text
Creating a Request
data DescribeRuleGroupMetadata Source #
See: newDescribeRuleGroupMetadata
smart constructor.
DescribeRuleGroupMetadata' | |
|
Instances
newDescribeRuleGroupMetadata :: DescribeRuleGroupMetadata Source #
Create a value of DescribeRuleGroupMetadata
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRuleGroupMetadata
, describeRuleGroupMetadata_ruleGroupArn
- The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
You must specify the ARN or the name, and you can specify both.
DescribeRuleGroupMetadata
, describeRuleGroupMetadata_ruleGroupName
- The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
You must specify the ARN or the name, and you can specify both.
DescribeRuleGroupMetadata
, describeRuleGroupMetadata_type
- Indicates whether the rule group is stateless or stateful. If the rule
group is stateless, it contains stateless rules. If it is stateful, it
contains stateful rules.
This setting is required for requests that do not include the
RuleGroupARN
.
Request Lenses
describeRuleGroupMetadata_ruleGroupArn :: Lens' DescribeRuleGroupMetadata (Maybe Text) Source #
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
describeRuleGroupMetadata_ruleGroupName :: Lens' DescribeRuleGroupMetadata (Maybe Text) Source #
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
describeRuleGroupMetadata_type :: Lens' DescribeRuleGroupMetadata (Maybe RuleGroupType) Source #
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the
RuleGroupARN
.
Destructuring the Response
data DescribeRuleGroupMetadataResponse Source #
See: newDescribeRuleGroupMetadataResponse
smart constructor.
DescribeRuleGroupMetadataResponse' | |
|
Instances
newDescribeRuleGroupMetadataResponse Source #
:: Int | |
-> Text | |
-> Text | |
-> DescribeRuleGroupMetadataResponse |
Create a value of DescribeRuleGroupMetadataResponse
with all optional fields omitted.
Use generic-lens or optics to modify other optional fields.
The following record fields are available, with the corresponding lenses provided for backwards compatibility:
DescribeRuleGroupMetadataResponse
, describeRuleGroupMetadataResponse_capacity
- The maximum operating resources that this rule group can use. Rule group
capacity is fixed at creation. When you update a rule group, you are
limited to this capacity. When you reference a rule group from a
firewall policy, Network Firewall reserves this capacity for the rule
group.
You can retrieve the capacity that would be required for a rule group
before you create the rule group by calling CreateRuleGroup with
DryRun
set to TRUE
.
DescribeRuleGroupMetadataResponse
, describeRuleGroupMetadataResponse_description
- Returns the metadata objects for the specified rule group.
DescribeRuleGroupMetadataResponse
, describeRuleGroupMetadataResponse_lastModifiedTime
- The last time that the rule group was changed.
DescribeRuleGroupMetadataResponse
, describeRuleGroupMetadataResponse_statefulRuleOptions
- Undocumented member.
DescribeRuleGroupMetadata
, describeRuleGroupMetadataResponse_type
- Indicates whether the rule group is stateless or stateful. If the rule
group is stateless, it contains stateless rules. If it is stateful, it
contains stateful rules.
This setting is required for requests that do not include the
RuleGroupARN
.
$sel:httpStatus:DescribeRuleGroupMetadataResponse'
, describeRuleGroupMetadataResponse_httpStatus
- The response's http status code.
DescribeRuleGroupMetadata
, describeRuleGroupMetadataResponse_ruleGroupArn
- The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
You must specify the ARN or the name, and you can specify both.
DescribeRuleGroupMetadata
, describeRuleGroupMetadataResponse_ruleGroupName
- The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
You must specify the ARN or the name, and you can specify both.
Response Lenses
describeRuleGroupMetadataResponse_capacity :: Lens' DescribeRuleGroupMetadataResponse (Maybe Int) Source #
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group.
You can retrieve the capacity that would be required for a rule group
before you create the rule group by calling CreateRuleGroup with
DryRun
set to TRUE
.
describeRuleGroupMetadataResponse_description :: Lens' DescribeRuleGroupMetadataResponse (Maybe Text) Source #
Returns the metadata objects for the specified rule group.
describeRuleGroupMetadataResponse_lastModifiedTime :: Lens' DescribeRuleGroupMetadataResponse (Maybe UTCTime) Source #
The last time that the rule group was changed.
describeRuleGroupMetadataResponse_statefulRuleOptions :: Lens' DescribeRuleGroupMetadataResponse (Maybe StatefulRuleOptions) Source #
Undocumented member.
describeRuleGroupMetadataResponse_type :: Lens' DescribeRuleGroupMetadataResponse (Maybe RuleGroupType) Source #
Indicates whether the rule group is stateless or stateful. If the rule group is stateless, it contains stateless rules. If it is stateful, it contains stateful rules.
This setting is required for requests that do not include the
RuleGroupARN
.
describeRuleGroupMetadataResponse_httpStatus :: Lens' DescribeRuleGroupMetadataResponse Int Source #
The response's http status code.
describeRuleGroupMetadataResponse_ruleGroupArn :: Lens' DescribeRuleGroupMetadataResponse Text Source #
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
describeRuleGroupMetadataResponse_ruleGroupName :: Lens' DescribeRuleGroupMetadataResponse Text Source #
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.