5.0.0 • Published 5 years ago

@datafire/amazonaws_network_firewall v5.0.0

Weekly downloads
1
License
MIT
Repository
github
Last release
5 years ago

@datafire/amazonaws_network_firewall

Client library for AWS Network Firewall

Installation and Usage

npm install --save @datafire/amazonaws_network_firewall
let amazonaws_network_firewall = require('@datafire/amazonaws_network_firewall').create({
  accessKeyId: "",
  secretAccessKey: "",
  region: ""
});

.then(data => {
  console.log(data);
});

Description

Actions

AssociateFirewallPolicy

amazonaws_network_firewall.AssociateFirewallPolicy({
  "FirewallPolicyArn": null
}, context)

Input

  • input object
    • FirewallArn
    • FirewallName
    • FirewallPolicyArn required
    • UpdateToken

Output

AssociateSubnets

amazonaws_network_firewall.AssociateSubnets({
  "SubnetMappings": null
}, context)

Input

  • input object
    • FirewallArn
    • FirewallName
    • SubnetMappings required
    • UpdateToken

Output

CreateFirewall

amazonaws_network_firewall.CreateFirewall({
  "FirewallName": null,
  "FirewallPolicyArn": null,
  "VpcId": null,
  "SubnetMappings": null
}, context)

Input

  • input object
    • DeleteProtection
    • Description
    • FirewallName required
    • FirewallPolicyArn required
    • FirewallPolicyChangeProtection
    • SubnetChangeProtection
    • SubnetMappings required
    • Tags
    • VpcId required

Output

CreateFirewallPolicy

amazonaws_network_firewall.CreateFirewallPolicy({
  "FirewallPolicyName": null,
  "FirewallPolicy": null
}, context)

Input

Output

CreateRuleGroup

amazonaws_network_firewall.CreateRuleGroup({
  "RuleGroupName": null,
  "Type": null,
  "Capacity": null
}, context)

Input

  • input object
    • Capacity required
    • Description
    • DryRun
    • RuleGroup
    • RuleGroupName required
    • Rules
    • Tags
    • Type required

Output

DeleteFirewall

amazonaws_network_firewall.DeleteFirewall({}, context)

Input

  • input object
    • FirewallArn
    • FirewallName

Output

DeleteFirewallPolicy

amazonaws_network_firewall.DeleteFirewallPolicy({}, context)

Input

  • input object
    • FirewallPolicyArn
    • FirewallPolicyName

Output

DeleteResourcePolicy

