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 |
Synopsis
- data RuleGroupResponse = RuleGroupResponse' {
- capacity :: Maybe Int
- consumedCapacity :: Maybe Int
- description :: Maybe Text
- encryptionConfiguration :: Maybe EncryptionConfiguration
- lastModifiedTime :: Maybe POSIX
- numberOfAssociations :: Maybe Int
- ruleGroupStatus :: Maybe ResourceStatus
- snsTopic :: Maybe Text
- sourceMetadata :: Maybe SourceMetadata
- tags :: Maybe (NonEmpty Tag)
- type' :: Maybe RuleGroupType
- ruleGroupArn :: Text
- ruleGroupName :: Text
- ruleGroupId :: Text
- newRuleGroupResponse :: Text -> Text -> Text -> RuleGroupResponse
- ruleGroupResponse_capacity :: Lens' RuleGroupResponse (Maybe Int)
- ruleGroupResponse_consumedCapacity :: Lens' RuleGroupResponse (Maybe Int)
- ruleGroupResponse_description :: Lens' RuleGroupResponse (Maybe Text)
- ruleGroupResponse_encryptionConfiguration :: Lens' RuleGroupResponse (Maybe EncryptionConfiguration)
- ruleGroupResponse_lastModifiedTime :: Lens' RuleGroupResponse (Maybe UTCTime)
- ruleGroupResponse_numberOfAssociations :: Lens' RuleGroupResponse (Maybe Int)
- ruleGroupResponse_ruleGroupStatus :: Lens' RuleGroupResponse (Maybe ResourceStatus)
- ruleGroupResponse_snsTopic :: Lens' RuleGroupResponse (Maybe Text)
- ruleGroupResponse_sourceMetadata :: Lens' RuleGroupResponse (Maybe SourceMetadata)
- ruleGroupResponse_tags :: Lens' RuleGroupResponse (Maybe (NonEmpty Tag))
- ruleGroupResponse_type :: Lens' RuleGroupResponse (Maybe RuleGroupType)
- ruleGroupResponse_ruleGroupArn :: Lens' RuleGroupResponse Text
- ruleGroupResponse_ruleGroupName :: Lens' RuleGroupResponse Text
- ruleGroupResponse_ruleGroupId :: Lens' RuleGroupResponse Text
Documentation
data RuleGroupResponse Source #
The high-level properties of a rule group. This, along with the RuleGroup, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
See: newRuleGroupResponse
smart constructor.
RuleGroupResponse' | |
|
Instances
:: Text | |
-> Text | |
-> Text | |
-> RuleGroupResponse |
Create a value of RuleGroupResponse
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:
$sel:capacity:RuleGroupResponse'
, ruleGroupResponse_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
.
$sel:consumedCapacity:RuleGroupResponse'
, ruleGroupResponse_consumedCapacity
- The number of capacity units currently consumed by the rule group rules.
$sel:description:RuleGroupResponse'
, ruleGroupResponse_description
- A description of the rule group.
$sel:encryptionConfiguration:RuleGroupResponse'
, ruleGroupResponse_encryptionConfiguration
- A complex type that contains the Amazon Web Services KMS encryption
configuration settings for your rule group.
$sel:lastModifiedTime:RuleGroupResponse'
, ruleGroupResponse_lastModifiedTime
- The last time that the rule group was changed.
$sel:numberOfAssociations:RuleGroupResponse'
, ruleGroupResponse_numberOfAssociations
- The number of firewall policies that use this rule group.
$sel:ruleGroupStatus:RuleGroupResponse'
, ruleGroupResponse_ruleGroupStatus
- Detailed information about the current status of a rule group.
$sel:snsTopic:RuleGroupResponse'
, ruleGroupResponse_snsTopic
- The Amazon resource name (ARN) of the Amazon Simple Notification Service
SNS topic that's used to record changes to the managed rule group. You
can subscribe to the SNS topic to receive notifications when the managed
rule group is modified, such as for new versions and for version
expiration. For more information, see the
Amazon Simple Notification Service Developer Guide..
$sel:sourceMetadata:RuleGroupResponse'
, ruleGroupResponse_sourceMetadata
- A complex type that contains metadata about the rule group that your own
rule group is copied from. You can use the metadata to track the version
updates made to the originating rule group.
$sel:tags:RuleGroupResponse'
, ruleGroupResponse_tags
- The key:value pairs to associate with the resource.
RuleGroupResponse
, ruleGroupResponse_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.
$sel:ruleGroupArn:RuleGroupResponse'
, ruleGroupResponse_ruleGroupArn
- The Amazon Resource Name (ARN) of the rule group.
If this response is for a create request that had DryRun
set to
TRUE
, then this ARN is a placeholder that isn't attached to a valid
resource.
$sel:ruleGroupName:RuleGroupResponse'
, ruleGroupResponse_ruleGroupName
- The descriptive name of the rule group. You can't change the name of a
rule group after you create it.
$sel:ruleGroupId:RuleGroupResponse'
, ruleGroupResponse_ruleGroupId
- The unique identifier for the rule group.
ruleGroupResponse_capacity :: Lens' RuleGroupResponse (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
.
ruleGroupResponse_consumedCapacity :: Lens' RuleGroupResponse (Maybe Int) Source #
The number of capacity units currently consumed by the rule group rules.
ruleGroupResponse_description :: Lens' RuleGroupResponse (Maybe Text) Source #
A description of the rule group.
ruleGroupResponse_encryptionConfiguration :: Lens' RuleGroupResponse (Maybe EncryptionConfiguration) Source #
A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
ruleGroupResponse_lastModifiedTime :: Lens' RuleGroupResponse (Maybe UTCTime) Source #
The last time that the rule group was changed.
ruleGroupResponse_numberOfAssociations :: Lens' RuleGroupResponse (Maybe Int) Source #
The number of firewall policies that use this rule group.
ruleGroupResponse_ruleGroupStatus :: Lens' RuleGroupResponse (Maybe ResourceStatus) Source #
Detailed information about the current status of a rule group.
ruleGroupResponse_snsTopic :: Lens' RuleGroupResponse (Maybe Text) Source #
The Amazon resource name (ARN) of the Amazon Simple Notification Service SNS topic that's used to record changes to the managed rule group. You can subscribe to the SNS topic to receive notifications when the managed rule group is modified, such as for new versions and for version expiration. For more information, see the Amazon Simple Notification Service Developer Guide..
ruleGroupResponse_sourceMetadata :: Lens' RuleGroupResponse (Maybe SourceMetadata) Source #
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to track the version updates made to the originating rule group.
ruleGroupResponse_tags :: Lens' RuleGroupResponse (Maybe (NonEmpty Tag)) Source #
The key:value pairs to associate with the resource.
ruleGroupResponse_type :: Lens' RuleGroupResponse (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.
ruleGroupResponse_ruleGroupArn :: Lens' RuleGroupResponse Text Source #
The Amazon Resource Name (ARN) of the rule group.
If this response is for a create request that had DryRun
set to
TRUE
, then this ARN is a placeholder that isn't attached to a valid
resource.
ruleGroupResponse_ruleGroupName :: Lens' RuleGroupResponse Text Source #
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
ruleGroupResponse_ruleGroupId :: Lens' RuleGroupResponse Text Source #
The unique identifier for the rule group.