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

Amazonka.NetworkFirewall.DescribeRuleGroupMetadata

Contents

Creating a Request
Request Lenses
Destructuring the Response
Response Lenses

Description

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

Creating a Request

data DescribeRuleGroupMetadata Source #

See: newDescribeRuleGroupMetadata smart constructor.

Constructors

DescribeRuleGroupMetadata'

Fields

ruleGroupArn :: Maybe Text
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.
ruleGroupName :: Maybe Text
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.
type' :: Maybe RuleGroupType
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.

Instances

Instances details

ToJSON DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods toJSON :: DescribeRuleGroupMetadata -> Value # toEncoding :: DescribeRuleGroupMetadata -> Encoding # toJSONList :: [DescribeRuleGroupMetadata] -> Value # toEncodingList :: [DescribeRuleGroupMetadata] -> Encoding #
ToHeaders DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods toHeaders :: DescribeRuleGroupMetadata -> [Header] #
ToPath DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods toPath :: DescribeRuleGroupMetadata -> ByteString #
ToQuery DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods toQuery :: DescribeRuleGroupMetadata -> QueryString #
AWSRequest DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Associated Types type AWSResponse DescribeRuleGroupMetadata # Methods request :: (Service -> Service) -> DescribeRuleGroupMetadata -> Request DescribeRuleGroupMetadata # response :: MonadResource m => (ByteStringLazy -> IO ByteStringLazy) -> Service -> Proxy DescribeRuleGroupMetadata -> ClientResponse ClientBody -> m (Either Error (ClientResponse (AWSResponse DescribeRuleGroupMetadata))) #
Generic DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Associated Types type Rep DescribeRuleGroupMetadata :: Type -> Type # Methods from :: DescribeRuleGroupMetadata -> Rep DescribeRuleGroupMetadata x # to :: Rep DescribeRuleGroupMetadata x -> DescribeRuleGroupMetadata #
Read DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods readsPrec :: Int -> ReadS DescribeRuleGroupMetadata # readList :: ReadS [DescribeRuleGroupMetadata] # readPrec :: ReadPrec DescribeRuleGroupMetadata # readListPrec :: ReadPrec [DescribeRuleGroupMetadata] #
Show DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods showsPrec :: Int -> DescribeRuleGroupMetadata -> ShowS # show :: DescribeRuleGroupMetadata -> String # showList :: [DescribeRuleGroupMetadata] -> ShowS #
NFData DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods rnf :: DescribeRuleGroupMetadata -> () #
Eq DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods (==) :: DescribeRuleGroupMetadata -> DescribeRuleGroupMetadata -> Bool # (/=) :: DescribeRuleGroupMetadata -> DescribeRuleGroupMetadata -> Bool #
Hashable DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods hashWithSalt :: Int -> DescribeRuleGroupMetadata -> Int # hash :: DescribeRuleGroupMetadata -> Int #
type AWSResponse DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata type AWSResponse DescribeRuleGroupMetadata = DescribeRuleGroupMetadataResponse
type Rep DescribeRuleGroupMetadata Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata type Rep DescribeRuleGroupMetadata = D1 ('MetaData "DescribeRuleGroupMetadata" "Amazonka.NetworkFirewall.DescribeRuleGroupMetadata" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "DescribeRuleGroupMetadata'" 'PrefixI 'True) (S1 ('MetaSel ('Just "ruleGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: (S1 ('MetaSel ('Just "ruleGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text)) :: S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleGroupType)))))

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.

Constructors

DescribeRuleGroupMetadataResponse'

Fields

capacity :: Maybe Int
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.
description :: Maybe Text
Returns the metadata objects for the specified rule group.
lastModifiedTime :: Maybe POSIX
The last time that the rule group was changed.
statefulRuleOptions :: Maybe StatefulRuleOptions
type' :: Maybe RuleGroupType
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.
httpStatus :: Int
The response's http status code.
ruleGroupArn :: Text
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.
ruleGroupName :: Text
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.

Instances

Instances details

Generic DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Associated Types type Rep DescribeRuleGroupMetadataResponse :: Type -> Type # Methods from :: DescribeRuleGroupMetadataResponse -> Rep DescribeRuleGroupMetadataResponse x # to :: Rep DescribeRuleGroupMetadataResponse x -> DescribeRuleGroupMetadataResponse #
Read DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods readsPrec :: Int -> ReadS DescribeRuleGroupMetadataResponse # readList :: ReadS [DescribeRuleGroupMetadataResponse] # readPrec :: ReadPrec DescribeRuleGroupMetadataResponse # readListPrec :: ReadPrec [DescribeRuleGroupMetadataResponse] #
Show DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods showsPrec :: Int -> DescribeRuleGroupMetadataResponse -> ShowS # show :: DescribeRuleGroupMetadataResponse -> String # showList :: [DescribeRuleGroupMetadataResponse] -> ShowS #
NFData DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods rnf :: DescribeRuleGroupMetadataResponse -> () #
Eq DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata Methods (==) :: DescribeRuleGroupMetadataResponse -> DescribeRuleGroupMetadataResponse -> Bool # (/=) :: DescribeRuleGroupMetadataResponse -> DescribeRuleGroupMetadataResponse -> Bool #
type Rep DescribeRuleGroupMetadataResponse Source #
Instance details Defined in Amazonka.NetworkFirewall.DescribeRuleGroupMetadata type Rep DescribeRuleGroupMetadataResponse = D1 ('MetaData "DescribeRuleGroupMetadataResponse" "Amazonka.NetworkFirewall.DescribeRuleGroupMetadata" "amazonka-network-firewall-2.0-4y6HybZBSNcEwGPO5AYVfm" 'False) (C1 ('MetaCons "DescribeRuleGroupMetadataResponse'" 'PrefixI 'True) (((S1 ('MetaSel ('Just "capacity") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Int)) :: S1 ('MetaSel ('Just "description") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe Text))) :: (S1 ('MetaSel ('Just "lastModifiedTime") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe POSIX)) :: S1 ('MetaSel ('Just "statefulRuleOptions") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe StatefulRuleOptions)))) :: ((S1 ('MetaSel ('Just "type'") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 (Maybe RuleGroupType)) :: S1 ('MetaSel ('Just "httpStatus") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Int)) :: (S1 ('MetaSel ('Just "ruleGroupArn") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text) :*: S1 ('MetaSel ('Just "ruleGroupName") 'NoSourceUnpackedness 'NoSourceStrictness 'DecidedStrict) (Rec0 Text)))))

newDescribeRuleGroupMetadataResponse Source #

Arguments

:: Int	`$sel:httpStatus:DescribeRuleGroupMetadataResponse'`
-> Text	`DescribeRuleGroupMetadata`
-> Text	`DescribeRuleGroupMetadata`
-> 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.