META-INF.smithy.networkfirewall.smithy Maven / Gradle / Ivy
Show all versions of aws-network-firewall-spec Show documentation
$version: "2.0"
metadata suppressions = [
{
id: "HttpMethodSemantics"
namespace: "*"
}
{
id: "HttpResponseCodeSemantics"
namespace: "*"
}
{
id: "PaginatedTrait"
namespace: "*"
}
{
id: "HttpHeaderTrait"
namespace: "*"
}
{
id: "HttpUriConflict"
namespace: "*"
}
{
id: "Service"
namespace: "*"
}
]
namespace com.amazonaws.networkfirewall
use aws.api#service
use aws.auth#sigv4
use aws.protocols#awsJson1_0
/// This is the API Reference for Network Firewall. This guide is for developers who need
/// detailed information about the Network Firewall API actions, data types, and errors.
///
/// -
///
The REST API requires you to handle connection details, such as calculating
/// signatures, handling request retries, and error handling. For general information
/// about using the Amazon Web Services REST APIs, see Amazon Web Services APIs.
/// To access Network Firewall using the REST API endpoint:
/// https://network-firewall..amazonaws.com
///
///
/// -
///
Alternatively, you can use one of the Amazon Web Services SDKs to access an API that's tailored to
/// the programming language or platform that you're using. For more information, see
/// Amazon Web Services SDKs.
///
/// -
///
For descriptions of Network Firewall features, including and step-by-step
/// instructions on how to use them through the Network Firewall console, see the Network Firewall Developer
/// Guide.
///
///
/// Network Firewall is a stateful, managed, network firewall and intrusion detection and
/// prevention service for Amazon Virtual Private Cloud (Amazon VPC). With Network Firewall, you can filter traffic at the
/// perimeter of your VPC. This includes filtering traffic going to and coming from an internet
/// gateway, NAT gateway, or over VPN or Direct Connect. Network Firewall uses rules that are compatible
/// with Suricata, a free, open source network analysis and threat detection engine.
/// Network Firewall supports Suricata version 6.0.9. For information about Suricata,
/// see the Suricata website.
/// You can use Network Firewall to monitor and protect your VPC traffic in a number of ways.
/// The following are just a few examples:
///
/// -
///
Allow domains or IP addresses for known Amazon Web Services service endpoints, such as Amazon S3, and
/// block all other forms of traffic.
///
/// -
///
Use custom lists of known bad domains to limit the types of domain names that your
/// applications can access.
///
/// -
///
Perform deep packet inspection on traffic entering or leaving your VPC.
///
/// -
///
Use stateful protocol detection to filter protocols like HTTPS, regardless of the
/// port used.
///
///
/// To enable Network Firewall for your VPCs, you perform steps in both Amazon VPC and in
/// Network Firewall. For information about using Amazon VPC, see Amazon VPC User Guide.
/// To start using Network Firewall, do the following:
///
/// -
///
(Optional) If you don't already have a VPC that you want to protect, create it in
/// Amazon VPC.
///
/// -
///
In Amazon VPC, in each Availability Zone where you want to have a firewall endpoint, create a
/// subnet for the sole use of Network Firewall.
///
/// -
///
In Network Firewall, create stateless and stateful rule groups,
/// to define the components of the network traffic filtering behavior that you want your firewall to have.
///
/// -
///
In Network Firewall, create a firewall policy that uses your rule groups and
/// specifies additional default traffic filtering behavior.
///
/// -
///
In Network Firewall, create a firewall and specify your new firewall policy and
/// VPC subnets. Network Firewall creates a firewall endpoint in each subnet that you
/// specify, with the behavior that's defined in the firewall policy.
///
/// -
///
In Amazon VPC, use ingress routing enhancements to route traffic through the new firewall
/// endpoints.
///
///
@service(
sdkId: "Network Firewall"
arnNamespace: "network-firewall"
cloudFormationName: "NetworkFirewall"
cloudTrailEventSource: "networkfirewall.amazonaws.com"
endpointPrefix: "network-firewall"
)
@sigv4(
name: "network-firewall"
)
@awsJson1_0
@title("AWS Network Firewall")
service NetworkFirewall_20201112 {
version: "2020-11-12"
operations: [
AssociateFirewallPolicy
AssociateSubnets
CreateFirewall
CreateFirewallPolicy
CreateRuleGroup
CreateTLSInspectionConfiguration
DeleteFirewall
DeleteFirewallPolicy
DeleteResourcePolicy
DeleteRuleGroup
DeleteTLSInspectionConfiguration
DescribeFirewall
DescribeFirewallPolicy
DescribeLoggingConfiguration
DescribeResourcePolicy
DescribeRuleGroup
DescribeRuleGroupMetadata
DescribeTLSInspectionConfiguration
DisassociateSubnets
ListFirewallPolicies
ListFirewalls
ListRuleGroups
ListTagsForResource
ListTLSInspectionConfigurations
PutResourcePolicy
TagResource
UntagResource
UpdateFirewallDeleteProtection
UpdateFirewallDescription
UpdateFirewallEncryptionConfiguration
UpdateFirewallPolicy
UpdateFirewallPolicyChangeProtection
UpdateLoggingConfiguration
UpdateRuleGroup
UpdateSubnetChangeProtection
UpdateTLSInspectionConfiguration
]
}
/// Associates a FirewallPolicy to a Firewall.
/// A firewall policy defines how to monitor and manage your VPC network traffic, using a
/// collection of inspection rule groups and other settings. Each firewall requires one
/// firewall policy association, and you can use the same firewall policy for multiple
/// firewalls.
operation AssociateFirewallPolicy {
input: AssociateFirewallPolicyRequest
output: AssociateFirewallPolicyResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// Associates the specified subnets in the Amazon VPC to the firewall. You can specify one
/// subnet for each of the Availability Zones that the VPC spans.
/// This request creates an Network Firewall firewall endpoint in each of the subnets. To
/// enable the firewall's protections, you must also modify the VPC's route tables for each
/// subnet's Availability Zone, to redirect the traffic that's coming into and going out of the
/// zone through the firewall endpoint.
operation AssociateSubnets {
input: AssociateSubnetsRequest
output: AssociateSubnetsResponse
errors: [
InsufficientCapacityException
InternalServerError
InvalidOperationException
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// Creates an Network Firewall Firewall and accompanying FirewallStatus for a VPC.
/// The firewall defines the configuration settings for an Network Firewall firewall. The settings that you can define at creation include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
/// After you create a firewall, you can provide additional settings, like the logging configuration.
/// To update the settings for a firewall, you use the operations that apply to the settings
/// themselves, for example UpdateLoggingConfiguration, AssociateSubnets, and UpdateFirewallDeleteProtection.
/// To manage a firewall's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
/// To retrieve information about firewalls, use ListFirewalls and DescribeFirewall.
operation CreateFirewall {
input: CreateFirewallRequest
output: CreateFirewallResponse
errors: [
InsufficientCapacityException
InternalServerError
InvalidOperationException
InvalidRequestException
LimitExceededException
ThrottlingException
]
}
/// Creates the firewall policy for the firewall according to the specifications.
/// An Network Firewall firewall policy defines the behavior of a firewall, in a collection of
/// stateless and stateful rule groups and other settings. You can use one firewall policy for
/// multiple firewalls.
operation CreateFirewallPolicy {
input: CreateFirewallPolicyRequest
output: CreateFirewallPolicyResponse
errors: [
InsufficientCapacityException
InternalServerError
InvalidRequestException
LimitExceededException
ThrottlingException
]
}
/// Creates the specified stateless or stateful rule group, which includes the rules for
/// network traffic inspection, a capacity setting, and tags.
/// You provide your rule group specification in your request using either
/// RuleGroup or Rules.
operation CreateRuleGroup {
input: CreateRuleGroupRequest
output: CreateRuleGroupResponse
errors: [
InsufficientCapacityException
InternalServerError
InvalidRequestException
LimitExceededException
ThrottlingException
]
}
/// Creates an Network Firewall TLS inspection configuration. A TLS inspection configuration contains the Certificate Manager certificate references that Network Firewall uses to decrypt and re-encrypt inbound traffic.
/// After you create a TLS inspection configuration, you associate it with a new firewall policy.
/// To update the settings for a TLS inspection configuration, use UpdateTLSInspectionConfiguration.
/// To manage a TLS inspection configuration's tags, use the standard Amazon Web Services resource tagging operations, ListTagsForResource, TagResource, and UntagResource.
/// To retrieve information about TLS inspection configurations, use ListTLSInspectionConfigurations and DescribeTLSInspectionConfiguration.
///
/// For more information about TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS
/// inspection configurations in the Network Firewall Developer Guide.
///
operation CreateTLSInspectionConfiguration {
input: CreateTLSInspectionConfigurationRequest
output: CreateTLSInspectionConfigurationResponse
errors: [
InsufficientCapacityException
InternalServerError
InvalidRequestException
LimitExceededException
ThrottlingException
]
}
/// Deletes the specified Firewall and its FirewallStatus.
/// This operation requires the firewall's DeleteProtection flag to be
/// FALSE. You can't revert this operation.
/// You can check whether a firewall is
/// in use by reviewing the route tables for the Availability Zones where you have
/// firewall subnet mappings. Retrieve the subnet mappings by calling DescribeFirewall.
/// You define and update the route tables through Amazon VPC. As needed, update the route tables for the
/// zones to remove the firewall endpoints. When the route tables no longer use the firewall endpoints,
/// you can remove the firewall safely.
/// To delete a firewall, remove the delete protection if you need to using UpdateFirewallDeleteProtection,
/// then delete the firewall by calling DeleteFirewall.
operation DeleteFirewall {
input: DeleteFirewallRequest
output: DeleteFirewallResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnsupportedOperationException
]
}
/// Deletes the specified FirewallPolicy.
operation DeleteFirewallPolicy {
input: DeleteFirewallPolicyRequest
output: DeleteFirewallPolicyResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnsupportedOperationException
]
}
/// Deletes a resource policy that you created in a PutResourcePolicy request.
operation DeleteResourcePolicy {
input: DeleteResourcePolicyRequest
output: DeleteResourcePolicyResponse
errors: [
InternalServerError
InvalidRequestException
InvalidResourcePolicyException
ResourceNotFoundException
ThrottlingException
]
}
/// Deletes the specified RuleGroup.
operation DeleteRuleGroup {
input: DeleteRuleGroupRequest
output: DeleteRuleGroupResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
UnsupportedOperationException
]
}
/// Deletes the specified TLSInspectionConfiguration.
operation DeleteTLSInspectionConfiguration {
input: DeleteTLSInspectionConfigurationRequest
output: DeleteTLSInspectionConfigurationResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Returns the data objects for the specified firewall.
operation DescribeFirewall {
input: DescribeFirewallRequest
output: DescribeFirewallResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Returns the data objects for the specified firewall policy.
operation DescribeFirewallPolicy {
input: DescribeFirewallPolicyRequest
output: DescribeFirewallPolicyResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Returns the logging configuration for the specified firewall.
operation DescribeLoggingConfiguration {
input: DescribeLoggingConfigurationRequest
output: DescribeLoggingConfigurationResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Retrieves a resource policy that you created in a PutResourcePolicy request.
operation DescribeResourcePolicy {
input: DescribeResourcePolicyRequest
output: DescribeResourcePolicyResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Returns the data objects for the specified rule group.
operation DescribeRuleGroup {
input: DescribeRuleGroupRequest
output: DescribeRuleGroupResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// 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.
///
operation DescribeRuleGroupMetadata {
input: DescribeRuleGroupMetadataRequest
output: DescribeRuleGroupMetadataResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Returns the data objects for the specified TLS inspection configuration.
operation DescribeTLSInspectionConfiguration {
input: DescribeTLSInspectionConfigurationRequest
output: DescribeTLSInspectionConfigurationResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Removes the specified subnet associations from the firewall. This removes the
/// firewall endpoints from the subnets and removes any network filtering protections that the endpoints
/// were providing.
///
operation DisassociateSubnets {
input: DisassociateSubnetsRequest
output: DisassociateSubnetsResponse
errors: [
InternalServerError
InvalidOperationException
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// Retrieves the metadata for the firewall policies that you have defined. Depending on
/// your setting for max results and the number of firewall policies, a single call might not
/// return the full list.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "FirewallPolicies"
pageSize: "MaxResults"
)
operation ListFirewallPolicies {
input: ListFirewallPoliciesRequest
output: ListFirewallPoliciesResponse
errors: [
InternalServerError
InvalidRequestException
ThrottlingException
]
}
/// Retrieves the metadata for the firewalls that you have defined. If you provide VPC
/// identifiers in your request, this returns only the firewalls for those VPCs.
/// Depending on your setting for max results and the number of firewalls, a single call
/// might not return the full list.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "Firewalls"
pageSize: "MaxResults"
)
operation ListFirewalls {
input: ListFirewallsRequest
output: ListFirewallsResponse
errors: [
InternalServerError
InvalidRequestException
ThrottlingException
]
}
/// Retrieves the metadata for the rule groups that you have defined. Depending on your
/// setting for max results and the number of rule groups, a single call might not return the
/// full list.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "RuleGroups"
pageSize: "MaxResults"
)
operation ListRuleGroups {
input: ListRuleGroupsRequest
output: ListRuleGroupsResponse
errors: [
InternalServerError
InvalidRequestException
ThrottlingException
]
}
/// Retrieves the tags associated with the specified resource. Tags are key:value pairs that
/// you can use to categorize and manage your resources, for purposes like billing. For
/// example, you might set the tag key to "customer" and the value to the customer name or ID.
/// You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
/// resource.
/// You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall
/// policies, and rule groups.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "Tags"
pageSize: "MaxResults"
)
operation ListTagsForResource {
input: ListTagsForResourceRequest
output: ListTagsForResourceResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Retrieves the metadata for the TLS inspection configurations that you have defined. Depending on your setting for max results and the number of TLS inspection configurations, a single call might not return the full list.
@paginated(
inputToken: "NextToken"
outputToken: "NextToken"
items: "TLSInspectionConfigurations"
pageSize: "MaxResults"
)
operation ListTLSInspectionConfigurations {
input: ListTLSInspectionConfigurationsRequest
output: ListTLSInspectionConfigurationsResponse
errors: [
InternalServerError
InvalidRequestException
ThrottlingException
]
}
/// Creates or updates an IAM policy for your rule group or firewall policy. Use this to share rule groups and firewall policies between accounts. This operation works in conjunction with the Amazon Web Services Resource Access Manager (RAM) service
/// to manage resource sharing for Network Firewall.
/// Use this operation to create or update a resource policy for your rule group or firewall policy. In the policy, you specify the accounts that you want to share the resource with and the operations that you want the accounts to be able to perform.
/// When you add an account in the resource policy, you then run the following Resource Access Manager (RAM) operations to access and accept the shared rule group or firewall policy.
///
/// -
///
/// GetResourceShareInvitations - Returns the Amazon Resource Names (ARNs) of the resource share invitations.
///
/// -
///
/// AcceptResourceShareInvitation - Accepts the share invitation for a specified resource share.
///
///
/// For additional information about resource sharing using RAM, see Resource Access Manager User Guide.
operation PutResourcePolicy {
input: PutResourcePolicyRequest
output: PutResourcePolicyResponse
errors: [
InternalServerError
InvalidRequestException
InvalidResourcePolicyException
ResourceNotFoundException
ThrottlingException
]
}
/// Adds the specified tags to the specified resource. Tags are key:value pairs that you can
/// use to categorize and manage your resources, for purposes like billing. For example, you
/// might set the tag key to "customer" and the value to the customer name or ID. You can
/// specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a resource.
/// You can tag the Amazon Web Services resources that you manage through Network Firewall: firewalls, firewall
/// policies, and rule groups.
operation TagResource {
input: TagResourceRequest
output: TagResourceResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Removes the tags with the specified keys from the specified resource. Tags are key:value
/// pairs that you can use to categorize and manage your resources, for purposes like billing.
/// For example, you might set the tag key to "customer" and the value to the customer name or
/// ID. You can specify one or more tags to add to each Amazon Web Services resource, up to 50 tags for a
/// resource.
/// You can manage tags for the Amazon Web Services resources that you manage through Network Firewall:
/// firewalls, firewall policies, and rule groups.
operation UntagResource {
input: UntagResourceRequest
output: UntagResourceResponse
errors: [
InternalServerError
InvalidRequestException
ResourceNotFoundException
ThrottlingException
]
}
/// Modifies the flag, DeleteProtection, which indicates whether it is possible
/// to delete the firewall. If the flag is set to TRUE, the firewall is protected
/// against deletion. This setting helps protect against accidentally deleting a firewall
/// that's in use.
operation UpdateFirewallDeleteProtection {
input: UpdateFirewallDeleteProtectionRequest
output: UpdateFirewallDeleteProtectionResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ResourceOwnerCheckException
ThrottlingException
]
}
/// Modifies the description for the specified firewall. Use the description to help you
/// identify the firewall when you're working with it.
operation UpdateFirewallDescription {
input: UpdateFirewallDescriptionRequest
output: UpdateFirewallDescriptionResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// A complex type that contains settings for encryption of your firewall resources.
operation UpdateFirewallEncryptionConfiguration {
input: UpdateFirewallEncryptionConfigurationRequest
output: UpdateFirewallEncryptionConfigurationResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ResourceOwnerCheckException
ThrottlingException
]
}
/// Updates the properties of the specified firewall policy.
operation UpdateFirewallPolicy {
input: UpdateFirewallPolicyRequest
output: UpdateFirewallPolicyResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// Modifies the flag, ChangeProtection, which indicates whether it
/// is possible to change the firewall. If the flag is set to TRUE, the firewall is protected
/// from changes. This setting helps protect against accidentally changing a firewall that's in use.
operation UpdateFirewallPolicyChangeProtection {
input: UpdateFirewallPolicyChangeProtectionRequest
output: UpdateFirewallPolicyChangeProtectionResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ResourceOwnerCheckException
ThrottlingException
]
}
/// Sets the logging configuration for the specified firewall.
/// To change the logging configuration, retrieve the LoggingConfiguration by calling DescribeLoggingConfiguration, then change it and provide
/// the modified object to this update call. You must change the logging configuration one
/// LogDestinationConfig at a time inside the retrieved LoggingConfiguration object.
/// You can perform only one of the following actions in any call to
/// UpdateLoggingConfiguration:
///
/// -
///
Create a new log destination object by adding a single
/// LogDestinationConfig array element to
/// LogDestinationConfigs.
///
/// -
///
Delete a log destination object by removing a single
/// LogDestinationConfig array element from
/// LogDestinationConfigs.
///
/// -
///
Change the LogDestination setting in a single
/// LogDestinationConfig array element.
///
///
/// You can't change the LogDestinationType or LogType in a
/// LogDestinationConfig. To change these settings, delete the existing
/// LogDestinationConfig object and create a new one, using two separate calls
/// to this update operation.
operation UpdateLoggingConfiguration {
input: UpdateLoggingConfigurationRequest
output: UpdateLoggingConfigurationResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
LogDestinationPermissionException
ResourceNotFoundException
ThrottlingException
]
}
/// Updates the rule settings for the specified rule group. You use a rule group by
/// reference in one or more firewall policies. When you modify a rule group, you modify all
/// firewall policies that use the rule group.
/// To update a rule group, first call DescribeRuleGroup to retrieve the
/// current RuleGroup object, update the object as needed, and then provide
/// the updated object to this call.
operation UpdateRuleGroup {
input: UpdateRuleGroupRequest
output: UpdateRuleGroupResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
///
operation UpdateSubnetChangeProtection {
input: UpdateSubnetChangeProtectionRequest
output: UpdateSubnetChangeProtectionResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ResourceOwnerCheckException
ThrottlingException
]
}
/// Updates the TLS inspection configuration settings for the specified TLS inspection configuration. You use a TLS inspection configuration by
/// reference in one or more firewall policies. When you modify a TLS inspection configuration, you modify all
/// firewall policies that use the TLS inspection configuration.
/// To update a TLS inspection configuration, first call DescribeTLSInspectionConfiguration to retrieve the
/// current TLSInspectionConfiguration object, update the object as needed, and then provide
/// the updated object to this call.
operation UpdateTLSInspectionConfiguration {
input: UpdateTLSInspectionConfigurationRequest
output: UpdateTLSInspectionConfigurationResponse
errors: [
InternalServerError
InvalidRequestException
InvalidTokenException
ResourceNotFoundException
ThrottlingException
]
}
/// A custom action to use in stateless rule actions settings. This is used in CustomAction.
structure ActionDefinition {
/// Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the
/// matching packet. This setting defines a CloudWatch dimension value to be published.
/// You can pair this custom action with any of the standard stateless rule actions. For
/// example, you could pair this in a rule action with the standard action that forwards the
/// packet for stateful inspection. Then, when a packet matches the rule, Network Firewall
/// publishes metrics for the packet and forwards it.
PublishMetricAction: PublishMetricAction
}
/// A single IP address specification. This is used in the MatchAttributes
/// source and destination specifications.
structure Address {
/// Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
/// Examples:
///
/// -
///
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
///
/// -
///
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
///
///
/// For more information about CIDR notation, see the Wikipedia entry Classless
/// Inter-Domain Routing.
@required
AddressDefinition: AddressDefinition
}
@input
structure AssociateFirewallPolicyRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
@required
FirewallPolicyArn: ResourceArn
}
@output
structure AssociateFirewallPolicyResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
FirewallPolicyArn: ResourceArn
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
}
@input
structure AssociateSubnetsRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The IDs of the subnets that you want to associate with the firewall.
@required
SubnetMappings: SubnetMappings
}
@output
structure AssociateSubnetsResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// The IDs of the subnets that are associated with the firewall.
SubnetMappings: SubnetMappings
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
}
/// The configuration and status for a single subnet that you've specified for use by the
/// Network Firewall firewall. This is part of the FirewallStatus.
structure Attachment {
/// The unique identifier of the subnet that you've specified to be used for a firewall
/// endpoint.
SubnetId: AzSubnet
/// The identifier of the firewall endpoint that Network Firewall has instantiated in the
/// subnet. You use this to identify the firewall endpoint in the VPC route tables, when you
/// redirect the VPC traffic through the endpoint.
EndpointId: EndpointId
/// The current status of the firewall endpoint in the subnet. This value reflects both the
/// instantiation of the endpoint in the VPC subnet and the sync states that are reported in
/// the Config settings. When this value is READY, the endpoint is
/// available and configured properly to handle network traffic. When the endpoint isn't
/// available for traffic, this value will reflect its state, for example
/// CREATING or DELETING.
Status: AttachmentStatus
/// If Network Firewall fails to create or delete the firewall endpoint in the subnet, it populates this with the reason for the error or failure and how to resolve it. A FAILED status indicates a non-recoverable state, and a ERROR status indicates an issue that you can fix. Depending on the error, it can take as many as 15 minutes to populate this field. For more information about the causes for failiure or errors and solutions available for this field, see Troubleshooting firewall endpoint failures in the Network Firewall Developer Guide.
StatusMessage: StatusMessage
}
/// The capacity usage summary of the resources used by the ReferenceSets in a firewall.
structure CapacityUsageSummary {
/// Describes the capacity usage of the CIDR blocks used by the IP set references in a firewall.
CIDRs: CIDRSummary
}
/// Summarizes the CIDR blocks used by the IP set references in a firewall. Network Firewall calculates the number of CIDRs by taking an aggregated count of all CIDRs used by the IP sets you are referencing.
structure CIDRSummary {
/// The number of CIDR blocks available for use by the IP set references in a firewall.
AvailableCIDRCount: CIDRCount
/// The number of CIDR blocks used by the IP set references in a firewall.
UtilizedCIDRCount: CIDRCount
/// The list of the IP set references used by a firewall.
IPSetReferences: IPSetMetadataMap
}
@input
structure CreateFirewallPolicyRequest {
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
@required
FirewallPolicyName: ResourceName
/// The rule groups and policy actions to use in the firewall policy.
@required
FirewallPolicy: FirewallPolicy
/// A description of the firewall policy.
Description: Description
/// The key:value pairs to associate with the resource.
Tags: TagList
/// Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
/// If set to TRUE, Network Firewall checks whether the request can run successfully,
/// but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
/// dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have
/// the required permissions to run the request and that your request parameters are valid.
/// If set to FALSE, Network Firewall makes the requested changes to your resources.
DryRun: Boolean = false
/// A complex type that contains settings for encryption of your firewall policy resources.
EncryptionConfiguration: EncryptionConfiguration
}
@output
structure CreateFirewallPolicyResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
/// To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
@required
FirewallPolicyResponse: FirewallPolicyResponse
}
@input
structure CreateFirewallRequest {
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
@required
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the FirewallPolicy that you want to
/// use for the firewall.
@required
FirewallPolicyArn: ResourceArn
/// The unique identifier of the VPC where Network Firewall should create the firewall.
/// You can't change this setting after you create the firewall.
@required
VpcId: VpcId
/// The public subnets to use for your Network Firewall firewalls. Each subnet must belong to a
/// different Availability Zone in the VPC. Network Firewall creates a firewall endpoint in each
/// subnet.
@required
SubnetMappings: SubnetMappings
/// A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates
/// that the firewall is protected against deletion. Use this setting to protect against
/// accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
DeleteProtection: Boolean = false
/// A setting indicating whether the firewall is protected against changes to the subnet associations.
/// Use this setting to protect against
/// accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
SubnetChangeProtection: Boolean = false
/// A setting indicating whether the firewall is protected against a change to the firewall policy association.
/// Use this setting to protect against
/// accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection: Boolean = false
/// A description of the firewall.
Description: Description
/// The key:value pairs to associate with the resource.
Tags: TagList
/// A complex type that contains settings for encryption of your firewall resources.
EncryptionConfiguration: EncryptionConfiguration
}
@output
structure CreateFirewallResponse {
/// The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
Firewall: Firewall
/// Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
FirewallStatus: FirewallStatus
}
@input
structure CreateRuleGroupRequest {
/// The descriptive name of the rule group. You can't change the name of a rule group after you create it.
@required
RuleGroupName: ResourceName
/// An object that defines the rule group rules.
///
/// You must provide either this rule group setting or a Rules setting, but not both.
///
RuleGroup: RuleGroup
/// A string containing stateful rule group rules specifications in Suricata flat format, with one rule
/// per line. Use this to import your existing Suricata compatible rule groups.
///
/// You must provide either this rules setting or a populated RuleGroup setting, but not both.
///
/// You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call
/// response returns a RuleGroup object that Network Firewall has populated from your string.
Rules: RulesString
/// 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.
@required
Type: RuleGroupType
/// A description of the rule group.
Description: Description
/// 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.
///
/// You can't change or exceed this capacity when you update the rule group, so leave
/// room for your rule group to grow.
///
///
/// Capacity for a stateless rule group
///
/// For a stateless rule group, the capacity required is the sum of the capacity
/// requirements of the individual rules that you expect to have in the rule group.
/// To calculate the capacity requirement of a single rule, multiply the capacity
/// requirement values of each of the rule's match settings:
///
/// -
///
A match setting with no criteria specified has a value of 1.
///
/// -
///
A match setting with Any specified has a value of 1.
///
/// -
///
All other match settings have a value equal to the number of elements provided in
/// the setting. For example, a protocol setting ["UDP"] and a source setting
/// ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value
/// of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
///
///
///
/// A rule with no criteria specified in any of its match settings has a capacity
/// requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting
/// ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification
/// for each of the other match settings has a capacity requirement of 6.
///
/// Capacity for a stateful rule group
///
/// For
/// a stateful rule group, the minimum capacity required is the number of individual rules that
/// you expect to have in the rule group.
@required
Capacity: RuleCapacity
/// The key:value pairs to associate with the resource.
Tags: TagList
/// Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
/// If set to TRUE, Network Firewall checks whether the request can run successfully,
/// but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
/// dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have
/// the required permissions to run the request and that your request parameters are valid.
/// If set to FALSE, Network Firewall makes the requested changes to your resources.
DryRun: Boolean = false
/// A complex type that contains settings for encryption of your rule group resources.
EncryptionConfiguration: EncryptionConfiguration
/// A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
SourceMetadata: SourceMetadata
}
@output
structure CreateRuleGroupResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
/// To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// 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.
@required
RuleGroupResponse: RuleGroupResponse
}
@input
structure CreateTLSInspectionConfigurationRequest {
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
@required
TLSInspectionConfigurationName: ResourceName
/// The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
/// Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
/// To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS
/// inspection configurations in the Network Firewall Developer Guide.
@required
TLSInspectionConfiguration: TLSInspectionConfiguration
/// A description of the TLS inspection configuration.
Description: Description
/// The key:value pairs to associate with the resource.
Tags: TagList
EncryptionConfiguration: EncryptionConfiguration
}
@output
structure CreateTLSInspectionConfigurationResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
/// To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
@required
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse
}
/// An optional, non-standard action to use for stateless packet handling. You can define
/// this in addition to the standard action that you must specify.
/// You define and name the custom actions that you want to be able to use, and then you
/// reference them by name in your actions settings.
/// You can use custom actions in the following places:
///
/// -
///
In a rule group's StatelessRulesAndCustomActions specification.
/// The custom actions are available for use by name inside the
/// StatelessRulesAndCustomActions where you define them. You can use
/// them for your stateless rule actions to specify what to do with a packet that matches
/// the rule's match attributes.
///
/// -
///
In a FirewallPolicy specification, in
/// StatelessCustomActions. The custom actions are available for use
/// inside the policy where you define them. You can use them for the policy's default
/// stateless actions settings to specify what to do with packets that don't match any of
/// the policy's stateless rules.
///
///
structure CustomAction {
/// The descriptive name of the custom action. You can't change the name of a custom action after you create it.
@required
ActionName: ActionName
/// The custom action associated with the action name.
@required
ActionDefinition: ActionDefinition
}
@input
structure DeleteFirewallPolicyRequest {
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyArn: ResourceArn
}
@output
structure DeleteFirewallPolicyResponse {
/// The object containing the definition of the FirewallPolicyResponse
/// that you asked to delete.
@required
FirewallPolicyResponse: FirewallPolicyResponse
}
@input
structure DeleteFirewallRequest {
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
}
@output
structure DeleteFirewallResponse {
Firewall: Firewall
FirewallStatus: FirewallStatus
}
@input
structure DeleteResourcePolicyRequest {
/// The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to delete.
@required
ResourceArn: ResourceArn
}
@output
structure DeleteResourcePolicyResponse {}
@input
structure DeleteRuleGroupRequest {
/// 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: ResourceName
/// The Amazon Resource Name (ARN) of the rule group.
/// You must specify the ARN or the name, and you can specify both.
RuleGroupArn: ResourceArn
/// 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.
///
Type: RuleGroupType
}
@output
structure DeleteRuleGroupResponse {
/// 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.
@required
RuleGroupResponse: RuleGroupResponse
}
@input
structure DeleteTLSInspectionConfigurationRequest {
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
/// You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationArn: ResourceArn
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
/// You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName: ResourceName
}
@output
structure DeleteTLSInspectionConfigurationResponse {
/// The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
@required
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse
}
@input
structure DescribeFirewallPolicyRequest {
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyArn: ResourceArn
}
@output
structure DescribeFirewallPolicyResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
/// To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
@required
FirewallPolicyResponse: FirewallPolicyResponse
/// The policy for the specified firewall policy.
FirewallPolicy: FirewallPolicy
}
@input
structure DescribeFirewallRequest {
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
}
@output
structure DescribeFirewallResponse {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The configuration settings for the firewall. These settings include the firewall policy and the subnets in your VPC to use for the firewall endpoints.
Firewall: Firewall
/// Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
FirewallStatus: FirewallStatus
}
@input
structure DescribeLoggingConfigurationRequest {
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
}
@output
structure DescribeLoggingConfigurationResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
LoggingConfiguration: LoggingConfiguration
}
@input
structure DescribeResourcePolicyRequest {
/// The Amazon Resource Name (ARN) of the rule group or firewall policy whose resource policy you want to retrieve.
@required
ResourceArn: ResourceArn
}
@output
structure DescribeResourcePolicyResponse {
/// The IAM policy for the resource.
Policy: PolicyString
}
@input
structure DescribeRuleGroupMetadataRequest {
/// 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: ResourceName
/// 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.
RuleGroupArn: ResourceArn
/// 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.
///
Type: RuleGroupType
}
@output
structure DescribeRuleGroupMetadataResponse {
/// 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.
@required
RuleGroupArn: ResourceArn
/// 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.
@required
RuleGroupName: ResourceName
/// Returns the metadata objects for the specified rule group.
///
Description: Description
/// 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.
///
Type: RuleGroupType
/// 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.
Capacity: RuleCapacity
StatefulRuleOptions: StatefulRuleOptions
/// The last time that the rule group was changed.
LastModifiedTime: LastUpdateTime
}
@input
structure DescribeRuleGroupRequest {
/// 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: ResourceName
/// The Amazon Resource Name (ARN) of the rule group.
/// You must specify the ARN or the name, and you can specify both.
RuleGroupArn: ResourceArn
/// 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.
///
Type: RuleGroupType
}
@output
structure DescribeRuleGroupResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
/// To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
/// Network Firewall uses a rule group to inspect and control network traffic.
/// You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their
/// traffic flow.
/// To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from
/// more than one firewall policy, and you can use a firewall policy in more than one firewall.
RuleGroup: RuleGroup
/// 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.
@required
RuleGroupResponse: RuleGroupResponse
}
@input
structure DescribeTLSInspectionConfigurationRequest {
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
/// You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationArn: ResourceArn
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
/// You must specify the ARN or the name, and you can specify both.
TLSInspectionConfigurationName: ResourceName
}
@output
structure DescribeTLSInspectionConfigurationResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
/// To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
/// Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
/// To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS
/// inspection configurations in the Network Firewall Developer Guide.
TLSInspectionConfiguration: TLSInspectionConfiguration
/// The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
@required
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse
}
/// The value to use in an Amazon CloudWatch custom metric dimension. This is used in the
/// PublishMetrics
/// CustomAction. A CloudWatch custom metric dimension is a name/value pair that's
/// part of the identity of a metric.
/// Network Firewall sets the dimension name to CustomAction and you provide the
/// dimension value.
/// For more information about CloudWatch custom metric dimensions, see Publishing Custom Metrics in the Amazon CloudWatch User
/// Guide.
structure Dimension {
/// The value to use in the custom metric dimension.
@required
Value: DimensionValue
}
@input
structure DisassociateSubnetsRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The unique identifiers for the subnets that you want to disassociate.
@required
SubnetIds: AzSubnets
}
@output
structure DisassociateSubnetsResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// The IDs of the subnets that are associated with the firewall.
SubnetMappings: SubnetMappings
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
}
/// A complex type that contains optional Amazon Web Services Key Management Service (KMS) encryption settings for your Network Firewall resources. Your data is encrypted by default with an Amazon Web Services owned key that Amazon Web Services owns and manages for you. You can use either the Amazon Web Services owned key, or provide your own customer managed key. To learn more about KMS encryption of your Network Firewall resources, see Encryption at rest with Amazon Web Services Key Managment Service in the Network Firewall Developer Guide.
structure EncryptionConfiguration {
/// The ID of the Amazon Web Services Key Management Service (KMS) customer managed key. You can use any of the key identifiers that KMS supports, unless you're using a key that's managed by another account. If you're using a key managed by another account, then specify the key ARN. For more information, see Key ID in the Amazon Web Services KMS Developer Guide.
KeyId: KeyId
/// The type of Amazon Web Services KMS key to use for encryption of your Network Firewall resources.
@required
Type: EncryptionType
}
/// The firewall defines the configuration settings for an Network Firewall firewall. These settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall Amazon Web Services resource.
/// The status of the firewall, for example whether it's ready to filter network traffic,
/// is provided in the corresponding FirewallStatus. You can retrieve both
/// objects by calling DescribeFirewall.
structure Firewall {
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The Amazon Resource Name (ARN) of the firewall policy.
/// The relationship of firewall to firewall policy is many to one. Each firewall requires
/// one firewall policy association, and you can use the same firewall policy for multiple
/// firewalls.
@required
FirewallPolicyArn: ResourceArn
/// The unique identifier of the VPC where the firewall is in use.
@required
VpcId: VpcId
/// The public subnets that Network Firewall is using for the firewall. Each subnet must belong
/// to a different Availability Zone.
@required
SubnetMappings: SubnetMappings
/// A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates
/// that the firewall is protected against deletion. Use this setting to protect against
/// accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
DeleteProtection: Boolean = false
/// A setting indicating whether the firewall is protected against changes to the subnet associations.
/// Use this setting to protect against
/// accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
SubnetChangeProtection: Boolean = false
/// A setting indicating whether the firewall is protected against a change to the firewall policy association.
/// Use this setting to protect against
/// accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection: Boolean = false
/// A description of the firewall.
Description: Description
/// The unique identifier for the firewall.
@required
FirewallId: ResourceId
///
Tags: TagList
/// A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall.
EncryptionConfiguration: EncryptionConfiguration
}
/// High-level information about a firewall, returned by operations like create and
/// describe. You can use the information provided in the metadata to retrieve and manage a
/// firewall.
structure FirewallMetadata {
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
}
/// The firewall policy defines the behavior of a firewall using a collection of stateless
/// and stateful rule groups and other settings. You can use one firewall policy for multiple
/// firewalls.
/// This, along with FirewallPolicyResponse, define the policy.
/// You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
structure FirewallPolicy {
/// References to the stateless rule groups that are used in the policy. These define the
/// matching criteria in stateless rules.
StatelessRuleGroupReferences: StatelessRuleGroupReferences
/// The actions to take on a packet if it doesn't match any of the stateless rules in the
/// policy. If you want non-matching packets to be forwarded for stateful inspection, specify
/// aws:forward_to_sfe.
/// You must specify one of the standard actions: aws:pass,
/// aws:drop, or aws:forward_to_sfe. In addition, you can specify
/// custom actions that are compatible with your standard section choice.
/// For example, you could specify ["aws:pass"] or you could specify
/// ["aws:pass", “customActionName”]. For information about compatibility, see
/// the custom action descriptions under CustomAction.
@required
StatelessDefaultActions: StatelessActions
/// The actions to take on a fragmented UDP packet if it doesn't match any of the stateless
/// rules in the policy. Network Firewall only manages UDP packet fragments and silently drops packet fragments for other protocols.
/// If you want non-matching fragmented UDP packets to be forwarded for
/// stateful inspection, specify aws:forward_to_sfe.
/// You must specify one of the standard actions: aws:pass,
/// aws:drop, or aws:forward_to_sfe. In addition, you can specify
/// custom actions that are compatible with your standard section choice.
/// For example, you could specify ["aws:pass"] or you could specify
/// ["aws:pass", “customActionName”]. For information about compatibility, see
/// the custom action descriptions under CustomAction.
@required
StatelessFragmentDefaultActions: StatelessActions
/// The custom action definitions that are available for use in the firewall policy's
/// StatelessDefaultActions setting. You name each custom action that you
/// define, and then you can use it by name in your default actions specifications.
StatelessCustomActions: CustomActions
/// References to the stateful rule groups that are used in the policy. These define the
/// inspection criteria in stateful rules.
StatefulRuleGroupReferences: StatefulRuleGroupReferences
/// The default actions to take on a packet that doesn't match any stateful rules. The stateful default action is optional,
/// and is only valid when using the strict rule order.
/// Valid values of the stateful default action:
///
/// -
///
aws:drop_strict
///
/// -
///
aws:drop_established
///
/// -
///
aws:alert_strict
///
/// -
///
aws:alert_established
///
///
/// For more information, see
/// Strict evaluation order in the Network Firewall Developer Guide.
///
StatefulDefaultActions: StatefulActions
/// Additional options governing how Network Firewall handles stateful rules. The stateful
/// rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings.
StatefulEngineOptions: StatefulEngineOptions
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationArn: ResourceArn
/// Contains variables that you can use to override default Suricata settings in your firewall policy.
PolicyVariables: PolicyVariables
}
/// High-level information about a firewall policy, returned by operations like create and
/// describe. You can use the information provided in the metadata to retrieve and manage a
/// firewall policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
structure FirewallPolicyMetadata {
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
Name: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
Arn: ResourceArn
}
/// The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
structure FirewallPolicyResponse {
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
@required
FirewallPolicyName: ResourceName
/// The Amazon Resource Name (ARN) of the firewall policy.
///
/// 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.
///
@required
FirewallPolicyArn: ResourceArn
/// The unique identifier for the firewall policy.
@required
FirewallPolicyId: ResourceId
/// A description of the firewall policy.
Description: Description
/// The current status of the firewall policy. You can retrieve this for a firewall policy
/// by calling DescribeFirewallPolicy and providing the firewall policy's
/// name or ARN.
FirewallPolicyStatus: ResourceStatus
/// The key:value pairs to associate with the resource.
Tags: TagList
/// The number of capacity units currently consumed by the policy's stateless rules.
ConsumedStatelessRuleCapacity: RuleCapacity
/// The number of capacity units currently consumed by the policy's stateful rules.
ConsumedStatefulRuleCapacity: RuleCapacity
/// The number of firewalls that are associated with this firewall policy.
NumberOfAssociations: NumberOfAssociations
/// A complex type that contains the Amazon Web Services KMS encryption configuration settings for your firewall policy.
EncryptionConfiguration: EncryptionConfiguration
/// The last time that the firewall policy was changed.
LastModifiedTime: LastUpdateTime
}
/// Detailed information about the current status of a Firewall. You can retrieve this for a firewall by calling DescribeFirewall and providing the firewall name and ARN.
structure FirewallStatus {
/// The readiness of the configured firewall to handle network traffic across all of the
/// Availability Zones where you've configured it. This setting is READY only when
/// the ConfigurationSyncStateSummary value is IN_SYNC and the
/// Attachment
/// Status values for all of the configured subnets are READY.
///
@required
Status: FirewallStatusValue
/// The configuration sync state for the firewall. This summarizes the sync states reported
/// in the Config settings for all of the Availability Zones where you have
/// configured the firewall.
/// When you create a firewall or update its configuration, for example by adding a rule
/// group to its firewall policy, Network Firewall distributes the configuration changes to all
/// zones where the firewall is in use. This summary indicates whether the configuration
/// changes have been applied everywhere.
/// This status must be IN_SYNC for the firewall to be ready for use, but it
/// doesn't indicate that the firewall is ready. The Status setting indicates
/// firewall readiness.
@required
ConfigurationSyncStateSummary: ConfigurationSyncState
/// The subnets that you've configured for use by the Network Firewall firewall. This contains
/// one array element per Availability Zone where you've configured a subnet. These objects
/// provide details of the information that is summarized in the
/// ConfigurationSyncStateSummary and Status, broken down by zone
/// and configuration object.
SyncStates: SyncStates
/// Describes the capacity usage of the resources contained in a firewall's reference sets. Network Firewall calclulates the capacity usage by taking an aggregated count of all of the resources used by all of the reference sets in a firewall.
CapacityUsageSummary: CapacityUsageSummary
}
/// The basic rule criteria for Network Firewall to use to inspect packet headers in stateful
/// traffic flow inspection. Traffic flows that match the criteria are a match for the
/// corresponding StatefulRule.
structure Header {
/// The protocol to inspect for. To specify all, you can use IP, because all traffic on Amazon Web Services and on the internet is IP.
@required
Protocol: StatefulRuleProtocol
/// The source IP address or address range to inspect for, in CIDR notation.
/// To match with any address, specify ANY.
/// Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
/// Examples:
///
/// -
///
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
///
/// -
///
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
///
///
/// For more information about CIDR notation, see the Wikipedia entry Classless
/// Inter-Domain Routing.
@required
Source: Source
/// The source port to inspect for. You can specify an individual port, for
/// example 1994 and you can specify a port
/// range, for example 1990:1994.
/// To match with any port, specify ANY.
@required
SourcePort: Port
/// The direction of traffic flow to inspect. If set to ANY, the inspection
/// matches bidirectional traffic, both from the source to the destination and from the
/// destination to the source. If set to FORWARD, the inspection only matches
/// traffic going from the source to the destination.
@required
Direction: StatefulRuleDirection
/// The destination IP address or address range to inspect for, in CIDR notation.
/// To match with any address, specify ANY.
/// Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6.
/// Examples:
///
/// -
///
To configure Network Firewall to inspect for the IP address 192.0.2.44, specify 192.0.2.44/32.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
///
/// -
///
To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
///
/// -
///
To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
///
///
/// For more information about CIDR notation, see the Wikipedia entry Classless
/// Inter-Domain Routing.
@required
Destination: Destination
/// The destination port to inspect for. You can specify an individual port, for
/// example 1994 and you can specify
/// a port range, for example 1990:1994.
/// To match with any port, specify ANY.
@required
DestinationPort: Port
}
/// Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your
/// request later.
@error("server")
structure InsufficientCapacityException {
Message: ErrorMessage
}
/// Your request is valid, but Network Firewall couldn’t perform the operation because of a
/// system problem. Retry your request.
@error("server")
structure InternalServerError {
Message: ErrorMessage
}
/// The operation failed because it's not valid. For example, you might have tried to delete
/// a rule group or firewall policy that's in use.
@error("client")
structure InvalidOperationException {
Message: ErrorMessage
}
/// The operation failed because of a problem with your request. Examples include:
///
/// -
///
You specified an unsupported parameter name or value.
///
/// -
///
You tried to update a property with a value that isn't among the available
/// types.
///
/// -
///
Your request references an ARN that is malformed, or corresponds to a resource
/// that isn't valid in the context of the request.
///
///
@error("client")
structure InvalidRequestException {
Message: ErrorMessage
}
/// The policy statement failed validation.
@error("client")
structure InvalidResourcePolicyException {
Message: ErrorMessage
}
/// The token you provided is stale or isn't valid for the operation.
@error("client")
structure InvalidTokenException {
Message: ErrorMessage
}
/// A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.
structure IPSet {
/// The list of IP addresses and address ranges, in CIDR notation.
///
///
@required
Definition: VariableDefinitionList
}
/// General information about the IP set.
structure IPSetMetadata {
/// Describes the total number of CIDR blocks currently in use by the IP set references in a firewall. To determine how many CIDR blocks are available for you to use in a firewall, you can call AvailableCIDRCount.
ResolvedCIDRCount: CIDRCount
}
/// Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references in the Network Firewall Developer Guide.
///
/// Network Firewall currently supports Amazon VPC prefix lists and resource groups in IP set references.
///
structure IPSetReference {
/// The Amazon Resource Name (ARN) of the resource that you are referencing in your rule group.
ReferenceArn: ResourceArn
}
/// Unable to perform the operation because doing so would violate a limit setting.
@error("client")
structure LimitExceededException {
Message: ErrorMessage
}
@input
structure ListFirewallPoliciesRequest {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The maximum number of objects that you want Network Firewall to return for this request. If more
/// objects are available, in the response, Network Firewall provides a
/// NextToken value that you can use in a subsequent call to get the next batch of objects.
MaxResults: PaginationMaxResults
}
@output
structure ListFirewallPoliciesResponse {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The metadata for the firewall policies. Depending on your setting for max results and
/// the number of firewall policies that you have, this might not be the full list.
FirewallPolicies: FirewallPolicies
}
@input
structure ListFirewallsRequest {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The unique identifiers of the VPCs that you want Network Firewall to retrieve the firewalls
/// for. Leave this blank to retrieve all firewalls that you have defined.
VpcIds: VpcIds
/// The maximum number of objects that you want Network Firewall to return for this request. If more
/// objects are available, in the response, Network Firewall provides a
/// NextToken value that you can use in a subsequent call to get the next batch of objects.
MaxResults: PaginationMaxResults
}
@output
structure ListFirewallsResponse {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The firewall metadata objects for the VPCs that you specified. Depending on your setting
/// for max results and the number of firewalls you have, a single call might not be the full
/// list.
Firewalls: Firewalls
}
@input
structure ListRuleGroupsRequest {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The maximum number of objects that you want Network Firewall to return for this request. If more
/// objects are available, in the response, Network Firewall provides a
/// NextToken value that you can use in a subsequent call to get the next batch of objects.
MaxResults: PaginationMaxResults
/// The scope of the request. The default setting of ACCOUNT or a setting of
/// NULL returns all of the rule groups in your account. A setting of
/// MANAGED returns all available managed rule groups.
Scope: ResourceManagedStatus
/// Indicates the general category of the Amazon Web Services managed rule group.
ManagedType: ResourceManagedType
/// 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.
Type: RuleGroupType
}
@output
structure ListRuleGroupsResponse {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The rule group metadata objects that you've defined. Depending on your setting for max
/// results and the number of rule groups, this might not be the full list.
RuleGroups: RuleGroups
}
@input
structure ListTagsForResourceRequest {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The maximum number of objects that you want Network Firewall to return for this request. If more
/// objects are available, in the response, Network Firewall provides a
/// NextToken value that you can use in a subsequent call to get the next batch of objects.
MaxResults: TagsPaginationMaxResults
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: ResourceArn
}
@output
structure ListTagsForResourceResponse {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The tags that are associated with the resource.
Tags: TagList
}
@input
structure ListTLSInspectionConfigurationsRequest {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The maximum number of objects that you want Network Firewall to return for this request. If more
/// objects are available, in the response, Network Firewall provides a
/// NextToken value that you can use in a subsequent call to get the next batch of objects.
MaxResults: PaginationMaxResults
}
@output
structure ListTLSInspectionConfigurationsResponse {
/// When you request a list of objects with a MaxResults setting, if the number of objects that are still available
/// for retrieval exceeds the maximum you requested, Network Firewall returns a NextToken
/// value in the response. To retrieve the next batch of objects, use the token returned from the prior request in your next request.
NextToken: PaginationToken
/// The TLS inspection configuration metadata objects that you've defined. Depending on your setting for max results and the number of TLS inspection configurations, this might not be the full list.
TLSInspectionConfigurations: TLSInspectionConfigurations
}
/// Defines where Network Firewall sends logs for the firewall for one log type. This is used
/// in LoggingConfiguration. You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
/// Network Firewall generates logs for stateful rule groups. You can save alert and flow log
/// types. The stateful rules engine records flow logs for all network traffic that it receives.
/// It records alert logs for traffic that matches stateful rules that have the rule
/// action set to DROP or ALERT.
structure LogDestinationConfig {
/// The type of log to send. Alert logs report traffic that matches a StatefulRule with an action setting that sends an alert log message. Flow logs are
/// standard network traffic flow logs.
@required
LogType: LogType
/// The type of storage destination to send these logs to. You can send logs to an Amazon S3 bucket,
/// a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
@required
LogDestinationType: LogDestinationType
/// The named location for the logs, provided in a key:value mapping that is specific to the
/// chosen destination type.
///
/// -
///
For an Amazon S3 bucket, provide the name of the bucket, with key bucketName,
/// and optionally provide a prefix, with key prefix. The following example
/// specifies an Amazon S3 bucket named
/// DOC-EXAMPLE-BUCKET and the prefix alerts:
///
/// "LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts"
/// }
///
///
/// -
///
For a CloudWatch log group, provide the name of the CloudWatch log group, with key
/// logGroup. The following example specifies a log group named
/// alert-log-group:
///
/// "LogDestination": { "logGroup": "alert-log-group" }
///
///
/// -
///
For a Kinesis Data Firehose delivery stream, provide the name of the delivery stream, with key
/// deliveryStream. The following example specifies a delivery stream
/// named alert-delivery-stream:
///
/// "LogDestination": { "deliveryStream": "alert-delivery-stream"
/// }
///
///
///
@required
LogDestination: LogDestinationMap
}
/// Unable to send logs to a configured logging destination.
@error("client")
structure LogDestinationPermissionException {
Message: ErrorMessage
}
/// Defines how Network Firewall performs logging for a Firewall.
structure LoggingConfiguration {
/// Defines the logging destinations for the logs for a firewall. Network Firewall generates
/// logs for stateful rule groups.
@required
LogDestinationConfigs: LogDestinationConfigs
}
/// Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
structure MatchAttributes {
/// The source IP addresses and address ranges to inspect for, in CIDR notation. If not
/// specified, this matches with any source address.
Sources: Addresses
/// The destination IP addresses and address ranges to inspect for, in CIDR notation. If not
/// specified, this matches with any destination address.
Destinations: Addresses
/// The source ports to inspect for. If not specified, this matches with any source port.
/// This setting is only used for protocols 6 (TCP) and 17 (UDP).
/// You can specify individual ports, for example 1994 and you can specify port
/// ranges, for example 1990:1994.
SourcePorts: PortRanges
/// The destination ports to inspect for. If not specified, this matches with any
/// destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP).
/// You can specify individual ports, for example 1994 and you can specify port
/// ranges, for example 1990:1994.
DestinationPorts: PortRanges
/// The protocols to inspect for, specified using each protocol's assigned internet protocol
/// number (IANA). If not specified, this matches with any protocol.
Protocols: ProtocolNumbers
/// The TCP flags and masks to inspect for. If not specified, this matches with any
/// settings. This setting is only used for protocol 6 (TCP).
TCPFlags: TCPFlags
}
/// Provides configuration status for a single policy or rule group that is used for a firewall endpoint. Network Firewall
/// provides each endpoint with the rules that are configured in the firewall policy. Each time
/// you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the
/// rules in the endpoint, so it can properly filter network traffic. This is part of a SyncState for a firewall.
structure PerObjectStatus {
/// Indicates whether this object is in sync with the version indicated in the update token.
SyncStatus: PerObjectSyncStatus
/// The current version of the object that is either in sync or pending synchronization.
UpdateToken: UpdateToken
}
/// Contains variables that you can use to override default Suricata settings in your firewall policy.
structure PolicyVariables {
/// The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata HOME_NET variable. If your firewall uses an inspection VPC, you might want to override the HOME_NET variable with the CIDRs of your home networks. If you don't override HOME_NET with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC.
RuleVariables: IPSets
}
/// A single port range specification. This is used for source and destination port ranges
/// in the stateless rule MatchAttributes, SourcePorts, and
/// DestinationPorts settings.
structure PortRange {
/// The lower limit of the port range. This must be less than or equal to the
/// ToPort specification.
@required
FromPort: PortRangeBound = 0
/// The upper limit of the port range. This must be greater than or equal to the
/// FromPort specification.
@required
ToPort: PortRangeBound = 0
}
/// A set of port ranges for use in the rules in a rule group.
structure PortSet {
/// The set of port ranges.
///
Definition: VariableDefinitionList
}
/// Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the
/// matching packet. This setting defines a CloudWatch dimension value to be published.
structure PublishMetricAction {
///
@required
Dimensions: Dimensions
}
@input
structure PutResourcePolicyRequest {
/// The Amazon Resource Name (ARN) of the account that you want to share rule groups and firewall policies with.
@required
ResourceArn: ResourceArn
/// The IAM policy statement that lists the accounts that you want to share your rule group or firewall policy with
/// and the operations that you want the accounts to be able to perform.
/// For a rule group resource, you can specify the following operations in the Actions section of the statement:
///
/// -
///
network-firewall:CreateFirewallPolicy
///
/// -
///
network-firewall:UpdateFirewallPolicy
///
/// -
///
network-firewall:ListRuleGroups
///
///
/// For a firewall policy resource, you can specify the following operations in the Actions section of the statement:
///
/// -
///
network-firewall:AssociateFirewallPolicy
///
/// -
///
network-firewall:ListFirewallPolicies
///
///
/// In the Resource section of the statement, you specify the ARNs for the rule groups and firewall policies that you want to share with the account that you specified in Arn.
@required
Policy: PolicyString
}
@output
structure PutResourcePolicyResponse {}
/// Contains a set of IP set references.
structure ReferenceSets {
/// The list of IP set references.
IPSetReferences: IPSetReferenceMap
}
/// Unable to locate a resource using the parameters that you provided.
@error("client")
structure ResourceNotFoundException {
Message: ErrorMessage
}
/// Unable to change the resource because your account doesn't own it.
@error("client")
structure ResourceOwnerCheckException {
Message: ErrorMessage
}
/// The inspection criteria and action for a single stateless rule. Network Firewall inspects each packet for the specified matching
/// criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on
/// the packet.
structure RuleDefinition {
/// Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
@required
MatchAttributes: MatchAttributes
/// The actions to take on a packet that matches one of the stateless rule definition's
/// match attributes. You must specify a standard action and you can add custom actions.
///
/// Network Firewall only forwards a packet for stateful rule inspection if you specify
/// aws:forward_to_sfe for a rule that the packet matches, or if the packet
/// doesn't match any stateless rule and you specify aws:forward_to_sfe for the
/// StatelessDefaultActions setting for the FirewallPolicy.
///
/// For every rule, you must specify exactly one of the following standard actions.
///
/// -
///
/// aws:pass - Discontinues all inspection of
/// the packet and permits it to go to its intended destination.
///
/// -
///
/// aws:drop - Discontinues all inspection of
/// the packet and blocks it from going to its intended destination.
///
/// -
///
/// aws:forward_to_sfe - Discontinues
/// stateless inspection of the packet and forwards it to the stateful rule engine for
/// inspection.
///
///
/// Additionally, you can specify a custom action.
/// To
/// do this, you define a custom action by name and type, then provide the name you've assigned
/// to the action in this Actions setting. For information about the options, see
/// CustomAction.
/// To provide more than one action in this setting, separate the settings with a comma. For
/// example, if you have a custom PublishMetrics action that you've named
/// MyMetricsAction, then you could specify the standard action
/// aws:pass and the custom action with [“aws:pass”,
/// “MyMetricsAction”].
@required
Actions: StatelessActions
}
/// The object that defines the rules in a rule group. This, along with RuleGroupResponse, define the rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
/// Network Firewall uses a rule group to inspect and control network traffic.
/// You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their
/// traffic flow.
/// To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from
/// more than one firewall policy, and you can use a firewall policy in more than one firewall.
structure RuleGroup {
/// Settings that are available for use in the rules in the rule group. You can only use
/// these for stateful rule groups.
RuleVariables: RuleVariables
/// The list of a rule group's reference sets.
ReferenceSets: ReferenceSets
/// The stateful rules or stateless rules for the rule group.
@required
RulesSource: RulesSource
/// Additional options governing how Network Firewall handles stateful rules. The policies where you use your stateful
/// rule group must have stateful rule options settings that are compatible with these settings.
StatefulRuleOptions: StatefulRuleOptions
}
/// High-level information about a rule group, returned by ListRuleGroups.
/// You can use the information provided in the metadata to retrieve and manage a
/// rule group.
structure RuleGroupMetadata {
/// The descriptive name of the rule group. You can't change the name of a rule group after you create it.
Name: ResourceName
/// The Amazon Resource Name (ARN) of the rule group.
Arn: ResourceArn
}
/// 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.
structure RuleGroupResponse {
/// 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.
///
@required
RuleGroupArn: ResourceArn
/// The descriptive name of the rule group. You can't change the name of a rule group after you create it.
@required
RuleGroupName: ResourceName
/// The unique identifier for the rule group.
@required
RuleGroupId: ResourceId
/// A description of the rule group.
Description: Description
/// 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.
Type: RuleGroupType
/// 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.
Capacity: RuleCapacity
/// Detailed information about the current status of a rule group.
RuleGroupStatus: ResourceStatus
/// The key:value pairs to associate with the resource.
Tags: TagList
/// The number of capacity units currently consumed by the rule group rules.
ConsumedCapacity: RuleCapacity
/// The number of firewall policies that use this rule group.
NumberOfAssociations: NumberOfAssociations
/// A complex type that contains the Amazon Web Services KMS encryption configuration settings for your rule group.
EncryptionConfiguration: EncryptionConfiguration
/// 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.
SourceMetadata: SourceMetadata
/// 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..
SnsTopic: ResourceArn
/// The last time that the rule group was changed.
LastModifiedTime: LastUpdateTime
}
/// Additional settings for a stateful rule. This is part of the StatefulRule configuration.
structure RuleOption {
/// The keyword for the Suricata compatible rule option. You must include a sid (signature ID), and can optionally include other keywords. For information about Suricata compatible keywords, see Rule options in the Suricata documentation.
@required
Keyword: Keyword
/// The settings of the Suricata compatible rule option. Rule options have zero or more setting values, and the number of possible and required settings depends on the Keyword. For more information about the settings for specific options, see Rule options.
Settings: Settings
}
/// The stateless or stateful rules definitions for use in a single rule group. Each rule
/// group requires a single RulesSource. You can use an instance of this for
/// either stateless rules or stateful rules.
structure RulesSource {
/// Stateful inspection criteria, provided in Suricata compatible intrusion prevention
/// system (IPS) rules. Suricata is an open-source network IPS that includes a standard
/// rule-based language for network traffic inspection.
/// These rules contain the inspection criteria and the action to take for traffic that
/// matches the criteria, so this type of rule group doesn't have a separate action
/// setting.
RulesString: RulesString
/// Stateful inspection criteria for a domain list rule group.
RulesSourceList: RulesSourceList
/// An array of individual stateful rules inspection criteria to be used together in a stateful rule group.
/// Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options.
/// For information about the Suricata Rules format, see
/// Rules Format.
StatefulRules: StatefulRules
/// Stateless inspection criteria to be used in a stateless rule group.
StatelessRulesAndCustomActions: StatelessRulesAndCustomActions
}
/// Stateful inspection criteria for a domain list rule group.
/// For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
/// By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the HOME_NET rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see RuleVariables in this guide and Stateful domain list rule groups in Network Firewall in the Network Firewall Developer Guide.
structure RulesSourceList {
/// The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:
///
/// -
///
Explicit names. For example, abc.example.com matches only the domain abc.example.com.
///
/// -
///
Names that use a domain wildcard, which you indicate with an initial '.'. For example,.example.com matches example.com and matches all subdomains of example.com, such as abc.example.com and www.example.com.
///
///
@required
Targets: RuleTargets
/// The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST for HTTP. You can specify either or both.
@required
TargetTypes: TargetTypes
/// Whether you want to allow or deny access to the domains in your target list.
@required
GeneratedRulesType: GeneratedRulesType
}
/// Settings that are available for use in the rules in the RuleGroup
/// where this is defined.
structure RuleVariables {
/// A list of IP addresses and address ranges, in CIDR notation.
IPSets: IPSets
/// A list of port ranges.
PortSets: PortSets
}
/// Any Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration used in a TLSInspectionConfiguration. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate or Importing certificates in the Certificate Manager User Guide.
structure ServerCertificate {
/// The Amazon Resource Name (ARN) of the Certificate Manager SSL/TLS server certificate.
ResourceArn: ResourceArn
}
/// Configures the associated Certificate Manager Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificates and scope settings Network Firewall uses to decrypt traffic in a TLSInspectionConfiguration. For information about working with SSL/TLS certificates for TLS inspection, see Requirements for using SSL/TLS server certficiates with TLS inspection configurations in the Network Firewall Developer Guide.
///
/// If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.
///
structure ServerCertificateConfiguration {
/// The list of a server certificate configuration's Certificate Manager SSL/TLS certificates.
ServerCertificates: ServerCertificates
/// A list of a server certificate configuration's scopes.
Scopes: ServerCertificateScopes
}
/// Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
structure ServerCertificateScope {
/// The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this
/// matches with any source address.
Sources: Addresses
/// The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. If not specified, this
/// matches with any destination address.
Destinations: Addresses
/// The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any source port.
/// You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.
SourcePorts: PortRanges
/// The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. If not specified, this matches with any destination port.
/// You can specify individual ports, for example 1994, and you can specify port ranges, such as 1990:1994.
DestinationPorts: PortRanges
/// The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number
/// (IANA). Network Firewall currently supports only TCP.
Protocols: ProtocolNumbers
}
/// High-level information about the managed rule group that your own rule group is copied from. You can use the the metadata to track version updates made to the originating rule group. You can retrieve all objects for a rule group by calling DescribeRuleGroup.
structure SourceMetadata {
/// The Amazon Resource Name (ARN) of the rule group that your own rule group is copied from.
SourceArn: ResourceArn
/// The update token of the Amazon Web Services managed rule group that your own rule group is copied from. To determine the update token for the managed rule group, call DescribeRuleGroup.
SourceUpdateToken: UpdateToken
}
/// Configuration settings for the handling of the stateful rule groups in a firewall policy.
structure StatefulEngineOptions {
/// Indicates how to manage the order of stateful rule evaluation for the policy. DEFAULT_ACTION_ORDER is
/// the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them
/// based on certain settings. For more information, see
/// Evaluation order for stateful rules in the Network Firewall Developer Guide.
///
RuleOrder: RuleOrder
/// Configures how Network Firewall processes traffic when a network connection breaks midstream. Network connections can break due to disruptions in external networks or within the firewall itself.
///
/// -
///
/// DROP - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior.
///
/// -
///
/// CONTINUE - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to drop http traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a flow:stateless rule would still match, as would the aws:drop_strict default action.
///
/// -
///
/// REJECT - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic.
///
///
StreamExceptionPolicy: StreamExceptionPolicy
}
/// A single Suricata rules specification, for use in a stateful rule group.
/// Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options.
/// For information about the Suricata Rules format, see
/// Rules Format.
structure StatefulRule {
/// Defines what Network Firewall should do with the packets in a traffic flow when the flow
/// matches the stateful rule criteria. For all actions, Network Firewall performs the specified
/// action and discontinues stateful inspection of the traffic flow.
/// The actions for a stateful rule are defined as follows:
///
/// -
///
/// PASS - Permits the packets to go to the
/// intended destination.
///
/// -
///
/// DROP - Blocks the packets from going to
/// the intended destination and sends an alert log message, if alert logging is configured in the Firewall
/// LoggingConfiguration.
///
/// -
///
/// ALERT - Permits the packets to go to the
/// intended destination and sends an alert log message, if alert logging is configured in the Firewall
/// LoggingConfiguration.
/// You can use this action to test a rule that you intend to use to drop traffic. You
/// can enable the rule with ALERT action, verify in the logs that the rule
/// is filtering as you want, then change the action to DROP.
///
///
@required
Action: StatefulAction
/// The stateful inspection criteria for this rule, used to inspect traffic flows.
///
@required
Header: Header
/// Additional options for the rule. These are the Suricata RuleOptions settings.
@required
RuleOptions: RuleOptions
}
/// The setting that allows the policy owner to change the behavior of the rule group within a policy.
structure StatefulRuleGroupOverride {
/// The action that changes the rule group from DROP to ALERT. This only applies to
/// managed rule groups.
Action: OverrideAction
}
/// Identifier for a single stateful rule group, used in a firewall policy to refer to a
/// rule group.
structure StatefulRuleGroupReference {
/// The Amazon Resource Name (ARN) of the stateful rule group.
@required
ResourceArn: ResourceArn
/// An integer setting that indicates the order in which to run the stateful rule groups in
/// a single FirewallPolicy. This setting only applies to firewall policies
/// that specify the STRICT_ORDER rule order in the stateful engine options settings.
/// Network Firewall evalutes each stateful rule group
/// against a packet starting with the group that has the lowest priority setting. You must ensure
/// that the priority settings are unique within each policy.
/// You can change the priority settings of your rule groups at any time. To make it easier to
/// insert rule groups later, number them so there's a wide range in between, for example use 100,
/// 200, and so on.
Priority: Priority = null
/// The action that allows the policy owner to override the behavior of the rule group within a policy.
Override: StatefulRuleGroupOverride
}
/// Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.
structure StatefulRuleOptions {
/// Indicates how to manage the order of the rule evaluation for the rule group. DEFAULT_ACTION_ORDER is
/// the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them
/// based on certain settings. For more information, see
/// Evaluation order for stateful rules in the Network Firewall Developer Guide.
///
RuleOrder: RuleOrder
}
/// A single stateless rule. This is used in StatelessRulesAndCustomActions.
structure StatelessRule {
/// Defines the stateless 5-tuple packet inspection criteria and the action to take on a
/// packet that matches the criteria.
@required
RuleDefinition: RuleDefinition
/// Indicates the order in which to run this rule relative to all of the
/// rules that are defined for a stateless rule group. Network Firewall evaluates the rules in a
/// rule group starting with the lowest priority setting. You must ensure that the priority
/// settings are unique for the rule group.
/// Each stateless rule group uses exactly one StatelessRulesAndCustomActions
/// object, and each StatelessRulesAndCustomActions contains exactly one
/// StatelessRules object. To ensure unique priority settings for your rule
/// groups, set unique priorities for the stateless rules that you define inside any single
/// StatelessRules object.
/// You can change the priority settings of your rules at any time. To make it easier to
/// insert rules later, number them so there's a wide range in between, for example use 100,
/// 200, and so on.
@required
Priority: Priority = 0
}
/// Identifier for a single stateless rule group, used in a firewall policy to refer to the
/// rule group.
structure StatelessRuleGroupReference {
/// The Amazon Resource Name (ARN) of the stateless rule group.
@required
ResourceArn: ResourceArn
/// An integer setting that indicates the order in which to run the stateless rule groups in
/// a single FirewallPolicy. Network Firewall applies each stateless rule group
/// to a packet starting with the group that has the lowest priority setting. You must ensure
/// that the priority settings are unique within each policy.
@required
Priority: Priority = 0
}
/// Stateless inspection criteria. Each stateless rule group uses exactly one of these data
/// types to define its stateless rules.
structure StatelessRulesAndCustomActions {
/// Defines the set of stateless rules for use in a stateless rule group.
@required
StatelessRules: StatelessRules
/// Defines an array of individual custom action definitions that are available for use by
/// the stateless rules in this StatelessRulesAndCustomActions specification. You
/// name each custom action that you define, and then you can use it by name in your StatelessRule
/// RuleDefinition
/// Actions specification.
CustomActions: CustomActions
}
/// The ID for a subnet that you want to associate with the firewall. This is used with
/// CreateFirewall and AssociateSubnets. Network Firewall
/// creates an instance of the associated firewall in each subnet that you specify, to filter
/// traffic in the subnet's Availability Zone.
structure SubnetMapping {
/// The unique identifier for the subnet.
@required
SubnetId: CollectionMember_String
/// The subnet's IP address type. You can't change the IP address type after you create the subnet.
IPAddressType: IPAddressType
}
/// The status of the firewall endpoint and firewall policy configuration for a single VPC
/// subnet.
/// For each VPC subnet that you associate with a firewall, Network Firewall does the
/// following:
///
/// -
///
Instantiates a firewall endpoint in the subnet, ready to take traffic.
///
/// -
///
Configures the endpoint with the current firewall policy settings, to provide the
/// filtering behavior for the endpoint.
///
///
/// When you update a firewall, for example to add a subnet association or change a rule
/// group in the firewall policy, the affected sync states reflect out-of-sync or not ready
/// status until the changes are complete.
structure SyncState {
/// The attachment status of the firewall's association with a single VPC subnet. For each
/// configured subnet, Network Firewall creates the attachment by instantiating the firewall
/// endpoint in the subnet so that it's ready to take traffic. This is part of the FirewallStatus.
Attachment: Attachment
/// The configuration status of the firewall endpoint in a single VPC subnet. Network Firewall
/// provides each endpoint with the rules that are configured in the firewall policy. Each time
/// you add a subnet or modify the associated firewall policy, Network Firewall synchronizes the
/// rules in the endpoint, so it can properly filter network traffic. This is part of the FirewallStatus.
Config: SyncStateConfig
}
/// A key:value pair associated with an Amazon Web Services resource. The key:value pair can be anything you
/// define. Typically, the tag key represents a category (such as "environment") and the tag
/// value represents a specific value within that category (such as "test," "development," or
/// "production"). You can add up to 50 tags to each Amazon Web Services resource.
structure Tag {
/// The part of the key:value pair that defines a tag. You can use a tag key to describe a
/// category of information, such as "customer." Tag keys are case-sensitive.
@required
Key: TagKey
/// The part of the key:value pair that defines a tag. You can use a tag value to describe a
/// specific value within a category, such as "companyA" or "companyB." Tag values are
/// case-sensitive.
@required
Value: TagValue
}
@input
structure TagResourceRequest {
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: ResourceArn
///
@required
Tags: TagList
}
@output
structure TagResourceResponse {}
/// TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.
structure TCPFlagField {
/// Used in conjunction with the Masks setting to define the flags that must be set and flags that must not be set in order for the packet to match. This setting can only specify values that are also specified in the Masks setting.
/// For the flags that are specified in the masks setting, the following must be true for the packet to match:
///
/// -
///
The ones that are set in this flags setting must be set in the packet.
///
/// -
///
The ones that are not set in this flags setting must also not be set in the packet.
///
///
@required
Flags: Flags
/// The set of flags to consider in the inspection. To inspect all flags in the valid values list, leave this with no setting.
Masks: Flags
}
/// Unable to process the request due to throttling limitations.
@error("client")
structure ThrottlingException {
Message: ErrorMessage
}
/// Contains metadata about an Certificate Manager certificate.
structure TlsCertificateData {
/// The Amazon Resource Name (ARN) of the certificate.
CertificateArn: ResourceArn
/// The serial number of the certificate.
CertificateSerial: CollectionMember_String
/// The status of the certificate.
Status: CollectionMember_String
/// Contains details about the certificate status, including information about certificate errors.
StatusMessage: StatusReason
}
/// The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
/// Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
/// To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS
/// inspection configurations in the Network Firewall Developer Guide.
structure TLSInspectionConfiguration {
/// Lists the server certificate configurations that are associated with the TLS configuration.
ServerCertificateConfigurations: ServerCertificateConfigurations
}
/// High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations. You can use the information provided in the metadata to retrieve and manage a TLS configuration.
structure TLSInspectionConfigurationMetadata {
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
Name: ResourceName
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
Arn: ResourceArn
}
/// The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
structure TLSInspectionConfigurationResponse {
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
@required
TLSInspectionConfigurationArn: ResourceArn
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
@required
TLSInspectionConfigurationName: ResourceName
/// A unique identifier for the TLS inspection configuration. This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete.
@required
TLSInspectionConfigurationId: ResourceId
/// Detailed information about the current status of a TLSInspectionConfiguration. You can retrieve this for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration and providing the TLS inspection configuration name and ARN.
TLSInspectionConfigurationStatus: ResourceStatus
/// A description of the TLS inspection configuration.
Description: Description
/// The key:value pairs to associate with the resource.
Tags: TagList
/// The last time that the TLS inspection configuration was changed.
LastModifiedTime: LastUpdateTime
/// The number of firewall policies that use this TLS inspection configuration.
NumberOfAssociations: NumberOfAssociations
/// A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
EncryptionConfiguration: EncryptionConfiguration
/// A list of the certificates associated with the TLS inspection configuration.
Certificates: Certificates
}
/// The operation you requested isn't supported by Network Firewall.
@error("client")
structure UnsupportedOperationException {
Message: ErrorMessage
}
@input
structure UntagResourceRequest {
/// The Amazon Resource Name (ARN) of the resource.
@required
ResourceArn: ResourceArn
///
@required
TagKeys: TagKeyList
}
@output
structure UntagResourceResponse {}
@input
structure UpdateFirewallDeleteProtectionRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates
/// that the firewall is protected against deletion. Use this setting to protect against
/// accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
@required
DeleteProtection: Boolean = false
}
@output
structure UpdateFirewallDeleteProtectionResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// A flag indicating whether it is possible to delete the firewall. A setting of TRUE indicates
/// that the firewall is protected against deletion. Use this setting to protect against
/// accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to TRUE.
DeleteProtection: Boolean = false
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
}
@input
structure UpdateFirewallDescriptionRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// The new description for the firewall. If you omit this setting, Network Firewall removes
/// the description for the firewall.
Description: Description
}
@output
structure UpdateFirewallDescriptionResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// A description of the firewall.
Description: Description
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
}
@input
structure UpdateFirewallEncryptionConfigurationRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
EncryptionConfiguration: EncryptionConfiguration
}
@output
structure UpdateFirewallEncryptionConfigurationResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
EncryptionConfiguration: EncryptionConfiguration
}
@input
structure UpdateFirewallPolicyChangeProtectionRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// A setting indicating whether the firewall is protected against a change to the firewall policy association.
/// Use this setting to protect against
/// accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
@required
FirewallPolicyChangeProtection: Boolean = false
}
@output
structure UpdateFirewallPolicyChangeProtectionResponse {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// A setting indicating whether the firewall is protected against a change to the firewall policy association.
/// Use this setting to protect against
/// accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
FirewallPolicyChangeProtection: Boolean = false
}
@input
structure UpdateFirewallPolicyRequest {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
/// To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall policy.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyArn: ResourceArn
/// The descriptive name of the firewall policy. You can't change the name of a firewall policy after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallPolicyName: ResourceName
/// The updated firewall policy to use for the firewall. You can't add or remove a TLSInspectionConfiguration after you create a firewall policy. However, you can replace an existing TLS inspection configuration with another TLSInspectionConfiguration.
@required
FirewallPolicy: FirewallPolicy
/// A description of the firewall policy.
Description: Description
/// Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
/// If set to TRUE, Network Firewall checks whether the request can run successfully,
/// but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
/// dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have
/// the required permissions to run the request and that your request parameters are valid.
/// If set to FALSE, Network Firewall makes the requested changes to your resources.
DryRun: Boolean = false
/// A complex type that contains settings for encryption of your firewall policy resources.
EncryptionConfiguration: EncryptionConfiguration
}
@output
structure UpdateFirewallPolicyResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the firewall policy. The token marks the state of the policy resource at the time of the request.
/// To make changes to the policy, you provide the token in your request. Network Firewall uses the token to ensure that the policy hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall policy again to get a current copy of it with current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The high-level properties of a firewall policy. This, along with the FirewallPolicy, define the policy. You can retrieve all objects for a firewall policy by calling DescribeFirewallPolicy.
@required
FirewallPolicyResponse: FirewallPolicyResponse
}
@input
structure UpdateLoggingConfigurationRequest {
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// Defines how Network Firewall performs logging for a firewall. If you omit this setting,
/// Network Firewall disables logging for the firewall.
LoggingConfiguration: LoggingConfiguration
}
@output
structure UpdateLoggingConfigurationResponse {
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
LoggingConfiguration: LoggingConfiguration
}
@input
structure UpdateRuleGroupRequest {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
/// To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the rule group.
/// You must specify the ARN or the name, and you can specify both.
RuleGroupArn: ResourceArn
/// 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: ResourceName
/// An object that defines the rule group rules.
///
/// You must provide either this rule group setting or a Rules setting, but not both.
///
RuleGroup: RuleGroup
/// A string containing stateful rule group rules specifications in Suricata flat format, with one rule
/// per line. Use this to import your existing Suricata compatible rule groups.
///
/// You must provide either this rules setting or a populated RuleGroup setting, but not both.
///
/// You can provide your rule group specification in Suricata flat format through this setting when you create or update your rule group. The call
/// response returns a RuleGroup object that Network Firewall has populated from your string.
Rules: RulesString
/// 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.
///
Type: RuleGroupType
/// A description of the rule group.
Description: Description
/// Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
/// If set to TRUE, Network Firewall checks whether the request can run successfully,
/// but doesn't actually make the requested changes. The call returns the value that the request would return if you ran it with
/// dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows you to make sure that you have
/// the required permissions to run the request and that your request parameters are valid.
/// If set to FALSE, Network Firewall makes the requested changes to your resources.
DryRun: Boolean = false
/// A complex type that contains settings for encryption of your rule group resources.
EncryptionConfiguration: EncryptionConfiguration
/// A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
SourceMetadata: SourceMetadata
}
@output
structure UpdateRuleGroupResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
/// To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the rule group again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// 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.
@required
RuleGroupResponse: RuleGroupResponse
}
@input
structure UpdateSubnetChangeProtectionRequest {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
/// You must specify the ARN or the name, and you can specify both.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
/// You must specify the ARN or the name, and you can specify both.
FirewallName: ResourceName
/// A setting indicating whether the firewall is protected against changes to the subnet associations.
/// Use this setting to protect against
/// accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
@required
SubnetChangeProtection: Boolean = false
}
@output
structure UpdateSubnetChangeProtectionResponse {
/// An optional token that you can use for optimistic locking. Network Firewall returns a token to your requests that access the firewall. The token marks the state of the firewall resource at the time of the request.
/// To make an unconditional change to the firewall, omit the token in your update request. Without the token, Network Firewall performs your updates regardless of whether the firewall has changed since you last retrieved it.
/// To make a conditional change to the firewall, provide the token in your update request. Network Firewall uses the token to ensure that the firewall hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the firewall again to get a current copy of it with a new token. Reapply your changes as needed, then try the operation again using the new token.
UpdateToken: UpdateToken
/// The Amazon Resource Name (ARN) of the firewall.
FirewallArn: ResourceArn
/// The descriptive name of the firewall. You can't change the name of a firewall after you create it.
FirewallName: ResourceName
/// A setting indicating whether the firewall is protected against changes to the subnet associations.
/// Use this setting to protect against
/// accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to TRUE.
SubnetChangeProtection: Boolean = false
}
@input
structure UpdateTLSInspectionConfigurationRequest {
/// The Amazon Resource Name (ARN) of the TLS inspection configuration.
TLSInspectionConfigurationArn: ResourceArn
/// The descriptive name of the TLS inspection configuration. You can't change the name of a TLS inspection configuration after you create it.
TLSInspectionConfigurationName: ResourceName
/// The object that defines a TLS inspection configuration. This, along with TLSInspectionConfigurationResponse, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
/// Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
/// To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect inbound traffic. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see Decrypting SSL/TLS traffic with TLS
/// inspection configurations in the Network Firewall Developer Guide.
@required
TLSInspectionConfiguration: TLSInspectionConfiguration
/// A description of the TLS inspection configuration.
Description: Description
/// A complex type that contains the Amazon Web Services KMS encryption configuration settings for your TLS inspection configuration.
EncryptionConfiguration: EncryptionConfiguration
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
/// To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
}
@output
structure UpdateTLSInspectionConfigurationResponse {
/// A token used for optimistic locking. Network Firewall returns a token to your requests that access the TLS inspection configuration. The token marks the state of the TLS inspection configuration resource at the time of the request.
/// To make changes to the TLS inspection configuration, you provide the token in your request. Network Firewall uses the token to ensure that the TLS inspection configuration hasn't changed since you last retrieved it. If it has changed, the operation fails with an InvalidTokenException. If this happens, retrieve the TLS inspection configuration again to get a current copy of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
@required
UpdateToken: UpdateToken
/// The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.
@required
TLSInspectionConfigurationResponse: TLSInspectionConfigurationResponse
}
list Addresses {
member: Address
}
list AzSubnets {
member: AzSubnet
}
list Certificates {
member: TlsCertificateData
}
list CustomActions {
member: CustomAction
}
@length(
min: 1
max: 1
)
list Dimensions {
member: Dimension
}
list FirewallPolicies {
member: FirewallPolicyMetadata
}
list Firewalls {
member: FirewallMetadata
}
list Flags {
member: TCPFlag
}
list LogDestinationConfigs {
member: LogDestinationConfig
}
list PortRanges {
member: PortRange
}
list ProtocolNumbers {
member: ProtocolNumber
}
list RuleGroups {
member: RuleGroupMetadata
}
list RuleOptions {
member: RuleOption
}
list RuleTargets {
member: CollectionMember_String
}
list ServerCertificateConfigurations {
member: ServerCertificateConfiguration
}
list ServerCertificates {
member: ServerCertificate
}
list ServerCertificateScopes {
member: ServerCertificateScope
}
list Settings {
member: Setting
}
list StatefulActions {
member: CollectionMember_String
}
list StatefulRuleGroupReferences {
member: StatefulRuleGroupReference
}
list StatefulRules {
member: StatefulRule
}
list StatelessActions {
member: CollectionMember_String
}
list StatelessRuleGroupReferences {
member: StatelessRuleGroupReference
}
list StatelessRules {
member: StatelessRule
}
list SubnetMappings {
member: SubnetMapping
}
@length(
min: 1
max: 200
)
list TagKeyList {
member: TagKey
}
@length(
min: 1
max: 200
)
list TagList {
member: Tag
}
list TargetTypes {
member: TargetType
}
list TCPFlags {
member: TCPFlagField
}
list TLSInspectionConfigurations {
member: TLSInspectionConfigurationMetadata
}
list VariableDefinitionList {
member: VariableDefinition
}
list VpcIds {
member: VpcId
}
map IPSetMetadataMap {
key: IPSetArn
value: IPSetMetadata
}
map IPSetReferenceMap {
key: IPSetReferenceName
value: IPSetReference
}
map IPSets {
key: RuleVariableName
value: IPSet
}
map LogDestinationMap {
key: HashMapKey
value: HashMapValue
}
map PortSets {
key: RuleVariableName
value: PortSet
}
map SyncStateConfig {
key: ResourceName
value: PerObjectStatus
}
map SyncStates {
key: AvailabilityZone
value: SyncState
}
@length(
min: 1
max: 128
)
@pattern("^[a-zA-Z0-9]+$")
string ActionName
@length(
min: 1
max: 255
)
@pattern("^([a-fA-F\\d:\\.]+($|/\\d{1,3}))$")
string AddressDefinition
enum AttachmentStatus {
CREATING
DELETING
FAILED
ERROR
SCALING
READY
}
string AvailabilityZone
@length(
min: 1
max: 128
)
@pattern("^subnet-[0-9a-f]+$")
string AzSubnet
@default(false)
boolean Boolean
@range(
min: 0
max: 1000000
)
integer CIDRCount
string CollectionMember_String
enum ConfigurationSyncState {
PENDING
IN_SYNC
CAPACITY_CONSTRAINED
}
@length(
min: 0
max: 512
)
@pattern("^.*$")
string Description
@length(
min: 1
max: 1024
)
@pattern("^.*$")
string Destination
@length(
min: 1
max: 128
)
@pattern("^[a-zA-Z0-9-_ ]+$")
string DimensionValue
enum EncryptionType {
CUSTOMER_KMS
AWS_OWNED_KMS_KEY
}
string EndpointId
string ErrorMessage
enum FirewallStatusValue {
PROVISIONING
DELETING
READY
}
enum GeneratedRulesType {
ALLOWLIST
DENYLIST
}
@length(
min: 3
max: 50
)
@pattern("^[0-9A-Za-z.\\-_@\\/]+$")
string HashMapKey
@length(
min: 1
max: 1024
)
@pattern("^[\\s\\S]*$")
string HashMapValue
enum IPAddressType {
DUALSTACK
IPV4
IPV6
}
string IPSetArn
@length(
min: 1
max: 32
)
@pattern("^[A-Za-z][A-Za-z0-9_]*$")
string IPSetReferenceName
@length(
min: 1
max: 2048
)
@pattern("\\S")
string KeyId
@length(
min: 1
max: 128
)
@pattern(".*")
string Keyword
timestamp LastUpdateTime
@length(
min: 2
max: 30
)
@pattern("^[0-9A-Za-z]+$")
enum LogDestinationType {
S3
CLOUDWATCH_LOGS = "CloudWatchLogs"
KINESIS_DATA_FIREHOSE = "KinesisDataFirehose"
}
enum LogType {
ALERT
FLOW
}
integer NumberOfAssociations
enum OverrideAction {
DROP_TO_ALERT
}
@range(
min: 1
max: 100
)
integer PaginationMaxResults
@length(
min: 1
max: 4096
)
@pattern("^[0-9A-Za-z:\\/+=]+$")
string PaginationToken
enum PerObjectSyncStatus {
PENDING
IN_SYNC
CAPACITY_CONSTRAINED
}
@length(
min: 1
max: 395000
)
@pattern("\\S")
string PolicyString
@length(
min: 1
max: 1024
)
@pattern("^.*$")
string Port
@default(0)
@range(
min: 0
max: 65535
)
integer PortRangeBound
@default(0)
@range(
min: 1
max: 65535
)
integer Priority
@default(0)
@range(
min: 0
max: 255
)
integer ProtocolNumber
@length(
min: 1
max: 256
)
@pattern("^arn:aws")
string ResourceArn
@length(
min: 36
max: 36
)
@pattern("^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$")
string ResourceId
enum ResourceManagedStatus {
MANAGED
ACCOUNT
}
enum ResourceManagedType {
AWS_MANAGED_THREAT_SIGNATURES
AWS_MANAGED_DOMAIN_LISTS
}
@length(
min: 1
max: 128
)
@pattern("^[a-zA-Z0-9-]+$")
string ResourceName
enum ResourceStatus {
ACTIVE
DELETING
}
integer RuleCapacity
enum RuleGroupType {
STATELESS
STATEFUL
}
enum RuleOrder {
DEFAULT_ACTION_ORDER
STRICT_ORDER
}
@length(
min: 0
max: 2000000
)
string RulesString
@length(
min: 1
max: 32
)
@pattern("^[A-Za-z][A-Za-z0-9_]*$")
string RuleVariableName
@length(
min: 1
max: 8192
)
@pattern(".*")
string Setting
@length(
min: 1
max: 1024
)
@pattern("^.*$")
string Source
enum StatefulAction {
PASS
DROP
ALERT
REJECT
}
enum StatefulRuleDirection {
FORWARD
ANY
}
enum StatefulRuleProtocol {
ANY = "IP"
TCP
UDP
ICMP
HTTP
FTP
TLS
SMB
DNS
DCERPC
SSH
SMTP
IMAP
MSN
KRB5
IKEV2
TFTP
NTP
DHCP
}
string StatusMessage
@length(
min: 1
max: 256
)
@pattern("^[a-zA-Z0-9- ]+$")
string StatusReason
enum StreamExceptionPolicy {
DROP
CONTINUE
REJECT
}
@length(
min: 1
max: 128
)
@pattern("^.*$")
string TagKey
@range(
min: 0
max: 100
)
integer TagsPaginationMaxResults
@length(
min: 0
max: 256
)
@pattern("^.*$")
string TagValue
enum TargetType {
TLS_SNI
HTTP_HOST
}
enum TCPFlag {
FIN
SYN
RST
PSH
ACK
URG
ECE
CWR
}
@length(
min: 1
max: 1024
)
@pattern("^([0-9a-f]{8})-([0-9a-f]{4}-){3}([0-9a-f]{12})$")
string UpdateToken
@length(
min: 1
)
@pattern("^.*$")
string VariableDefinition
@length(
min: 1
max: 128
)
@pattern("^vpc-[0-9a-f]+$")
string VpcId