amazonaws_network_firewall.DeleteResourcePolicy({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

DeleteRuleGroup

amazonaws_network_firewall.DeleteRuleGroup({}, context)

Input

  • input object
    • RuleGroupArn
    • RuleGroupName
    • Type

Output

DescribeFirewall

amazonaws_network_firewall.DescribeFirewall({}, context)

Input

  • input object
    • FirewallArn
    • FirewallName

Output

DescribeFirewallPolicy

amazonaws_network_firewall.DescribeFirewallPolicy({}, context)

Input

  • input object
    • FirewallPolicyArn
    • FirewallPolicyName

Output

DescribeLoggingConfiguration

amazonaws_network_firewall.DescribeLoggingConfiguration({}, context)

Input

  • input object
    • FirewallArn
    • FirewallName

Output

DescribeResourcePolicy

amazonaws_network_firewall.DescribeResourcePolicy({
  "ResourceArn": null
}, context)

Input

  • input object
    • ResourceArn required

Output

DescribeRuleGroup

amazonaws_network_firewall.DescribeRuleGroup({}, context)

Input

  • input object
    • RuleGroupArn
    • RuleGroupName
    • Type

Output

DisassociateSubnets

amazonaws_network_firewall.DisassociateSubnets({
  "SubnetIds": null
}, context)

Input

  • input object
    • FirewallArn
    • FirewallName
    • SubnetIds required
    • UpdateToken

Output

ListFirewallPolicies

amazonaws_network_firewall.ListFirewallPolicies({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListFirewalls

amazonaws_network_firewall.ListFirewalls({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • VpcIds

Output

ListRuleGroups

amazonaws_network_firewall.ListRuleGroups({}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken

Output

ListTagsForResource

amazonaws_network_firewall.ListTagsForResource({
  "ResourceArn": null
}, context)

Input

  • input object
    • MaxResults string
    • NextToken string
    • MaxResults
    • NextToken
    • ResourceArn required

Output

PutResourcePolicy

amazonaws_network_firewall.PutResourcePolicy({
  "ResourceArn": null,
  "Policy": null
}, context)

Input

  • input object
    • Policy required
    • ResourceArn required

Output

TagResource

amazonaws_network_firewall.TagResource({
  "ResourceArn": null,
  "Tags": null
}, context)

Input

  • input object
    • ResourceArn required
    • Tags required

Output

UntagResource

amazonaws_network_firewall.UntagResource({
  "ResourceArn": null,
  "TagKeys": null
}, context)

Input

  • input object
    • ResourceArn required
    • TagKeys required

Output

UpdateFirewallDeleteProtection

amazonaws_network_firewall.UpdateFirewallDeleteProtection({
  "DeleteProtection": null
}, context)

Input

  • input object
    • DeleteProtection required
    • FirewallArn
    • FirewallName
    • UpdateToken

Output

UpdateFirewallDescription

amazonaws_network_firewall.UpdateFirewallDescription({}, context)

Input

  • input object
    • Description
    • FirewallArn
    • FirewallName
    • UpdateToken

Output

UpdateFirewallPolicy

amazonaws_network_firewall.UpdateFirewallPolicy({
  "UpdateToken": null,
  "FirewallPolicy": null
}, context)

Input

Output

UpdateFirewallPolicyChangeProtection

amazonaws_network_firewall.UpdateFirewallPolicyChangeProtection({
  "FirewallPolicyChangeProtection": null
}, context)

Input

  • input object
    • FirewallArn
    • FirewallName
    • FirewallPolicyChangeProtection required
    • UpdateToken

Output

UpdateLoggingConfiguration

amazonaws_network_firewall.UpdateLoggingConfiguration({}, context)

Input

  • input object

Output

UpdateRuleGroup

amazonaws_network_firewall.UpdateRuleGroup({
  "UpdateToken": null
}, context)

Input

  • input object
    • Description
    • DryRun
    • RuleGroup
    • RuleGroupArn
    • RuleGroupName
    • Rules
    • Type
    • UpdateToken required

Output

UpdateSubnetChangeProtection

amazonaws_network_firewall.UpdateSubnetChangeProtection({
  "SubnetChangeProtection": null
}, context)

Input

  • input object
    • FirewallArn
    • FirewallName
    • SubnetChangeProtection required
    • UpdateToken

Output

Definitions

ActionDefinition

  • ActionDefinition object: A custom action to use in stateless rule actions settings. This is used in CustomAction.
    • PublishMetricAction

ActionName

  • ActionName string

Address

  • Address object: A single IP address specification. This is used in the MatchAttributes source and destination specifications.
    • AddressDefinition required

AddressDefinition

  • AddressDefinition string

Addresses

AssociateFirewallPolicyRequest

  • AssociateFirewallPolicyRequest object
    • FirewallArn
    • FirewallName
    • FirewallPolicyArn required
    • UpdateToken

AssociateFirewallPolicyResponse

  • AssociateFirewallPolicyResponse object
    • FirewallArn
    • FirewallName
    • FirewallPolicyArn
    • UpdateToken

AssociateSubnetsRequest

  • AssociateSubnetsRequest object
    • FirewallArn
    • FirewallName
    • SubnetMappings required
    • UpdateToken

AssociateSubnetsResponse

  • AssociateSubnetsResponse object
    • FirewallArn
    • FirewallName
    • SubnetMappings
    • UpdateToken

Attachment

  • Attachment object: The configuration and status for a single subnet that you've specified for use by the AWS Network Firewall firewall. This is part of the FirewallStatus.
    • EndpointId
    • Status
    • SubnetId

AttachmentStatus

  • AttachmentStatus string (values: CREATING, DELETING, SCALING, READY)

AvailabilityZone

  • AvailabilityZone string

AzSubnet

  • AzSubnet string

AzSubnets

Boolean

  • Boolean boolean

CollectionMember_String

  • CollectionMember_String string

ConfigurationSyncState

  • ConfigurationSyncState string (values: PENDING, IN_SYNC)

CreateFirewallPolicyRequest

CreateFirewallPolicyResponse

  • CreateFirewallPolicyResponse object
    • FirewallPolicyResponse required
      • Description
      • FirewallPolicyArn required
      • FirewallPolicyId required
      • FirewallPolicyName required
      • FirewallPolicyStatus
      • Tags
    • UpdateToken required

CreateFirewallRequest

  • CreateFirewallRequest object
    • DeleteProtection
    • Description
    • FirewallName required
    • FirewallPolicyArn required
    • FirewallPolicyChangeProtection
    • SubnetChangeProtection
    • SubnetMappings required
    • Tags
    • VpcId required

CreateFirewallResponse

  • CreateFirewallResponse object
    • Firewall
      • DeleteProtection
      • Description
      • FirewallArn
      • FirewallId required
      • FirewallName
      • FirewallPolicyArn required
      • FirewallPolicyChangeProtection
      • SubnetChangeProtection
      • SubnetMappings required
      • Tags
      • VpcId required
    • FirewallStatus
      • ConfigurationSyncStateSummary required
      • Status required
      • SyncStates

CreateRuleGroupRequest

  • CreateRuleGroupRequest object
    • Capacity required
    • Description
    • DryRun
    • RuleGroup
    • RuleGroupName required
    • Rules
    • Tags
    • Type required

CreateRuleGroupResponse

  • CreateRuleGroupResponse object
    • RuleGroupResponse required
      • Capacity
      • Description
      • RuleGroupArn required
      • RuleGroupId required
      • RuleGroupName required
      • RuleGroupStatus
      • Tags
      • Type
    • UpdateToken required

CustomAction

  • CustomAction object: 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.
    • ActionDefinition required
      • PublishMetricAction
    • ActionName required

CustomActions

DeleteFirewallPolicyRequest

  • DeleteFirewallPolicyRequest object
    • FirewallPolicyArn
    • FirewallPolicyName

DeleteFirewallPolicyResponse

  • DeleteFirewallPolicyResponse object
    • FirewallPolicyResponse required
      • Description
      • FirewallPolicyArn required
      • FirewallPolicyId required
      • FirewallPolicyName required
      • FirewallPolicyStatus
      • Tags

DeleteFirewallRequest

  • DeleteFirewallRequest object
    • FirewallArn
    • FirewallName

DeleteFirewallResponse

DeleteResourcePolicyRequest

  • DeleteResourcePolicyRequest object
    • ResourceArn required

DeleteResourcePolicyResponse

  • DeleteResourcePolicyResponse object

DeleteRuleGroupRequest

  • DeleteRuleGroupRequest object
    • RuleGroupArn
    • RuleGroupName
    • Type

DeleteRuleGroupResponse

  • DeleteRuleGroupResponse object
    • RuleGroupResponse required
      • Capacity
      • Description
      • RuleGroupArn required
      • RuleGroupId required
      • RuleGroupName required
      • RuleGroupStatus
      • Tags
      • Type

DescribeFirewallPolicyRequest

  • DescribeFirewallPolicyRequest object
    • FirewallPolicyArn
    • FirewallPolicyName

DescribeFirewallPolicyResponse

DescribeFirewallRequest

  • DescribeFirewallRequest object
    • FirewallArn
    • FirewallName

DescribeFirewallResponse

  • DescribeFirewallResponse object
    • Firewall
      • DeleteProtection
      • Description
      • FirewallArn
      • FirewallId required
      • FirewallName
      • FirewallPolicyArn required
      • FirewallPolicyChangeProtection
      • SubnetChangeProtection
      • SubnetMappings required
      • Tags
      • VpcId required
    • FirewallStatus
      • ConfigurationSyncStateSummary required
      • Status required
      • SyncStates
    • UpdateToken

DescribeLoggingConfigurationRequest

  • DescribeLoggingConfigurationRequest object
    • FirewallArn
    • FirewallName

DescribeLoggingConfigurationResponse

DescribeResourcePolicyRequest

  • DescribeResourcePolicyRequest object
    • ResourceArn required

DescribeResourcePolicyResponse

  • DescribeResourcePolicyResponse object
    • Policy

DescribeRuleGroupRequest

  • DescribeRuleGroupRequest object
    • RuleGroupArn
    • RuleGroupName
    • Type

DescribeRuleGroupResponse

  • DescribeRuleGroupResponse object
    • RuleGroup
    • RuleGroupResponse required
      • Capacity
      • Description
      • RuleGroupArn required
      • RuleGroupId required
      • RuleGroupName required
      • RuleGroupStatus
      • Tags
      • Type
    • UpdateToken required

Description

  • Description string

Destination

  • Destination string

Dimension

  • Dimension object: 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. AWS 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.
    • Value required

DimensionValue

  • DimensionValue string

Dimensions

DisassociateSubnetsRequest

  • DisassociateSubnetsRequest object
    • FirewallArn
    • FirewallName
    • SubnetIds required
    • UpdateToken

DisassociateSubnetsResponse

  • DisassociateSubnetsResponse object
    • FirewallArn
    • FirewallName
    • SubnetMappings
    • UpdateToken

EndpointId

  • EndpointId string

Firewall

  • Firewall object: The firewall defines the configuration settings for an AWS 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 AWS 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.
    • DeleteProtection
    • Description
    • FirewallArn
    • FirewallId required
    • FirewallName
    • FirewallPolicyArn required
    • FirewallPolicyChangeProtection
    • SubnetChangeProtection
    • SubnetMappings required
    • Tags
    • VpcId required

FirewallMetadata

  • FirewallMetadata object: 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.
    • FirewallArn
    • FirewallName

FirewallPolicies

FirewallPolicy

  • FirewallPolicy object: 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.

FirewallPolicyMetadata

  • FirewallPolicyMetadata object: 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.
    • Arn
    • Name

FirewallPolicyResponse

  • FirewallPolicyResponse object: 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.
    • Description
    • FirewallPolicyArn required
    • FirewallPolicyId required
    • FirewallPolicyName required
    • FirewallPolicyStatus
    • Tags

FirewallStatus

  • FirewallStatus object: 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.
    • ConfigurationSyncStateSummary required
    • Status required
    • SyncStates

FirewallStatusValue

  • FirewallStatusValue string (values: PROVISIONING, DELETING, READY)

Firewalls

Flags

GeneratedRulesType

  • GeneratedRulesType string (values: ALLOWLIST, DENYLIST)

HashMapKey

  • HashMapKey string

HashMapValue

  • HashMapValue string

Header

  • Header object: The 5-tuple criteria for AWS 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.
    • Destination required
    • DestinationPort required
    • Direction required
    • Protocol required
    • Source required
    • SourcePort required

IPSet

  • IPSet object: A list of IP addresses and address ranges, in CIDR notation. This is part of a RuleVariables.

IPSets

  • IPSets object

InsufficientCapacityException

InternalServerError

InvalidOperationException

InvalidRequestException

InvalidResourcePolicyException

InvalidTokenException

Keyword

  • Keyword string

LimitExceededException

ListFirewallPoliciesRequest

  • ListFirewallPoliciesRequest object
    • MaxResults
    • NextToken

ListFirewallPoliciesResponse

ListFirewallsRequest

  • ListFirewallsRequest object
    • MaxResults
    • NextToken
    • VpcIds

ListFirewallsResponse

ListRuleGroupsRequest

  • ListRuleGroupsRequest object
    • MaxResults
    • NextToken

ListRuleGroupsResponse

ListTagsForResourceRequest

  • ListTagsForResourceRequest object
    • MaxResults
    • NextToken
    • ResourceArn required

ListTagsForResourceResponse

  • ListTagsForResourceResponse object
    • NextToken
    • Tags

LogDestinationConfig

  • LogDestinationConfig object: Defines where AWS 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.
    • LogDestination required
    • LogDestinationType required
    • LogType required

LogDestinationConfigs

LogDestinationMap

  • LogDestinationMap object

LogDestinationPermissionException

LogDestinationType

  • LogDestinationType string (values: S3, CloudWatchLogs, KinesisDataFirehose)

LogType

  • LogType string (values: ALERT, FLOW)

LoggingConfiguration

  • LoggingConfiguration object: Defines how AWS Network Firewall performs logging for a Firewall.

MatchAttributes

  • MatchAttributes object: 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.

PaginationMaxResults

  • PaginationMaxResults integer

PaginationToken

  • PaginationToken string

PerObjectStatus

  • PerObjectStatus object:
    • SyncStatus

PerObjectSyncStatus

  • PerObjectSyncStatus string (values: PENDING, IN_SYNC)

PolicyString

  • PolicyString string

Port

  • Port string

PortRange

  • PortRange object: A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings.
    • FromPort required
    • ToPort required

PortRangeBound

  • PortRangeBound integer

PortRanges

PortSet

  • PortSet object: A set of port ranges for use in the rules in a rule group.

PortSets

  • PortSets object

Priority

  • Priority integer

ProtocolNumber

  • ProtocolNumber integer

ProtocolNumbers

PublishMetricAction

  • PublishMetricAction object: 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.

PutResourcePolicyRequest

  • PutResourcePolicyRequest object
    • Policy required
    • ResourceArn required

PutResourcePolicyResponse

  • PutResourcePolicyResponse object

ResourceArn

  • ResourceArn string

ResourceId

  • ResourceId string

ResourceName

  • ResourceName string

ResourceNotFoundException

ResourceOwnerCheckException

ResourceStatus

  • ResourceStatus string (values: ACTIVE, DELETING)

RuleCapacity

  • RuleCapacity integer

RuleDefinition

  • RuleDefinition object: The inspection criteria and action for a single stateless rule. AWS 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.

RuleGroup

  • RuleGroup object: 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. AWS 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.

RuleGroupMetadata

  • RuleGroupMetadata object: 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.
    • Arn
    • Name

RuleGroupResponse

  • RuleGroupResponse object: 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.
    • Capacity
    • Description
    • RuleGroupArn required
    • RuleGroupId required
    • RuleGroupName required
    • RuleGroupStatus
    • Tags
    • Type

RuleGroupType

  • RuleGroupType string (values: STATELESS, STATEFUL)

RuleGroups

RuleOption

  • RuleOption object: Additional settings for a stateful rule. This is part of the StatefulRule configuration.
    • Keyword required
    • Settings

RuleOptions

RuleTargets

RuleVariableName

  • RuleVariableName string

RuleVariables

  • RuleVariables object: Settings that are available for use in the rules in the RuleGroup where this is defined.
    • IPSets
    • PortSets

RulesSource

  • RulesSource object: 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.

RulesSourceList

  • RulesSourceList object: Stateful inspection criteria for a domain list rule group.

RulesString

  • RulesString string

Setting

  • Setting string

Settings

Source

  • Source string

StatefulAction

  • StatefulAction string (values: PASS, DROP, ALERT)

StatefulRule

  • StatefulRule object: A single 5-tuple stateful rule, for use in a stateful rule group.
    • Action required
    • Header required
      • Destination required
      • DestinationPort required
      • Direction required
      • Protocol required
      • Source required
      • SourcePort required
    • RuleOptions required

StatefulRuleDirection

  • StatefulRuleDirection string (values: FORWARD, ANY)

StatefulRuleGroupReference

  • StatefulRuleGroupReference object: Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
    • ResourceArn required

StatefulRuleGroupReferences

StatefulRuleProtocol

  • StatefulRuleProtocol string (values: IP, TCP, UDP, ICMP, HTTP, FTP, TLS, SMB, DNS, DCERPC, SSH, SMTP, IMAP, MSN, KRB5, IKEV2, TFTP, NTP, DHCP)

StatefulRules

StatelessActions

StatelessRule

StatelessRuleGroupReference

  • StatelessRuleGroupReference object: Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
    • Priority required
    • ResourceArn required

StatelessRuleGroupReferences

StatelessRules

StatelessRulesAndCustomActions

  • StatelessRulesAndCustomActions object: Stateless inspection criteria. Each stateless rule group uses exactly one of these data types to define its stateless rules.

SubnetMapping

  • SubnetMapping object: The ID for a subnet that you want to associate with the firewall. This is used with CreateFirewall and AssociateSubnets. AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
    • SubnetId required

SubnetMappings

SyncState

  • SyncState object: 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, AWS 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.
    • Attachment
      • EndpointId
      • Status
      • SubnetId
    • Config

SyncStateConfig

  • SyncStateConfig object

SyncStates

  • SyncStates object

TCPFlag

  • TCPFlag string (values: FIN, SYN, RST, PSH, ACK, URG, ECE, CWR)

TCPFlagField

  • TCPFlagField object: TCP flags and masks to inspect packets for, used in stateless rules MatchAttributes settings.

TCPFlags

Tag

  • Tag object: A key:value pair associated with an AWS 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 AWS resource.
    • Key required
    • Value required

TagKey

  • TagKey string

TagKeyList

TagList

  • TagList array

TagResourceRequest

  • TagResourceRequest object
    • ResourceArn required
    • Tags required

TagResourceResponse

  • TagResourceResponse object

TagValue

  • TagValue string

TagsPaginationMaxResults

  • TagsPaginationMaxResults integer

TargetType

  • TargetType string (values: TLS_SNI, HTTP_HOST)

TargetTypes

ThrottlingException

UnsupportedOperationException

UntagResourceRequest

  • UntagResourceRequest object
    • ResourceArn required
    • TagKeys required

UntagResourceResponse

  • UntagResourceResponse object

UpdateFirewallDeleteProtectionRequest

  • UpdateFirewallDeleteProtectionRequest object
    • DeleteProtection required
    • FirewallArn
    • FirewallName
    • UpdateToken

UpdateFirewallDeleteProtectionResponse

  • UpdateFirewallDeleteProtectionResponse object
    • DeleteProtection
    • FirewallArn
    • FirewallName
    • UpdateToken

UpdateFirewallDescriptionRequest

  • UpdateFirewallDescriptionRequest object
    • Description
    • FirewallArn
    • FirewallName
    • UpdateToken

UpdateFirewallDescriptionResponse

  • UpdateFirewallDescriptionResponse object
    • Description
    • FirewallArn
    • FirewallName
    • UpdateToken

UpdateFirewallPolicyChangeProtectionRequest

  • UpdateFirewallPolicyChangeProtectionRequest object
    • FirewallArn
    • FirewallName
    • FirewallPolicyChangeProtection required
    • UpdateToken

UpdateFirewallPolicyChangeProtectionResponse

  • UpdateFirewallPolicyChangeProtectionResponse object
    • FirewallArn
    • FirewallName
    • FirewallPolicyChangeProtection
    • UpdateToken

UpdateFirewallPolicyRequest

UpdateFirewallPolicyResponse

  • UpdateFirewallPolicyResponse object
    • FirewallPolicyResponse required
      • Description
      • FirewallPolicyArn required
      • FirewallPolicyId required
      • FirewallPolicyName required
      • FirewallPolicyStatus
      • Tags
    • UpdateToken required

UpdateLoggingConfigurationRequest

  • UpdateLoggingConfigurationRequest object

UpdateLoggingConfigurationResponse

  • UpdateLoggingConfigurationResponse object

UpdateRuleGroupRequest

  • UpdateRuleGroupRequest object
    • Description
    • DryRun
    • RuleGroup
    • RuleGroupArn
    • RuleGroupName
    • Rules
    • Type
    • UpdateToken required

UpdateRuleGroupResponse

  • UpdateRuleGroupResponse object
    • RuleGroupResponse required
      • Capacity
      • Description
      • RuleGroupArn required
      • RuleGroupId required
      • RuleGroupName required
      • RuleGroupStatus
      • Tags
      • Type
    • UpdateToken required

UpdateSubnetChangeProtectionRequest

  • UpdateSubnetChangeProtectionRequest object
    • FirewallArn
    • FirewallName
    • SubnetChangeProtection required
    • UpdateToken

UpdateSubnetChangeProtectionResponse

  • UpdateSubnetChangeProtectionResponse object
    • FirewallArn
    • FirewallName
    • SubnetChangeProtection
    • UpdateToken

UpdateToken

  • UpdateToken string

VariableDefinition

  • VariableDefinition string

VariableDefinitionList

VpcId

  • VpcId string

VpcIds