networkfirewall

package
v1.44.122 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 24, 2022 License: Apache-2.0 Imports: 10 Imported by: 26

Documentation

Overview

Package networkfirewall provides the client and types for making API requests to AWS Network Firewall.

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.

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 5.0.2. For information about Suricata, see the Suricata website (https://suricata.io/).

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 (https://docs.aws.amazon.com/vpc/latest/userguide/).

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.

See https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12 for more information on this service.

See networkfirewall package documentation for more information. https://docs.aws.amazon.com/sdk-for-go/api/service/networkfirewall/

Using the Client

To contact AWS Network Firewall with the SDK use the New function to create a new service client. With that client you can make API requests to the service. These clients are safe to use concurrently.

See the SDK's documentation for more information on how to use the SDK. https://docs.aws.amazon.com/sdk-for-go/api/

See aws.Config documentation for more information on configuring SDK clients. https://docs.aws.amazon.com/sdk-for-go/api/aws/#Config

See the AWS Network Firewall client NetworkFirewall for more information on creating client for this service. https://docs.aws.amazon.com/sdk-for-go/api/service/networkfirewall/#New

Index

Constants

View Source
const (
	// AttachmentStatusCreating is a AttachmentStatus enum value
	AttachmentStatusCreating = "CREATING"

	// AttachmentStatusDeleting is a AttachmentStatus enum value
	AttachmentStatusDeleting = "DELETING"

	// AttachmentStatusScaling is a AttachmentStatus enum value
	AttachmentStatusScaling = "SCALING"

	// AttachmentStatusReady is a AttachmentStatus enum value
	AttachmentStatusReady = "READY"
)
View Source
const (
	// ConfigurationSyncStatePending is a ConfigurationSyncState enum value
	ConfigurationSyncStatePending = "PENDING"

	// ConfigurationSyncStateInSync is a ConfigurationSyncState enum value
	ConfigurationSyncStateInSync = "IN_SYNC"

	// ConfigurationSyncStateCapacityConstrained is a ConfigurationSyncState enum value
	ConfigurationSyncStateCapacityConstrained = "CAPACITY_CONSTRAINED"
)
View Source
const (
	// EncryptionTypeCustomerKms is a EncryptionType enum value
	EncryptionTypeCustomerKms = "CUSTOMER_KMS"

	// EncryptionTypeAwsOwnedKmsKey is a EncryptionType enum value
	EncryptionTypeAwsOwnedKmsKey = "AWS_OWNED_KMS_KEY"
)
View Source
const (
	// FirewallStatusValueProvisioning is a FirewallStatusValue enum value
	FirewallStatusValueProvisioning = "PROVISIONING"

	// FirewallStatusValueDeleting is a FirewallStatusValue enum value
	FirewallStatusValueDeleting = "DELETING"

	// FirewallStatusValueReady is a FirewallStatusValue enum value
	FirewallStatusValueReady = "READY"
)
View Source
const (
	// GeneratedRulesTypeAllowlist is a GeneratedRulesType enum value
	GeneratedRulesTypeAllowlist = "ALLOWLIST"

	// GeneratedRulesTypeDenylist is a GeneratedRulesType enum value
	GeneratedRulesTypeDenylist = "DENYLIST"
)
View Source
const (
	// LogDestinationTypeS3 is a LogDestinationType enum value
	LogDestinationTypeS3 = "S3"

	// LogDestinationTypeCloudWatchLogs is a LogDestinationType enum value
	LogDestinationTypeCloudWatchLogs = "CloudWatchLogs"

	// LogDestinationTypeKinesisDataFirehose is a LogDestinationType enum value
	LogDestinationTypeKinesisDataFirehose = "KinesisDataFirehose"
)
View Source
const (
	// LogTypeAlert is a LogType enum value
	LogTypeAlert = "ALERT"

	// LogTypeFlow is a LogType enum value
	LogTypeFlow = "FLOW"
)
View Source
const (
	// PerObjectSyncStatusPending is a PerObjectSyncStatus enum value
	PerObjectSyncStatusPending = "PENDING"

	// PerObjectSyncStatusInSync is a PerObjectSyncStatus enum value
	PerObjectSyncStatusInSync = "IN_SYNC"

	// PerObjectSyncStatusCapacityConstrained is a PerObjectSyncStatus enum value
	PerObjectSyncStatusCapacityConstrained = "CAPACITY_CONSTRAINED"
)
View Source
const (
	// ResourceManagedStatusManaged is a ResourceManagedStatus enum value
	ResourceManagedStatusManaged = "MANAGED"

	// ResourceManagedStatusAccount is a ResourceManagedStatus enum value
	ResourceManagedStatusAccount = "ACCOUNT"
)
View Source
const (
	// ResourceManagedTypeAwsManagedThreatSignatures is a ResourceManagedType enum value
	ResourceManagedTypeAwsManagedThreatSignatures = "AWS_MANAGED_THREAT_SIGNATURES"

	// ResourceManagedTypeAwsManagedDomainLists is a ResourceManagedType enum value
	ResourceManagedTypeAwsManagedDomainLists = "AWS_MANAGED_DOMAIN_LISTS"
)
View Source
const (
	// ResourceStatusActive is a ResourceStatus enum value
	ResourceStatusActive = "ACTIVE"

	// ResourceStatusDeleting is a ResourceStatus enum value
	ResourceStatusDeleting = "DELETING"
)
View Source
const (
	// RuleGroupTypeStateless is a RuleGroupType enum value
	RuleGroupTypeStateless = "STATELESS"

	// RuleGroupTypeStateful is a RuleGroupType enum value
	RuleGroupTypeStateful = "STATEFUL"
)
View Source
const (
	// RuleOrderDefaultActionOrder is a RuleOrder enum value
	RuleOrderDefaultActionOrder = "DEFAULT_ACTION_ORDER"

	// RuleOrderStrictOrder is a RuleOrder enum value
	RuleOrderStrictOrder = "STRICT_ORDER"
)
View Source
const (
	// StatefulActionPass is a StatefulAction enum value
	StatefulActionPass = "PASS"

	// StatefulActionDrop is a StatefulAction enum value
	StatefulActionDrop = "DROP"

	// StatefulActionAlert is a StatefulAction enum value
	StatefulActionAlert = "ALERT"
)
View Source
const (
	// StatefulRuleDirectionForward is a StatefulRuleDirection enum value
	StatefulRuleDirectionForward = "FORWARD"

	// StatefulRuleDirectionAny is a StatefulRuleDirection enum value
	StatefulRuleDirectionAny = "ANY"
)
View Source
const (
	// StatefulRuleProtocolIp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolIp = "IP"

	// StatefulRuleProtocolTcp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolTcp = "TCP"

	// StatefulRuleProtocolUdp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolUdp = "UDP"

	// StatefulRuleProtocolIcmp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolIcmp = "ICMP"

	// StatefulRuleProtocolHttp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolHttp = "HTTP"

	// StatefulRuleProtocolFtp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolFtp = "FTP"

	// StatefulRuleProtocolTls is a StatefulRuleProtocol enum value
	StatefulRuleProtocolTls = "TLS"

	// StatefulRuleProtocolSmb is a StatefulRuleProtocol enum value
	StatefulRuleProtocolSmb = "SMB"

	// StatefulRuleProtocolDns is a StatefulRuleProtocol enum value
	StatefulRuleProtocolDns = "DNS"

	// StatefulRuleProtocolDcerpc is a StatefulRuleProtocol enum value
	StatefulRuleProtocolDcerpc = "DCERPC"

	// StatefulRuleProtocolSsh is a StatefulRuleProtocol enum value
	StatefulRuleProtocolSsh = "SSH"

	// StatefulRuleProtocolSmtp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolSmtp = "SMTP"

	// StatefulRuleProtocolImap is a StatefulRuleProtocol enum value
	StatefulRuleProtocolImap = "IMAP"

	// StatefulRuleProtocolMsn is a StatefulRuleProtocol enum value
	StatefulRuleProtocolMsn = "MSN"

	// StatefulRuleProtocolKrb5 is a StatefulRuleProtocol enum value
	StatefulRuleProtocolKrb5 = "KRB5"

	// StatefulRuleProtocolIkev2 is a StatefulRuleProtocol enum value
	StatefulRuleProtocolIkev2 = "IKEV2"

	// StatefulRuleProtocolTftp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolTftp = "TFTP"

	// StatefulRuleProtocolNtp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolNtp = "NTP"

	// StatefulRuleProtocolDhcp is a StatefulRuleProtocol enum value
	StatefulRuleProtocolDhcp = "DHCP"
)
View Source
const (
	// StreamExceptionPolicyDrop is a StreamExceptionPolicy enum value
	StreamExceptionPolicyDrop = "DROP"

	// StreamExceptionPolicyContinue is a StreamExceptionPolicy enum value
	StreamExceptionPolicyContinue = "CONTINUE"
)
View Source
const (
	// TCPFlagFin is a TCPFlag enum value
	TCPFlagFin = "FIN"

	// TCPFlagSyn is a TCPFlag enum value
	TCPFlagSyn = "SYN"

	// TCPFlagRst is a TCPFlag enum value
	TCPFlagRst = "RST"

	// TCPFlagPsh is a TCPFlag enum value
	TCPFlagPsh = "PSH"

	// TCPFlagAck is a TCPFlag enum value
	TCPFlagAck = "ACK"

	// TCPFlagUrg is a TCPFlag enum value
	TCPFlagUrg = "URG"

	// TCPFlagEce is a TCPFlag enum value
	TCPFlagEce = "ECE"

	// TCPFlagCwr is a TCPFlag enum value
	TCPFlagCwr = "CWR"
)
View Source
const (
	// TargetTypeTlsSni is a TargetType enum value
	TargetTypeTlsSni = "TLS_SNI"

	// TargetTypeHttpHost is a TargetType enum value
	TargetTypeHttpHost = "HTTP_HOST"
)
View Source
const (

	// ErrCodeInsufficientCapacityException for service response error code
	// "InsufficientCapacityException".
	//
	// Amazon Web Services doesn't currently have enough available capacity to fulfill
	// your request. Try your request later.
	ErrCodeInsufficientCapacityException = "InsufficientCapacityException"

	// ErrCodeInternalServerError for service response error code
	// "InternalServerError".
	//
	// Your request is valid, but Network Firewall couldn’t perform the operation
	// because of a system problem. Retry your request.
	ErrCodeInternalServerError = "InternalServerError"

	// ErrCodeInvalidOperationException for service response error code
	// "InvalidOperationException".
	//
	// 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.
	ErrCodeInvalidOperationException = "InvalidOperationException"

	// ErrCodeInvalidRequestException for service response error code
	// "InvalidRequestException".
	//
	// 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.
	ErrCodeInvalidRequestException = "InvalidRequestException"

	// ErrCodeInvalidResourcePolicyException for service response error code
	// "InvalidResourcePolicyException".
	//
	// The policy statement failed validation.
	ErrCodeInvalidResourcePolicyException = "InvalidResourcePolicyException"

	// ErrCodeInvalidTokenException for service response error code
	// "InvalidTokenException".
	//
	// The token you provided is stale or isn't valid for the operation.
	ErrCodeInvalidTokenException = "InvalidTokenException"

	// ErrCodeLimitExceededException for service response error code
	// "LimitExceededException".
	//
	// Unable to perform the operation because doing so would violate a limit setting.
	ErrCodeLimitExceededException = "LimitExceededException"

	// ErrCodeLogDestinationPermissionException for service response error code
	// "LogDestinationPermissionException".
	//
	// Unable to send logs to a configured logging destination.
	ErrCodeLogDestinationPermissionException = "LogDestinationPermissionException"

	// ErrCodeResourceNotFoundException for service response error code
	// "ResourceNotFoundException".
	//
	// Unable to locate a resource using the parameters that you provided.
	ErrCodeResourceNotFoundException = "ResourceNotFoundException"

	// ErrCodeResourceOwnerCheckException for service response error code
	// "ResourceOwnerCheckException".
	//
	// Unable to change the resource because your account doesn't own it.
	ErrCodeResourceOwnerCheckException = "ResourceOwnerCheckException"

	// ErrCodeThrottlingException for service response error code
	// "ThrottlingException".
	//
	// Unable to process the request due to throttling limitations.
	ErrCodeThrottlingException = "ThrottlingException"

	// ErrCodeUnsupportedOperationException for service response error code
	// "UnsupportedOperationException".
	//
	// The operation you requested isn't supported by Network Firewall.
	ErrCodeUnsupportedOperationException = "UnsupportedOperationException"
)
View Source
const (
	ServiceName = "Network Firewall" // Name of service.
	EndpointsID = "network-firewall" // ID to lookup a service endpoint with.
	ServiceID   = "Network Firewall" // ServiceID is a unique identifier of a specific service.
)

Service information constants

View Source
const (
	// OverrideActionDropToAlert is a OverrideAction enum value
	OverrideActionDropToAlert = "DROP_TO_ALERT"
)

Variables

This section is empty.

Functions

func AttachmentStatus_Values

func AttachmentStatus_Values() []string

AttachmentStatus_Values returns all elements of the AttachmentStatus enum

func ConfigurationSyncState_Values

func ConfigurationSyncState_Values() []string

ConfigurationSyncState_Values returns all elements of the ConfigurationSyncState enum

func EncryptionType_Values added in v1.44.1

func EncryptionType_Values() []string

EncryptionType_Values returns all elements of the EncryptionType enum

func FirewallStatusValue_Values

func FirewallStatusValue_Values() []string

FirewallStatusValue_Values returns all elements of the FirewallStatusValue enum

func GeneratedRulesType_Values

func GeneratedRulesType_Values() []string

GeneratedRulesType_Values returns all elements of the GeneratedRulesType enum

func LogDestinationType_Values

func LogDestinationType_Values() []string

LogDestinationType_Values returns all elements of the LogDestinationType enum

func LogType_Values

func LogType_Values() []string

LogType_Values returns all elements of the LogType enum

func OverrideAction_Values added in v1.42.22

func OverrideAction_Values() []string

OverrideAction_Values returns all elements of the OverrideAction enum

func PerObjectSyncStatus_Values

func PerObjectSyncStatus_Values() []string

PerObjectSyncStatus_Values returns all elements of the PerObjectSyncStatus enum

func ResourceManagedStatus_Values added in v1.42.22

func ResourceManagedStatus_Values() []string

ResourceManagedStatus_Values returns all elements of the ResourceManagedStatus enum

func ResourceManagedType_Values added in v1.44.3

func ResourceManagedType_Values() []string

ResourceManagedType_Values returns all elements of the ResourceManagedType enum

func ResourceStatus_Values

func ResourceStatus_Values() []string

ResourceStatus_Values returns all elements of the ResourceStatus enum

func RuleGroupType_Values

func RuleGroupType_Values() []string

RuleGroupType_Values returns all elements of the RuleGroupType enum

func RuleOrder_Values added in v1.40.53

func RuleOrder_Values() []string

RuleOrder_Values returns all elements of the RuleOrder enum

func StatefulAction_Values

func StatefulAction_Values() []string

StatefulAction_Values returns all elements of the StatefulAction enum

func StatefulRuleDirection_Values

func StatefulRuleDirection_Values() []string

StatefulRuleDirection_Values returns all elements of the StatefulRuleDirection enum

func StatefulRuleProtocol_Values

func StatefulRuleProtocol_Values() []string

StatefulRuleProtocol_Values returns all elements of the StatefulRuleProtocol enum

func StreamExceptionPolicy_Values added in v1.44.112

func StreamExceptionPolicy_Values() []string

StreamExceptionPolicy_Values returns all elements of the StreamExceptionPolicy enum

func TCPFlag_Values

func TCPFlag_Values() []string

TCPFlag_Values returns all elements of the TCPFlag enum

func TargetType_Values

func TargetType_Values() []string

TargetType_Values returns all elements of the TargetType enum

Types

type ActionDefinition

type ActionDefinition struct {

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

A custom action to use in stateless rule actions settings. This is used in CustomAction.

func (ActionDefinition) GoString

func (s ActionDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionDefinition) SetPublishMetricAction

func (s *ActionDefinition) SetPublishMetricAction(v *PublishMetricAction) *ActionDefinition

SetPublishMetricAction sets the PublishMetricAction field's value.

func (ActionDefinition) String

func (s ActionDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ActionDefinition) Validate

func (s *ActionDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Address

type Address struct {

	// 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.
	//
	// 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.
	//
	// For more information about CIDR notation, see the Wikipedia entry Classless
	// Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
	//
	// AddressDefinition is a required field
	AddressDefinition *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

A single IP address specification. This is used in the MatchAttributes source and destination specifications.

func (Address) GoString

func (s Address) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Address) SetAddressDefinition

func (s *Address) SetAddressDefinition(v string) *Address

SetAddressDefinition sets the AddressDefinition field's value.

func (Address) String

func (s Address) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Address) Validate

func (s *Address) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateFirewallPolicyInput

type AssociateFirewallPolicyInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the firewall policy.
	//
	// FirewallPolicyArn is a required field
	FirewallPolicyArn *string `min:"1" type:"string" required:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateFirewallPolicyInput) GoString

func (s AssociateFirewallPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFirewallPolicyInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*AssociateFirewallPolicyInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*AssociateFirewallPolicyInput) SetFirewallPolicyArn

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AssociateFirewallPolicyInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (AssociateFirewallPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFirewallPolicyInput) Validate

func (s *AssociateFirewallPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateFirewallPolicyOutput

type AssociateFirewallPolicyOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the firewall policy.
	FirewallPolicyArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateFirewallPolicyOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateFirewallPolicyOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*AssociateFirewallPolicyOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*AssociateFirewallPolicyOutput) SetFirewallPolicyArn

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*AssociateFirewallPolicyOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (AssociateFirewallPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type AssociateSubnetsInput

type AssociateSubnetsInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// The IDs of the subnets that you want to associate with the firewall.
	//
	// SubnetMappings is a required field
	SubnetMappings []*SubnetMapping `type:"list" required:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateSubnetsInput) GoString

func (s AssociateSubnetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSubnetsInput) SetFirewallArn

func (s *AssociateSubnetsInput) SetFirewallArn(v string) *AssociateSubnetsInput

SetFirewallArn sets the FirewallArn field's value.

func (*AssociateSubnetsInput) SetFirewallName

func (s *AssociateSubnetsInput) SetFirewallName(v string) *AssociateSubnetsInput

SetFirewallName sets the FirewallName field's value.

func (*AssociateSubnetsInput) SetSubnetMappings

func (s *AssociateSubnetsInput) SetSubnetMappings(v []*SubnetMapping) *AssociateSubnetsInput

SetSubnetMappings sets the SubnetMappings field's value.

func (*AssociateSubnetsInput) SetUpdateToken

func (s *AssociateSubnetsInput) SetUpdateToken(v string) *AssociateSubnetsInput

SetUpdateToken sets the UpdateToken field's value.

func (AssociateSubnetsInput) String

func (s AssociateSubnetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSubnetsInput) Validate

func (s *AssociateSubnetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type AssociateSubnetsOutput

type AssociateSubnetsOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// The IDs of the subnets that are associated with the firewall.
	SubnetMappings []*SubnetMapping `type:"list"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (AssociateSubnetsOutput) GoString

func (s AssociateSubnetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*AssociateSubnetsOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*AssociateSubnetsOutput) SetFirewallName

func (s *AssociateSubnetsOutput) SetFirewallName(v string) *AssociateSubnetsOutput

SetFirewallName sets the FirewallName field's value.

func (*AssociateSubnetsOutput) SetSubnetMappings

func (s *AssociateSubnetsOutput) SetSubnetMappings(v []*SubnetMapping) *AssociateSubnetsOutput

SetSubnetMappings sets the SubnetMappings field's value.

func (*AssociateSubnetsOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (AssociateSubnetsOutput) String

func (s AssociateSubnetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Attachment

type Attachment struct {

	// 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 *string `type:"string"`

	// 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, DELETING, or FAILED.
	Status *string `type:"string" enum:"AttachmentStatus"`

	// The unique identifier of the subnet that you've specified to be used for
	// a firewall endpoint.
	SubnetId *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (Attachment) GoString

func (s Attachment) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Attachment) SetEndpointId

func (s *Attachment) SetEndpointId(v string) *Attachment

SetEndpointId sets the EndpointId field's value.

func (*Attachment) SetStatus

func (s *Attachment) SetStatus(v string) *Attachment

SetStatus sets the Status field's value.

func (*Attachment) SetSubnetId

func (s *Attachment) SetSubnetId(v string) *Attachment

SetSubnetId sets the SubnetId field's value.

func (Attachment) String

func (s Attachment) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CIDRSummary added in v1.44.60

type CIDRSummary struct {

	// The number of CIDR blocks available for use by the IP set references in a
	// firewall.
	AvailableCIDRCount *int64 `type:"integer"`

	// The list of the IP set references used by a firewall.
	IPSetReferences map[string]*IPSetMetadata `type:"map"`

	// The number of CIDR blocks used by the IP set references in a firewall.
	UtilizedCIDRCount *int64 `type:"integer"`
	// contains filtered or unexported fields
}

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.

func (CIDRSummary) GoString added in v1.44.60

func (s CIDRSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CIDRSummary) SetAvailableCIDRCount added in v1.44.60

func (s *CIDRSummary) SetAvailableCIDRCount(v int64) *CIDRSummary

SetAvailableCIDRCount sets the AvailableCIDRCount field's value.

func (*CIDRSummary) SetIPSetReferences added in v1.44.60

func (s *CIDRSummary) SetIPSetReferences(v map[string]*IPSetMetadata) *CIDRSummary

SetIPSetReferences sets the IPSetReferences field's value.

func (*CIDRSummary) SetUtilizedCIDRCount added in v1.44.60

func (s *CIDRSummary) SetUtilizedCIDRCount(v int64) *CIDRSummary

SetUtilizedCIDRCount sets the UtilizedCIDRCount field's value.

func (CIDRSummary) String added in v1.44.60

func (s CIDRSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CapacityUsageSummary added in v1.44.60

type CapacityUsageSummary struct {

	// Describes the capacity usage of the CIDR blocks used by the IP set references
	// in a firewall.
	CIDRs *CIDRSummary `type:"structure"`
	// contains filtered or unexported fields
}

The capacity usage summary of the resources used by the ReferenceSets in a firewall.

func (CapacityUsageSummary) GoString added in v1.44.60

func (s CapacityUsageSummary) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CapacityUsageSummary) SetCIDRs added in v1.44.60

SetCIDRs sets the CIDRs field's value.

func (CapacityUsageSummary) String added in v1.44.60

func (s CapacityUsageSummary) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFirewallInput

type CreateFirewallInput struct {

	// 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 *bool `type:"boolean"`

	// A description of the firewall.
	Description *string `type:"string"`

	// A complex type that contains settings for encryption of your firewall resources.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	//
	// FirewallName is a required field
	FirewallName *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use
	// for the firewall.
	//
	// FirewallPolicyArn is a required field
	FirewallPolicyArn *string `min:"1" type:"string" required:"true"`

	// 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 *bool `type:"boolean"`

	// 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 *bool `type:"boolean"`

	// 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.
	//
	// SubnetMappings is a required field
	SubnetMappings []*SubnetMapping `type:"list" required:"true"`

	// The key:value pairs to associate with the resource.
	Tags []*Tag `min:"1" type:"list"`

	// The unique identifier of the VPC where Network Firewall should create the
	// firewall.
	//
	// You can't change this setting after you create the firewall.
	//
	// VpcId is a required field
	VpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFirewallInput) GoString

func (s CreateFirewallInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallInput) SetDeleteProtection

func (s *CreateFirewallInput) SetDeleteProtection(v bool) *CreateFirewallInput

SetDeleteProtection sets the DeleteProtection field's value.

func (*CreateFirewallInput) SetDescription

func (s *CreateFirewallInput) SetDescription(v string) *CreateFirewallInput

SetDescription sets the Description field's value.

func (*CreateFirewallInput) SetEncryptionConfiguration added in v1.44.1

func (s *CreateFirewallInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateFirewallInput

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*CreateFirewallInput) SetFirewallName

func (s *CreateFirewallInput) SetFirewallName(v string) *CreateFirewallInput

SetFirewallName sets the FirewallName field's value.

func (*CreateFirewallInput) SetFirewallPolicyArn

func (s *CreateFirewallInput) SetFirewallPolicyArn(v string) *CreateFirewallInput

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*CreateFirewallInput) SetFirewallPolicyChangeProtection

func (s *CreateFirewallInput) SetFirewallPolicyChangeProtection(v bool) *CreateFirewallInput

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*CreateFirewallInput) SetSubnetChangeProtection

func (s *CreateFirewallInput) SetSubnetChangeProtection(v bool) *CreateFirewallInput

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*CreateFirewallInput) SetSubnetMappings

func (s *CreateFirewallInput) SetSubnetMappings(v []*SubnetMapping) *CreateFirewallInput

SetSubnetMappings sets the SubnetMappings field's value.

func (*CreateFirewallInput) SetTags

func (s *CreateFirewallInput) SetTags(v []*Tag) *CreateFirewallInput

SetTags sets the Tags field's value.

func (*CreateFirewallInput) SetVpcId

SetVpcId sets the VpcId field's value.

func (CreateFirewallInput) String

func (s CreateFirewallInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallInput) Validate

func (s *CreateFirewallInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFirewallOutput

type CreateFirewallOutput struct {

	// 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 `type:"structure"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

func (CreateFirewallOutput) GoString

func (s CreateFirewallOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallOutput) SetFirewall

SetFirewall sets the Firewall field's value.

func (*CreateFirewallOutput) SetFirewallStatus

func (s *CreateFirewallOutput) SetFirewallStatus(v *FirewallStatus) *CreateFirewallOutput

SetFirewallStatus sets the FirewallStatus field's value.

func (CreateFirewallOutput) String

func (s CreateFirewallOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateFirewallPolicyInput

type CreateFirewallPolicyInput struct {

	// A description of the firewall policy.
	Description *string `type:"string"`

	// 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 *bool `type:"boolean"`

	// A complex type that contains settings for encryption of your firewall policy
	// resources.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The rule groups and policy actions to use in the firewall policy.
	//
	// FirewallPolicy is a required field
	FirewallPolicy *FirewallPolicy `type:"structure" required:"true"`

	// The descriptive name of the firewall policy. You can't change the name of
	// a firewall policy after you create it.
	//
	// FirewallPolicyName is a required field
	FirewallPolicyName *string `min:"1" type:"string" required:"true"`

	// The key:value pairs to associate with the resource.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (CreateFirewallPolicyInput) GoString

func (s CreateFirewallPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallPolicyInput) SetDescription

SetDescription sets the Description field's value.

func (*CreateFirewallPolicyInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*CreateFirewallPolicyInput) SetEncryptionConfiguration added in v1.44.1

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*CreateFirewallPolicyInput) SetFirewallPolicy

SetFirewallPolicy sets the FirewallPolicy field's value.

func (*CreateFirewallPolicyInput) SetFirewallPolicyName

func (s *CreateFirewallPolicyInput) SetFirewallPolicyName(v string) *CreateFirewallPolicyInput

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (*CreateFirewallPolicyInput) SetTags

SetTags sets the Tags field's value.

func (CreateFirewallPolicyInput) String

func (s CreateFirewallPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallPolicyInput) Validate

func (s *CreateFirewallPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateFirewallPolicyOutput

type CreateFirewallPolicyOutput struct {

	// 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.
	//
	// FirewallPolicyResponse is a required field
	FirewallPolicyResponse *FirewallPolicyResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateFirewallPolicyOutput) GoString

func (s CreateFirewallPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateFirewallPolicyOutput) SetFirewallPolicyResponse

SetFirewallPolicyResponse sets the FirewallPolicyResponse field's value.

func (*CreateFirewallPolicyOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (CreateFirewallPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CreateRuleGroupInput

type CreateRuleGroupInput struct {

	// 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.
	//
	// Capacity is a required field
	Capacity *int64 `type:"integer" required:"true"`

	// A description of the rule group.
	Description *string `type:"string"`

	// 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 *bool `type:"boolean"`

	// A complex type that contains settings for encryption of your rule group resources.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// 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 `type:"structure"`

	// The descriptive name of the rule group. You can't change the name of a rule
	// group after you create it.
	//
	// RuleGroupName is a required field
	RuleGroupName *string `min:"1" type:"string" required:"true"`

	// 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 *string `type:"string"`

	// 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 `type:"structure"`

	// The key:value pairs to associate with the resource.
	Tags []*Tag `min:"1" type:"list"`

	// 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 is a required field
	Type *string `type:"string" required:"true" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (CreateRuleGroupInput) GoString

func (s CreateRuleGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupInput) SetCapacity

func (s *CreateRuleGroupInput) SetCapacity(v int64) *CreateRuleGroupInput

SetCapacity sets the Capacity field's value.

func (*CreateRuleGroupInput) SetDescription

func (s *CreateRuleGroupInput) SetDescription(v string) *CreateRuleGroupInput

SetDescription sets the Description field's value.

func (*CreateRuleGroupInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*CreateRuleGroupInput) SetEncryptionConfiguration added in v1.44.1

func (s *CreateRuleGroupInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *CreateRuleGroupInput

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*CreateRuleGroupInput) SetRuleGroup

SetRuleGroup sets the RuleGroup field's value.

func (*CreateRuleGroupInput) SetRuleGroupName

func (s *CreateRuleGroupInput) SetRuleGroupName(v string) *CreateRuleGroupInput

SetRuleGroupName sets the RuleGroupName field's value.

func (*CreateRuleGroupInput) SetRules

SetRules sets the Rules field's value.

func (*CreateRuleGroupInput) SetSourceMetadata added in v1.44.3

func (s *CreateRuleGroupInput) SetSourceMetadata(v *SourceMetadata) *CreateRuleGroupInput

SetSourceMetadata sets the SourceMetadata field's value.

func (*CreateRuleGroupInput) SetTags

func (s *CreateRuleGroupInput) SetTags(v []*Tag) *CreateRuleGroupInput

SetTags sets the Tags field's value.

func (*CreateRuleGroupInput) SetType

SetType sets the Type field's value.

func (CreateRuleGroupInput) String

func (s CreateRuleGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupInput) Validate

func (s *CreateRuleGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type CreateRuleGroupOutput

type CreateRuleGroupOutput struct {

	// 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.
	//
	// RuleGroupResponse is a required field
	RuleGroupResponse *RuleGroupResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (CreateRuleGroupOutput) GoString

func (s CreateRuleGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CreateRuleGroupOutput) SetRuleGroupResponse

func (s *CreateRuleGroupOutput) SetRuleGroupResponse(v *RuleGroupResponse) *CreateRuleGroupOutput

SetRuleGroupResponse sets the RuleGroupResponse field's value.

func (*CreateRuleGroupOutput) SetUpdateToken

func (s *CreateRuleGroupOutput) SetUpdateToken(v string) *CreateRuleGroupOutput

SetUpdateToken sets the UpdateToken field's value.

func (CreateRuleGroupOutput) String

func (s CreateRuleGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type CustomAction

type CustomAction struct {

	// The custom action associated with the action name.
	//
	// ActionDefinition is a required field
	ActionDefinition *ActionDefinition `type:"structure" required:"true"`

	// The descriptive name of the custom action. You can't change the name of a
	// custom action after you create it.
	//
	// ActionName is a required field
	ActionName *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (CustomAction) GoString

func (s CustomAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomAction) SetActionDefinition

func (s *CustomAction) SetActionDefinition(v *ActionDefinition) *CustomAction

SetActionDefinition sets the ActionDefinition field's value.

func (*CustomAction) SetActionName

func (s *CustomAction) SetActionName(v string) *CustomAction

SetActionName sets the ActionName field's value.

func (CustomAction) String

func (s CustomAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*CustomAction) Validate

func (s *CustomAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFirewallInput

type DeleteFirewallInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteFirewallInput) GoString

func (s DeleteFirewallInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallInput) SetFirewallArn

func (s *DeleteFirewallInput) SetFirewallArn(v string) *DeleteFirewallInput

SetFirewallArn sets the FirewallArn field's value.

func (*DeleteFirewallInput) SetFirewallName

func (s *DeleteFirewallInput) SetFirewallName(v string) *DeleteFirewallInput

SetFirewallName sets the FirewallName field's value.

func (DeleteFirewallInput) String

func (s DeleteFirewallInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallInput) Validate

func (s *DeleteFirewallInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFirewallOutput

type DeleteFirewallOutput struct {

	// 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.
	Firewall *Firewall `type:"structure"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

func (DeleteFirewallOutput) GoString

func (s DeleteFirewallOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallOutput) SetFirewall

SetFirewall sets the Firewall field's value.

func (*DeleteFirewallOutput) SetFirewallStatus

func (s *DeleteFirewallOutput) SetFirewallStatus(v *FirewallStatus) *DeleteFirewallOutput

SetFirewallStatus sets the FirewallStatus field's value.

func (DeleteFirewallOutput) String

func (s DeleteFirewallOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteFirewallPolicyInput

type DeleteFirewallPolicyInput struct {

	// The Amazon Resource Name (ARN) of the firewall policy.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallPolicyArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DeleteFirewallPolicyInput) GoString

func (s DeleteFirewallPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallPolicyInput) SetFirewallPolicyArn

func (s *DeleteFirewallPolicyInput) SetFirewallPolicyArn(v string) *DeleteFirewallPolicyInput

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*DeleteFirewallPolicyInput) SetFirewallPolicyName

func (s *DeleteFirewallPolicyInput) SetFirewallPolicyName(v string) *DeleteFirewallPolicyInput

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (DeleteFirewallPolicyInput) String

func (s DeleteFirewallPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallPolicyInput) Validate

func (s *DeleteFirewallPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteFirewallPolicyOutput

type DeleteFirewallPolicyOutput struct {

	// The object containing the definition of the FirewallPolicyResponse that you
	// asked to delete.
	//
	// FirewallPolicyResponse is a required field
	FirewallPolicyResponse *FirewallPolicyResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteFirewallPolicyOutput) GoString

func (s DeleteFirewallPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteFirewallPolicyOutput) SetFirewallPolicyResponse

SetFirewallPolicyResponse sets the FirewallPolicyResponse field's value.

func (DeleteFirewallPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteResourcePolicyInput

type DeleteResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the rule group or firewall policy whose
	// resource policy you want to delete.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyInput) GoString

func (s DeleteResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (DeleteResourcePolicyInput) String

func (s DeleteResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteResourcePolicyInput) Validate

func (s *DeleteResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteResourcePolicyOutput

type DeleteResourcePolicyOutput struct {
	// contains filtered or unexported fields
}

func (DeleteResourcePolicyOutput) GoString

func (s DeleteResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (DeleteResourcePolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DeleteRuleGroupInput

type DeleteRuleGroupInput struct {

	// The Amazon Resource Name (ARN) of the rule group.
	//
	// You must specify the ARN or the name, and you can specify both.
	RuleGroupArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (DeleteRuleGroupInput) GoString

func (s DeleteRuleGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleGroupInput) SetRuleGroupArn

func (s *DeleteRuleGroupInput) SetRuleGroupArn(v string) *DeleteRuleGroupInput

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*DeleteRuleGroupInput) SetRuleGroupName

func (s *DeleteRuleGroupInput) SetRuleGroupName(v string) *DeleteRuleGroupInput

SetRuleGroupName sets the RuleGroupName field's value.

func (*DeleteRuleGroupInput) SetType

SetType sets the Type field's value.

func (DeleteRuleGroupInput) String

func (s DeleteRuleGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleGroupInput) Validate

func (s *DeleteRuleGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DeleteRuleGroupOutput

type DeleteRuleGroupOutput struct {

	// 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.
	//
	// RuleGroupResponse is a required field
	RuleGroupResponse *RuleGroupResponse `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

func (DeleteRuleGroupOutput) GoString

func (s DeleteRuleGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DeleteRuleGroupOutput) SetRuleGroupResponse

func (s *DeleteRuleGroupOutput) SetRuleGroupResponse(v *RuleGroupResponse) *DeleteRuleGroupOutput

SetRuleGroupResponse sets the RuleGroupResponse field's value.

func (DeleteRuleGroupOutput) String

func (s DeleteRuleGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFirewallInput

type DescribeFirewallInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFirewallInput) GoString

func (s DescribeFirewallInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallInput) SetFirewallArn

func (s *DescribeFirewallInput) SetFirewallArn(v string) *DescribeFirewallInput

SetFirewallArn sets the FirewallArn field's value.

func (*DescribeFirewallInput) SetFirewallName

func (s *DescribeFirewallInput) SetFirewallName(v string) *DescribeFirewallInput

SetFirewallName sets the FirewallName field's value.

func (DescribeFirewallInput) String

func (s DescribeFirewallInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallInput) Validate

func (s *DescribeFirewallInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFirewallOutput

type DescribeFirewallOutput struct {

	// 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 `type:"structure"`

	// 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 `type:"structure"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFirewallOutput) GoString

func (s DescribeFirewallOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallOutput) SetFirewall

SetFirewall sets the Firewall field's value.

func (*DescribeFirewallOutput) SetFirewallStatus

SetFirewallStatus sets the FirewallStatus field's value.

func (*DescribeFirewallOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (DescribeFirewallOutput) String

func (s DescribeFirewallOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeFirewallPolicyInput

type DescribeFirewallPolicyInput struct {

	// The Amazon Resource Name (ARN) of the firewall policy.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallPolicyArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeFirewallPolicyInput) GoString

func (s DescribeFirewallPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallPolicyInput) SetFirewallPolicyArn

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*DescribeFirewallPolicyInput) SetFirewallPolicyName

func (s *DescribeFirewallPolicyInput) SetFirewallPolicyName(v string) *DescribeFirewallPolicyInput

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (DescribeFirewallPolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallPolicyInput) Validate

func (s *DescribeFirewallPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeFirewallPolicyOutput

type DescribeFirewallPolicyOutput struct {

	// The policy for the specified firewall policy.
	FirewallPolicy *FirewallPolicy `type:"structure"`

	// 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.
	//
	// FirewallPolicyResponse is a required field
	FirewallPolicyResponse *FirewallPolicyResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeFirewallPolicyOutput) GoString

func (s DescribeFirewallPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeFirewallPolicyOutput) SetFirewallPolicy

SetFirewallPolicy sets the FirewallPolicy field's value.

func (*DescribeFirewallPolicyOutput) SetFirewallPolicyResponse

SetFirewallPolicyResponse sets the FirewallPolicyResponse field's value.

func (*DescribeFirewallPolicyOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (DescribeFirewallPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeLoggingConfigurationInput

type DescribeLoggingConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeLoggingConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*DescribeLoggingConfigurationInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (DescribeLoggingConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type DescribeLoggingConfigurationOutput

type DescribeLoggingConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// Defines how Network Firewall performs logging for a Firewall.
	LoggingConfiguration *LoggingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (DescribeLoggingConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeLoggingConfigurationOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*DescribeLoggingConfigurationOutput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (DescribeLoggingConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeResourcePolicyInput

type DescribeResourcePolicyInput struct {

	// The Amazon Resource Name (ARN) of the rule group or firewall policy whose
	// resource policy you want to retrieve.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeResourcePolicyInput) GoString

func (s DescribeResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (DescribeResourcePolicyInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyInput) Validate

func (s *DescribeResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeResourcePolicyOutput

type DescribeResourcePolicyOutput struct {

	// The IAM policy for the resource.
	Policy *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DescribeResourcePolicyOutput) GoString

func (s DescribeResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeResourcePolicyOutput) SetPolicy

SetPolicy sets the Policy field's value.

func (DescribeResourcePolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRuleGroupInput

type DescribeRuleGroupInput struct {

	// The Amazon Resource Name (ARN) of the rule group.
	//
	// You must specify the ARN or the name, and you can specify both.
	RuleGroupArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (DescribeRuleGroupInput) GoString

func (s DescribeRuleGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupInput) SetRuleGroupArn

func (s *DescribeRuleGroupInput) SetRuleGroupArn(v string) *DescribeRuleGroupInput

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*DescribeRuleGroupInput) SetRuleGroupName

func (s *DescribeRuleGroupInput) SetRuleGroupName(v string) *DescribeRuleGroupInput

SetRuleGroupName sets the RuleGroupName field's value.

func (*DescribeRuleGroupInput) SetType

SetType sets the Type field's value.

func (DescribeRuleGroupInput) String

func (s DescribeRuleGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupInput) Validate

func (s *DescribeRuleGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRuleGroupMetadataInput added in v1.42.22

type DescribeRuleGroupMetadataInput struct {

	// 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 *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (DescribeRuleGroupMetadataInput) GoString added in v1.42.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupMetadataInput) SetRuleGroupArn added in v1.42.22

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*DescribeRuleGroupMetadataInput) SetRuleGroupName added in v1.42.22

SetRuleGroupName sets the RuleGroupName field's value.

func (*DescribeRuleGroupMetadataInput) SetType added in v1.42.22

SetType sets the Type field's value.

func (DescribeRuleGroupMetadataInput) String added in v1.42.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupMetadataInput) Validate added in v1.42.22

func (s *DescribeRuleGroupMetadataInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DescribeRuleGroupMetadataOutput added in v1.42.22

type DescribeRuleGroupMetadataOutput struct {

	// 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 *int64 `type:"integer"`

	// Returns the metadata objects for the specified rule group.
	Description *string `type:"string"`

	// The last time that the rule group was changed.
	LastModifiedTime *time.Time `type:"timestamp"`

	// 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 is a required field
	RuleGroupArn *string `min:"1" type:"string" required:"true"`

	// 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 is a required field
	RuleGroupName *string `min:"1" type:"string" required:"true"`

	// Additional options governing how Network Firewall handles the rule group.
	// You can only use these for stateful rule groups.
	StatefulRuleOptions *StatefulRuleOptions `type:"structure"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (DescribeRuleGroupMetadataOutput) GoString added in v1.42.22

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupMetadataOutput) SetCapacity added in v1.42.22

SetCapacity sets the Capacity field's value.

func (*DescribeRuleGroupMetadataOutput) SetDescription added in v1.42.22

SetDescription sets the Description field's value.

func (*DescribeRuleGroupMetadataOutput) SetLastModifiedTime added in v1.44.3

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*DescribeRuleGroupMetadataOutput) SetRuleGroupArn added in v1.42.22

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*DescribeRuleGroupMetadataOutput) SetRuleGroupName added in v1.42.22

SetRuleGroupName sets the RuleGroupName field's value.

func (*DescribeRuleGroupMetadataOutput) SetStatefulRuleOptions added in v1.42.22

SetStatefulRuleOptions sets the StatefulRuleOptions field's value.

func (*DescribeRuleGroupMetadataOutput) SetType added in v1.42.22

SetType sets the Type field's value.

func (DescribeRuleGroupMetadataOutput) String added in v1.42.22

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type DescribeRuleGroupOutput

type DescribeRuleGroupOutput struct {

	// 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 `type:"structure"`

	// 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.
	//
	// RuleGroupResponse is a required field
	RuleGroupResponse *RuleGroupResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (DescribeRuleGroupOutput) GoString

func (s DescribeRuleGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DescribeRuleGroupOutput) SetRuleGroup

SetRuleGroup sets the RuleGroup field's value.

func (*DescribeRuleGroupOutput) SetRuleGroupResponse

SetRuleGroupResponse sets the RuleGroupResponse field's value.

func (*DescribeRuleGroupOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (DescribeRuleGroupOutput) String

func (s DescribeRuleGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Dimension

type Dimension struct {

	// The value to use in the custom metric dimension.
	//
	// Value is a required field
	Value *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the Amazon CloudWatch User Guide (https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html).

func (Dimension) GoString

func (s Dimension) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dimension) SetValue

func (s *Dimension) SetValue(v string) *Dimension

SetValue sets the Value field's value.

func (Dimension) String

func (s Dimension) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Dimension) Validate

func (s *Dimension) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateSubnetsInput

type DisassociateSubnetsInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// The unique identifiers for the subnets that you want to disassociate.
	//
	// SubnetIds is a required field
	SubnetIds []*string `type:"list" required:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateSubnetsInput) GoString

func (s DisassociateSubnetsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateSubnetsInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*DisassociateSubnetsInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*DisassociateSubnetsInput) SetSubnetIds

SetSubnetIds sets the SubnetIds field's value.

func (*DisassociateSubnetsInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (DisassociateSubnetsInput) String

func (s DisassociateSubnetsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateSubnetsInput) Validate

func (s *DisassociateSubnetsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type DisassociateSubnetsOutput

type DisassociateSubnetsOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// The IDs of the subnets that are associated with the firewall.
	SubnetMappings []*SubnetMapping `type:"list"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (DisassociateSubnetsOutput) GoString

func (s DisassociateSubnetsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*DisassociateSubnetsOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*DisassociateSubnetsOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*DisassociateSubnetsOutput) SetSubnetMappings

SetSubnetMappings sets the SubnetMappings field's value.

func (*DisassociateSubnetsOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (DisassociateSubnetsOutput) String

func (s DisassociateSubnetsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type EncryptionConfiguration added in v1.44.1

type EncryptionConfiguration struct {

	// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/concepts.html#key-id)
	// in the Amazon Web Services KMS Developer Guide.
	KeyId *string `min:"1" type:"string"`

	// The type of Amazon Web Services KMS key to use for encryption of your Network
	// Firewall resources.
	//
	// Type is a required field
	Type *string `type:"string" required:"true" enum:"EncryptionType"`
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html) in the Network Firewall Developer Guide.

func (EncryptionConfiguration) GoString added in v1.44.1

func (s EncryptionConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) SetKeyId added in v1.44.1

SetKeyId sets the KeyId field's value.

func (*EncryptionConfiguration) SetType added in v1.44.1

SetType sets the Type field's value.

func (EncryptionConfiguration) String added in v1.44.1

func (s EncryptionConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*EncryptionConfiguration) Validate added in v1.44.1

func (s *EncryptionConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Firewall

type Firewall struct {

	// 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 *bool `type:"boolean"`

	// A description of the firewall.
	Description *string `type:"string"`

	// A complex type that contains the Amazon Web Services KMS encryption configuration
	// settings for your firewall.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The unique identifier for the firewall.
	//
	// FirewallId is a required field
	FirewallId *string `min:"36" type:"string" required:"true"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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.
	//
	// FirewallPolicyArn is a required field
	FirewallPolicyArn *string `min:"1" type:"string" required:"true"`

	// 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 *bool `type:"boolean"`

	// 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 *bool `type:"boolean"`

	// The public subnets that Network Firewall is using for the firewall. Each
	// subnet must belong to a different Availability Zone.
	//
	// SubnetMappings is a required field
	SubnetMappings []*SubnetMapping `type:"list" required:"true"`

	Tags []*Tag `min:"1" type:"list"`

	// The unique identifier of the VPC where the firewall is in use.
	//
	// VpcId is a required field
	VpcId *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (Firewall) GoString

func (s Firewall) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Firewall) SetDeleteProtection

func (s *Firewall) SetDeleteProtection(v bool) *Firewall

SetDeleteProtection sets the DeleteProtection field's value.

func (*Firewall) SetDescription

func (s *Firewall) SetDescription(v string) *Firewall

SetDescription sets the Description field's value.

func (*Firewall) SetEncryptionConfiguration added in v1.44.1

func (s *Firewall) SetEncryptionConfiguration(v *EncryptionConfiguration) *Firewall

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*Firewall) SetFirewallArn

func (s *Firewall) SetFirewallArn(v string) *Firewall

SetFirewallArn sets the FirewallArn field's value.

func (*Firewall) SetFirewallId

func (s *Firewall) SetFirewallId(v string) *Firewall

SetFirewallId sets the FirewallId field's value.

func (*Firewall) SetFirewallName

func (s *Firewall) SetFirewallName(v string) *Firewall

SetFirewallName sets the FirewallName field's value.

func (*Firewall) SetFirewallPolicyArn

func (s *Firewall) SetFirewallPolicyArn(v string) *Firewall

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*Firewall) SetFirewallPolicyChangeProtection

func (s *Firewall) SetFirewallPolicyChangeProtection(v bool) *Firewall

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*Firewall) SetSubnetChangeProtection

func (s *Firewall) SetSubnetChangeProtection(v bool) *Firewall

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*Firewall) SetSubnetMappings

func (s *Firewall) SetSubnetMappings(v []*SubnetMapping) *Firewall

SetSubnetMappings sets the SubnetMappings field's value.

func (*Firewall) SetTags

func (s *Firewall) SetTags(v []*Tag) *Firewall

SetTags sets the Tags field's value.

func (*Firewall) SetVpcId

func (s *Firewall) SetVpcId(v string) *Firewall

SetVpcId sets the VpcId field's value.

func (Firewall) String

func (s Firewall) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallMetadata

type FirewallMetadata struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (FirewallMetadata) GoString

func (s FirewallMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallMetadata) SetFirewallArn

func (s *FirewallMetadata) SetFirewallArn(v string) *FirewallMetadata

SetFirewallArn sets the FirewallArn field's value.

func (*FirewallMetadata) SetFirewallName

func (s *FirewallMetadata) SetFirewallName(v string) *FirewallMetadata

SetFirewallName sets the FirewallName field's value.

func (FirewallMetadata) String

func (s FirewallMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicy

type FirewallPolicy struct {

	// 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 (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html)
	// in the Network Firewall Developer Guide.
	StatefulDefaultActions []*string `type:"list"`

	// 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 `type:"structure"`

	// References to the stateful rule groups that are used in the policy. These
	// define the inspection criteria in stateful rules.
	StatefulRuleGroupReferences []*StatefulRuleGroupReference `type:"list"`

	// 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 []*CustomAction `type:"list"`

	// 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.
	//
	// StatelessDefaultActions is a required field
	StatelessDefaultActions []*string `type:"list" required:"true"`

	// 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.
	//
	// StatelessFragmentDefaultActions is a required field
	StatelessFragmentDefaultActions []*string `type:"list" required:"true"`

	// References to the stateless rule groups that are used in the policy. These
	// define the matching criteria in stateless rules.
	StatelessRuleGroupReferences []*StatelessRuleGroupReference `type:"list"`
	// contains filtered or unexported fields
}

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.

func (FirewallPolicy) GoString

func (s FirewallPolicy) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicy) SetStatefulDefaultActions added in v1.40.53

func (s *FirewallPolicy) SetStatefulDefaultActions(v []*string) *FirewallPolicy

SetStatefulDefaultActions sets the StatefulDefaultActions field's value.

func (*FirewallPolicy) SetStatefulEngineOptions added in v1.40.53

func (s *FirewallPolicy) SetStatefulEngineOptions(v *StatefulEngineOptions) *FirewallPolicy

SetStatefulEngineOptions sets the StatefulEngineOptions field's value.

func (*FirewallPolicy) SetStatefulRuleGroupReferences

func (s *FirewallPolicy) SetStatefulRuleGroupReferences(v []*StatefulRuleGroupReference) *FirewallPolicy

SetStatefulRuleGroupReferences sets the StatefulRuleGroupReferences field's value.

func (*FirewallPolicy) SetStatelessCustomActions

func (s *FirewallPolicy) SetStatelessCustomActions(v []*CustomAction) *FirewallPolicy

SetStatelessCustomActions sets the StatelessCustomActions field's value.

func (*FirewallPolicy) SetStatelessDefaultActions

func (s *FirewallPolicy) SetStatelessDefaultActions(v []*string) *FirewallPolicy

SetStatelessDefaultActions sets the StatelessDefaultActions field's value.

func (*FirewallPolicy) SetStatelessFragmentDefaultActions

func (s *FirewallPolicy) SetStatelessFragmentDefaultActions(v []*string) *FirewallPolicy

SetStatelessFragmentDefaultActions sets the StatelessFragmentDefaultActions field's value.

func (*FirewallPolicy) SetStatelessRuleGroupReferences

func (s *FirewallPolicy) SetStatelessRuleGroupReferences(v []*StatelessRuleGroupReference) *FirewallPolicy

SetStatelessRuleGroupReferences sets the StatelessRuleGroupReferences field's value.

func (FirewallPolicy) String

func (s FirewallPolicy) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicy) Validate

func (s *FirewallPolicy) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type FirewallPolicyMetadata

type FirewallPolicyMetadata struct {

	// The Amazon Resource Name (ARN) of the firewall policy.
	Arn *string `min:"1" type:"string"`

	// The descriptive name of the firewall policy. You can't change the name of
	// a firewall policy after you create it.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (FirewallPolicyMetadata) GoString

func (s FirewallPolicyMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyMetadata) SetArn

SetArn sets the Arn field's value.

func (*FirewallPolicyMetadata) SetName

SetName sets the Name field's value.

func (FirewallPolicyMetadata) String

func (s FirewallPolicyMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallPolicyResponse

type FirewallPolicyResponse struct {

	// The number of capacity units currently consumed by the policy's stateful
	// rules.
	ConsumedStatefulRuleCapacity *int64 `type:"integer"`

	// The number of capacity units currently consumed by the policy's stateless
	// rules.
	ConsumedStatelessRuleCapacity *int64 `type:"integer"`

	// A description of the firewall policy.
	Description *string `type:"string"`

	// A complex type that contains the Amazon Web Services KMS encryption configuration
	// settings for your firewall policy.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// 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.
	//
	// FirewallPolicyArn is a required field
	FirewallPolicyArn *string `min:"1" type:"string" required:"true"`

	// The unique identifier for the firewall policy.
	//
	// FirewallPolicyId is a required field
	FirewallPolicyId *string `min:"36" type:"string" required:"true"`

	// The descriptive name of the firewall policy. You can't change the name of
	// a firewall policy after you create it.
	//
	// FirewallPolicyName is a required field
	FirewallPolicyName *string `min:"1" type:"string" required:"true"`

	// 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 *string `type:"string" enum:"ResourceStatus"`

	// The last time that the firewall policy was changed.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The number of firewalls that are associated with this firewall policy.
	NumberOfAssociations *int64 `type:"integer"`

	// The key:value pairs to associate with the resource.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

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.

func (FirewallPolicyResponse) GoString

func (s FirewallPolicyResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallPolicyResponse) SetConsumedStatefulRuleCapacity added in v1.40.53

func (s *FirewallPolicyResponse) SetConsumedStatefulRuleCapacity(v int64) *FirewallPolicyResponse

SetConsumedStatefulRuleCapacity sets the ConsumedStatefulRuleCapacity field's value.

func (*FirewallPolicyResponse) SetConsumedStatelessRuleCapacity added in v1.40.53

func (s *FirewallPolicyResponse) SetConsumedStatelessRuleCapacity(v int64) *FirewallPolicyResponse

SetConsumedStatelessRuleCapacity sets the ConsumedStatelessRuleCapacity field's value.

func (*FirewallPolicyResponse) SetDescription

SetDescription sets the Description field's value.

func (*FirewallPolicyResponse) SetEncryptionConfiguration added in v1.44.1

func (s *FirewallPolicyResponse) SetEncryptionConfiguration(v *EncryptionConfiguration) *FirewallPolicyResponse

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*FirewallPolicyResponse) SetFirewallPolicyArn

func (s *FirewallPolicyResponse) SetFirewallPolicyArn(v string) *FirewallPolicyResponse

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*FirewallPolicyResponse) SetFirewallPolicyId

func (s *FirewallPolicyResponse) SetFirewallPolicyId(v string) *FirewallPolicyResponse

SetFirewallPolicyId sets the FirewallPolicyId field's value.

func (*FirewallPolicyResponse) SetFirewallPolicyName

func (s *FirewallPolicyResponse) SetFirewallPolicyName(v string) *FirewallPolicyResponse

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (*FirewallPolicyResponse) SetFirewallPolicyStatus

func (s *FirewallPolicyResponse) SetFirewallPolicyStatus(v string) *FirewallPolicyResponse

SetFirewallPolicyStatus sets the FirewallPolicyStatus field's value.

func (*FirewallPolicyResponse) SetLastModifiedTime added in v1.44.3

func (s *FirewallPolicyResponse) SetLastModifiedTime(v time.Time) *FirewallPolicyResponse

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*FirewallPolicyResponse) SetNumberOfAssociations added in v1.40.53

func (s *FirewallPolicyResponse) SetNumberOfAssociations(v int64) *FirewallPolicyResponse

SetNumberOfAssociations sets the NumberOfAssociations field's value.

func (*FirewallPolicyResponse) SetTags

SetTags sets the Tags field's value.

func (FirewallPolicyResponse) String

func (s FirewallPolicyResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type FirewallStatus

type FirewallStatus struct {

	// 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 `type:"structure"`

	// 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.
	//
	// ConfigurationSyncStateSummary is a required field
	ConfigurationSyncStateSummary *string `type:"string" required:"true" enum:"ConfigurationSyncState"`

	// 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.
	//
	// Status is a required field
	Status *string `type:"string" required:"true" enum:"FirewallStatusValue"`

	// 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 map[string]*SyncState `type:"map"`
	// contains filtered or unexported fields
}

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.

func (FirewallStatus) GoString

func (s FirewallStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*FirewallStatus) SetCapacityUsageSummary added in v1.44.60

func (s *FirewallStatus) SetCapacityUsageSummary(v *CapacityUsageSummary) *FirewallStatus

SetCapacityUsageSummary sets the CapacityUsageSummary field's value.

func (*FirewallStatus) SetConfigurationSyncStateSummary

func (s *FirewallStatus) SetConfigurationSyncStateSummary(v string) *FirewallStatus

SetConfigurationSyncStateSummary sets the ConfigurationSyncStateSummary field's value.

func (*FirewallStatus) SetStatus

func (s *FirewallStatus) SetStatus(v string) *FirewallStatus

SetStatus sets the Status field's value.

func (*FirewallStatus) SetSyncStates

func (s *FirewallStatus) SetSyncStates(v map[string]*SyncState) *FirewallStatus

SetSyncStates sets the SyncStates field's value.

func (FirewallStatus) String

func (s FirewallStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type Header struct {

	// 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.
	//
	// 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.
	//
	// For more information about CIDR notation, see the Wikipedia entry Classless
	// Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
	//
	// Destination is a required field
	Destination *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// DestinationPort is a required field
	DestinationPort *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Direction is a required field
	Direction *string `type:"string" required:"true" enum:"StatefulRuleDirection"`

	// 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.
	//
	// Protocol is a required field
	Protocol *string `type:"string" required:"true" enum:"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.
	//
	// 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.
	//
	// For more information about CIDR notation, see the Wikipedia entry Classless
	// Inter-Domain Routing (https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing).
	//
	// Source is a required field
	Source *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// SourcePort is a required field
	SourcePort *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (Header) GoString

func (s Header) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Header) SetDestination

func (s *Header) SetDestination(v string) *Header

SetDestination sets the Destination field's value.

func (*Header) SetDestinationPort

func (s *Header) SetDestinationPort(v string) *Header

SetDestinationPort sets the DestinationPort field's value.

func (*Header) SetDirection

func (s *Header) SetDirection(v string) *Header

SetDirection sets the Direction field's value.

func (*Header) SetProtocol

func (s *Header) SetProtocol(v string) *Header

SetProtocol sets the Protocol field's value.

func (*Header) SetSource

func (s *Header) SetSource(v string) *Header

SetSource sets the Source field's value.

func (*Header) SetSourcePort

func (s *Header) SetSourcePort(v string) *Header

SetSourcePort sets the SourcePort field's value.

func (Header) String

func (s Header) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Header) Validate

func (s *Header) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IPSet

type IPSet struct {

	// The list of IP addresses and address ranges, in CIDR notation.
	//
	// Definition is a required field
	Definition []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (IPSet) GoString

func (s IPSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPSet) SetDefinition

func (s *IPSet) SetDefinition(v []*string) *IPSet

SetDefinition sets the Definition field's value.

func (IPSet) String

func (s IPSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPSet) Validate

func (s *IPSet) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type IPSetMetadata added in v1.44.60

type IPSetMetadata struct {

	// 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 *int64 `type:"integer"`
	// contains filtered or unexported fields
}

General information about the IP set.

func (IPSetMetadata) GoString added in v1.44.60

func (s IPSetMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPSetMetadata) SetResolvedCIDRCount added in v1.44.60

func (s *IPSetMetadata) SetResolvedCIDRCount(v int64) *IPSetMetadata

SetResolvedCIDRCount sets the ResolvedCIDRCount field's value.

func (IPSetMetadata) String added in v1.44.60

func (s IPSetMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type IPSetReference added in v1.44.60

type IPSetReference struct {

	// The Amazon Resource Name (ARN) of the resource that you are referencing in
	// your rule group.
	ReferenceArn *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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 a resource 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 IP set 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 (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references) in the Network Firewall Developer Guide.

Network Firewall currently supports only Amazon VPC prefix lists (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) as IP set references.

func (IPSetReference) GoString added in v1.44.60

func (s IPSetReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPSetReference) SetReferenceArn added in v1.44.60

func (s *IPSetReference) SetReferenceArn(v string) *IPSetReference

SetReferenceArn sets the ReferenceArn field's value.

func (IPSetReference) String added in v1.44.60

func (s IPSetReference) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*IPSetReference) Validate added in v1.44.60

func (s *IPSetReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type InsufficientCapacityException

type InsufficientCapacityException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

func (*InsufficientCapacityException) Code

Code returns the exception type name.

func (*InsufficientCapacityException) Error

func (InsufficientCapacityException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InsufficientCapacityException) Message

Message returns the exception's message.

func (*InsufficientCapacityException) OrigErr

func (s *InsufficientCapacityException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InsufficientCapacityException) RequestID

func (s *InsufficientCapacityException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InsufficientCapacityException) StatusCode

func (s *InsufficientCapacityException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InsufficientCapacityException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InternalServerError

type InternalServerError struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

func (*InternalServerError) Code

func (s *InternalServerError) Code() string

Code returns the exception type name.

func (*InternalServerError) Error

func (s *InternalServerError) Error() string

func (InternalServerError) GoString

func (s InternalServerError) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InternalServerError) Message

func (s *InternalServerError) Message() string

Message returns the exception's message.

func (*InternalServerError) OrigErr

func (s *InternalServerError) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InternalServerError) RequestID

func (s *InternalServerError) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InternalServerError) StatusCode

func (s *InternalServerError) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InternalServerError) String

func (s InternalServerError) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidOperationException

type InvalidOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidOperationException) Code

Code returns the exception type name.

func (*InvalidOperationException) Error

func (s *InvalidOperationException) Error() string

func (InvalidOperationException) GoString

func (s InvalidOperationException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidOperationException) Message

func (s *InvalidOperationException) Message() string

Message returns the exception's message.

func (*InvalidOperationException) OrigErr

func (s *InvalidOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidOperationException) RequestID

func (s *InvalidOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidOperationException) StatusCode

func (s *InvalidOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidOperationException) String

func (s InvalidOperationException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidRequestException

type InvalidRequestException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

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.

func (*InvalidRequestException) Code

func (s *InvalidRequestException) Code() string

Code returns the exception type name.

func (*InvalidRequestException) Error

func (s *InvalidRequestException) Error() string

func (InvalidRequestException) GoString

func (s InvalidRequestException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidRequestException) Message

func (s *InvalidRequestException) Message() string

Message returns the exception's message.

func (*InvalidRequestException) OrigErr

func (s *InvalidRequestException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidRequestException) RequestID

func (s *InvalidRequestException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidRequestException) StatusCode

func (s *InvalidRequestException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidRequestException) String

func (s InvalidRequestException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidResourcePolicyException

type InvalidResourcePolicyException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The policy statement failed validation.

func (*InvalidResourcePolicyException) Code

Code returns the exception type name.

func (*InvalidResourcePolicyException) Error

func (InvalidResourcePolicyException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidResourcePolicyException) Message

Message returns the exception's message.

func (*InvalidResourcePolicyException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidResourcePolicyException) RequestID

func (s *InvalidResourcePolicyException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidResourcePolicyException) StatusCode

func (s *InvalidResourcePolicyException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidResourcePolicyException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type InvalidTokenException

type InvalidTokenException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The token you provided is stale or isn't valid for the operation.

func (*InvalidTokenException) Code

func (s *InvalidTokenException) Code() string

Code returns the exception type name.

func (*InvalidTokenException) Error

func (s *InvalidTokenException) Error() string

func (InvalidTokenException) GoString

func (s InvalidTokenException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*InvalidTokenException) Message

func (s *InvalidTokenException) Message() string

Message returns the exception's message.

func (*InvalidTokenException) OrigErr

func (s *InvalidTokenException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*InvalidTokenException) RequestID

func (s *InvalidTokenException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*InvalidTokenException) StatusCode

func (s *InvalidTokenException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (InvalidTokenException) String

func (s InvalidTokenException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LimitExceededException

type LimitExceededException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unable to perform the operation because doing so would violate a limit setting.

func (*LimitExceededException) Code

func (s *LimitExceededException) Code() string

Code returns the exception type name.

func (*LimitExceededException) Error

func (s *LimitExceededException) Error() string

func (LimitExceededException) GoString

func (s LimitExceededException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LimitExceededException) Message

func (s *LimitExceededException) Message() string

Message returns the exception's message.

func (*LimitExceededException) OrigErr

func (s *LimitExceededException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LimitExceededException) RequestID

func (s *LimitExceededException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*LimitExceededException) StatusCode

func (s *LimitExceededException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LimitExceededException) String

func (s LimitExceededException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFirewallPoliciesInput

type ListFirewallPoliciesInput struct {

	// 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 *int64 `min:"1" type:"integer"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFirewallPoliciesInput) GoString

func (s ListFirewallPoliciesInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallPoliciesInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListFirewallPoliciesInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFirewallPoliciesInput) String

func (s ListFirewallPoliciesInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallPoliciesInput) Validate

func (s *ListFirewallPoliciesInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFirewallPoliciesOutput

type ListFirewallPoliciesOutput struct {

	// 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 []*FirewallPolicyMetadata `type:"list"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFirewallPoliciesOutput) GoString

func (s ListFirewallPoliciesOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallPoliciesOutput) SetFirewallPolicies

SetFirewallPolicies sets the FirewallPolicies field's value.

func (*ListFirewallPoliciesOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (ListFirewallPoliciesOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListFirewallsInput

type ListFirewallsInput struct {

	// 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 *int64 `min:"1" type:"integer"`

	// 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 *string `min:"1" type:"string"`

	// 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 []*string `type:"list"`
	// contains filtered or unexported fields
}

func (ListFirewallsInput) GoString

func (s ListFirewallsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallsInput) SetMaxResults

func (s *ListFirewallsInput) SetMaxResults(v int64) *ListFirewallsInput

SetMaxResults sets the MaxResults field's value.

func (*ListFirewallsInput) SetNextToken

func (s *ListFirewallsInput) SetNextToken(v string) *ListFirewallsInput

SetNextToken sets the NextToken field's value.

func (*ListFirewallsInput) SetVpcIds

func (s *ListFirewallsInput) SetVpcIds(v []*string) *ListFirewallsInput

SetVpcIds sets the VpcIds field's value.

func (ListFirewallsInput) String

func (s ListFirewallsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallsInput) Validate

func (s *ListFirewallsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListFirewallsOutput

type ListFirewallsOutput struct {

	// 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 []*FirewallMetadata `type:"list"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (ListFirewallsOutput) GoString

func (s ListFirewallsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListFirewallsOutput) SetFirewalls

SetFirewalls sets the Firewalls field's value.

func (*ListFirewallsOutput) SetNextToken

func (s *ListFirewallsOutput) SetNextToken(v string) *ListFirewallsOutput

SetNextToken sets the NextToken field's value.

func (ListFirewallsOutput) String

func (s ListFirewallsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListRuleGroupsInput

type ListRuleGroupsInput struct {

	// Indicates the general category of the Amazon Web Services managed rule group.
	ManagedType *string `type:"string" enum:"ResourceManagedType"`

	// 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 *int64 `min:"1" type:"integer"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `type:"string" enum:"ResourceManagedStatus"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

func (ListRuleGroupsInput) GoString

func (s ListRuleGroupsInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsInput) SetManagedType added in v1.44.3

func (s *ListRuleGroupsInput) SetManagedType(v string) *ListRuleGroupsInput

SetManagedType sets the ManagedType field's value.

func (*ListRuleGroupsInput) SetMaxResults

func (s *ListRuleGroupsInput) SetMaxResults(v int64) *ListRuleGroupsInput

SetMaxResults sets the MaxResults field's value.

func (*ListRuleGroupsInput) SetNextToken

func (s *ListRuleGroupsInput) SetNextToken(v string) *ListRuleGroupsInput

SetNextToken sets the NextToken field's value.

func (*ListRuleGroupsInput) SetScope added in v1.42.22

SetScope sets the Scope field's value.

func (*ListRuleGroupsInput) SetType added in v1.44.3

SetType sets the Type field's value.

func (ListRuleGroupsInput) String

func (s ListRuleGroupsInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsInput) Validate

func (s *ListRuleGroupsInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListRuleGroupsOutput

type ListRuleGroupsOutput struct {

	// 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 *string `min:"1" type:"string"`

	// 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 []*RuleGroupMetadata `type:"list"`
	// contains filtered or unexported fields
}

func (ListRuleGroupsOutput) GoString

func (s ListRuleGroupsOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListRuleGroupsOutput) SetNextToken

func (s *ListRuleGroupsOutput) SetNextToken(v string) *ListRuleGroupsOutput

SetNextToken sets the NextToken field's value.

func (*ListRuleGroupsOutput) SetRuleGroups

SetRuleGroups sets the RuleGroups field's value.

func (ListRuleGroupsOutput) String

func (s ListRuleGroupsOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ListTagsForResourceInput

type ListTagsForResourceInput struct {

	// 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 *int64 `type:"integer"`

	// 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 *string `min:"1" type:"string"`

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceInput) GoString

func (s ListTagsForResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) SetMaxResults

SetMaxResults sets the MaxResults field's value.

func (*ListTagsForResourceInput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (ListTagsForResourceInput) String

func (s ListTagsForResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceInput) Validate

func (s *ListTagsForResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ListTagsForResourceOutput

type ListTagsForResourceOutput struct {

	// 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 *string `min:"1" type:"string"`

	// The tags that are associated with the resource.
	Tags []*Tag `min:"1" type:"list"`
	// contains filtered or unexported fields
}

func (ListTagsForResourceOutput) GoString

func (s ListTagsForResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ListTagsForResourceOutput) SetNextToken

SetNextToken sets the NextToken field's value.

func (*ListTagsForResourceOutput) SetTags

SetTags sets the Tags field's value.

func (ListTagsForResourceOutput) String

func (s ListTagsForResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LogDestinationConfig

type LogDestinationConfig struct {

	// 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" }
	//
	// LogDestination is a required field
	LogDestination map[string]*string `type:"map" required:"true"`

	// 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.
	//
	// LogDestinationType is a required field
	LogDestinationType *string `min:"2" type:"string" required:"true" enum:"LogDestinationType"`

	// 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.
	//
	// LogType is a required field
	LogType *string `type:"string" required:"true" enum:"LogType"`
	// contains filtered or unexported fields
}

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.

func (LogDestinationConfig) GoString

func (s LogDestinationConfig) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestinationConfig) SetLogDestination

func (s *LogDestinationConfig) SetLogDestination(v map[string]*string) *LogDestinationConfig

SetLogDestination sets the LogDestination field's value.

func (*LogDestinationConfig) SetLogDestinationType

func (s *LogDestinationConfig) SetLogDestinationType(v string) *LogDestinationConfig

SetLogDestinationType sets the LogDestinationType field's value.

func (*LogDestinationConfig) SetLogType

SetLogType sets the LogType field's value.

func (LogDestinationConfig) String

func (s LogDestinationConfig) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestinationConfig) Validate

func (s *LogDestinationConfig) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type LogDestinationPermissionException

type LogDestinationPermissionException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unable to send logs to a configured logging destination.

func (*LogDestinationPermissionException) Code

Code returns the exception type name.

func (*LogDestinationPermissionException) Error

func (LogDestinationPermissionException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LogDestinationPermissionException) Message

Message returns the exception's message.

func (*LogDestinationPermissionException) OrigErr

OrigErr always returns nil, satisfies awserr.Error interface.

func (*LogDestinationPermissionException) RequestID

RequestID returns the service's response RequestID for request.

func (*LogDestinationPermissionException) StatusCode

func (s *LogDestinationPermissionException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (LogDestinationPermissionException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type LoggingConfiguration

type LoggingConfiguration struct {

	// Defines the logging destinations for the logs for a firewall. Network Firewall
	// generates logs for stateful rule groups.
	//
	// LogDestinationConfigs is a required field
	LogDestinationConfigs []*LogDestinationConfig `type:"list" required:"true"`
	// contains filtered or unexported fields
}

Defines how Network Firewall performs logging for a Firewall.

func (LoggingConfiguration) GoString

func (s LoggingConfiguration) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) SetLogDestinationConfigs

func (s *LoggingConfiguration) SetLogDestinationConfigs(v []*LogDestinationConfig) *LoggingConfiguration

SetLogDestinationConfigs sets the LogDestinationConfigs field's value.

func (LoggingConfiguration) String

func (s LoggingConfiguration) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*LoggingConfiguration) Validate

func (s *LoggingConfiguration) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type MatchAttributes

type MatchAttributes struct {

	// 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 []*PortRange `type:"list"`

	// The destination IP addresses and address ranges to inspect for, in CIDR notation.
	// If not specified, this matches with any destination address.
	Destinations []*Address `type:"list"`

	// The protocols to inspect for, specified using each protocol's assigned internet
	// protocol number (IANA). If not specified, this matches with any protocol.
	Protocols []*int64 `type:"list"`

	// 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 []*PortRange `type:"list"`

	// The source IP addresses and address ranges to inspect for, in CIDR notation.
	// If not specified, this matches with any source address.
	Sources []*Address `type:"list"`

	// 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 []*TCPFlagField `type:"list"`
	// contains filtered or unexported fields
}

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.

func (MatchAttributes) GoString

func (s MatchAttributes) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchAttributes) SetDestinationPorts

func (s *MatchAttributes) SetDestinationPorts(v []*PortRange) *MatchAttributes

SetDestinationPorts sets the DestinationPorts field's value.

func (*MatchAttributes) SetDestinations

func (s *MatchAttributes) SetDestinations(v []*Address) *MatchAttributes

SetDestinations sets the Destinations field's value.

func (*MatchAttributes) SetProtocols

func (s *MatchAttributes) SetProtocols(v []*int64) *MatchAttributes

SetProtocols sets the Protocols field's value.

func (*MatchAttributes) SetSourcePorts

func (s *MatchAttributes) SetSourcePorts(v []*PortRange) *MatchAttributes

SetSourcePorts sets the SourcePorts field's value.

func (*MatchAttributes) SetSources

func (s *MatchAttributes) SetSources(v []*Address) *MatchAttributes

SetSources sets the Sources field's value.

func (*MatchAttributes) SetTCPFlags

func (s *MatchAttributes) SetTCPFlags(v []*TCPFlagField) *MatchAttributes

SetTCPFlags sets the TCPFlags field's value.

func (MatchAttributes) String

func (s MatchAttributes) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*MatchAttributes) Validate

func (s *MatchAttributes) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type NetworkFirewall

type NetworkFirewall struct {
	*client.Client
}

NetworkFirewall provides the API operation methods for making requests to AWS Network Firewall. See this package's package overview docs for details on the service.

NetworkFirewall methods are safe to use concurrently. It is not safe to modify mutate any of the struct's properties though.

func New

New creates a new instance of the NetworkFirewall client with a session. If additional configuration is needed for the client instance use the optional aws.Config parameter to add your extra config.

Example:

mySession := session.Must(session.NewSession())

// Create a NetworkFirewall client from just a session.
svc := networkfirewall.New(mySession)

// Create a NetworkFirewall client with additional configuration
svc := networkfirewall.New(mySession, aws.NewConfig().WithRegion("us-west-2"))

func (*NetworkFirewall) AssociateFirewallPolicy

AssociateFirewallPolicy API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation AssociateFirewallPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AssociateFirewallPolicy

func (*NetworkFirewall) AssociateFirewallPolicyRequest

func (c *NetworkFirewall) AssociateFirewallPolicyRequest(input *AssociateFirewallPolicyInput) (req *request.Request, output *AssociateFirewallPolicyOutput)

AssociateFirewallPolicyRequest generates a "aws/request.Request" representing the client's request for the AssociateFirewallPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateFirewallPolicy for more information on using the AssociateFirewallPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateFirewallPolicyRequest method.
req, resp := client.AssociateFirewallPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AssociateFirewallPolicy

func (*NetworkFirewall) AssociateFirewallPolicyWithContext

func (c *NetworkFirewall) AssociateFirewallPolicyWithContext(ctx aws.Context, input *AssociateFirewallPolicyInput, opts ...request.Option) (*AssociateFirewallPolicyOutput, error)

AssociateFirewallPolicyWithContext is the same as AssociateFirewallPolicy with the addition of the ability to pass a context and additional request options.

See AssociateFirewallPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) AssociateSubnets

func (c *NetworkFirewall) AssociateSubnets(input *AssociateSubnetsInput) (*AssociateSubnetsOutput, error)

AssociateSubnets API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation AssociateSubnets for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • InvalidOperationException 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.

  • InsufficientCapacityException Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AssociateSubnets

func (*NetworkFirewall) AssociateSubnetsRequest

func (c *NetworkFirewall) AssociateSubnetsRequest(input *AssociateSubnetsInput) (req *request.Request, output *AssociateSubnetsOutput)

AssociateSubnetsRequest generates a "aws/request.Request" representing the client's request for the AssociateSubnets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See AssociateSubnets for more information on using the AssociateSubnets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the AssociateSubnetsRequest method.
req, resp := client.AssociateSubnetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/AssociateSubnets

func (*NetworkFirewall) AssociateSubnetsWithContext

func (c *NetworkFirewall) AssociateSubnetsWithContext(ctx aws.Context, input *AssociateSubnetsInput, opts ...request.Option) (*AssociateSubnetsOutput, error)

AssociateSubnetsWithContext is the same as AssociateSubnets with the addition of the ability to pass a context and additional request options.

See AssociateSubnets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) CreateFirewall

func (c *NetworkFirewall) CreateFirewall(input *CreateFirewallInput) (*CreateFirewallOutput, error)

CreateFirewall API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation CreateFirewall for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • LimitExceededException Unable to perform the operation because doing so would violate a limit setting.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InsufficientCapacityException Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewall

func (*NetworkFirewall) CreateFirewallPolicy

func (c *NetworkFirewall) CreateFirewallPolicy(input *CreateFirewallPolicyInput) (*CreateFirewallPolicyOutput, error)

CreateFirewallPolicy API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation CreateFirewallPolicy for usage and error information.

Returned Error Types:

  • LimitExceededException Unable to perform the operation because doing so would violate a limit setting.

  • InvalidRequestException 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.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • InsufficientCapacityException Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewallPolicy

func (*NetworkFirewall) CreateFirewallPolicyRequest

func (c *NetworkFirewall) CreateFirewallPolicyRequest(input *CreateFirewallPolicyInput) (req *request.Request, output *CreateFirewallPolicyOutput)

CreateFirewallPolicyRequest generates a "aws/request.Request" representing the client's request for the CreateFirewallPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFirewallPolicy for more information on using the CreateFirewallPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFirewallPolicyRequest method.
req, resp := client.CreateFirewallPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewallPolicy

func (*NetworkFirewall) CreateFirewallPolicyWithContext

func (c *NetworkFirewall) CreateFirewallPolicyWithContext(ctx aws.Context, input *CreateFirewallPolicyInput, opts ...request.Option) (*CreateFirewallPolicyOutput, error)

CreateFirewallPolicyWithContext is the same as CreateFirewallPolicy with the addition of the ability to pass a context and additional request options.

See CreateFirewallPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) CreateFirewallRequest

func (c *NetworkFirewall) CreateFirewallRequest(input *CreateFirewallInput) (req *request.Request, output *CreateFirewallOutput)

CreateFirewallRequest generates a "aws/request.Request" representing the client's request for the CreateFirewall operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateFirewall for more information on using the CreateFirewall API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateFirewallRequest method.
req, resp := client.CreateFirewallRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateFirewall

func (*NetworkFirewall) CreateFirewallWithContext

func (c *NetworkFirewall) CreateFirewallWithContext(ctx aws.Context, input *CreateFirewallInput, opts ...request.Option) (*CreateFirewallOutput, error)

CreateFirewallWithContext is the same as CreateFirewall with the addition of the ability to pass a context and additional request options.

See CreateFirewall for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) CreateRuleGroup

func (c *NetworkFirewall) CreateRuleGroup(input *CreateRuleGroupInput) (*CreateRuleGroupOutput, error)

CreateRuleGroup API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation CreateRuleGroup for usage and error information.

Returned Error Types:

  • LimitExceededException Unable to perform the operation because doing so would violate a limit setting.

  • InvalidRequestException 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.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • InsufficientCapacityException Amazon Web Services doesn't currently have enough available capacity to fulfill your request. Try your request later.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateRuleGroup

func (*NetworkFirewall) CreateRuleGroupRequest

func (c *NetworkFirewall) CreateRuleGroupRequest(input *CreateRuleGroupInput) (req *request.Request, output *CreateRuleGroupOutput)

CreateRuleGroupRequest generates a "aws/request.Request" representing the client's request for the CreateRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See CreateRuleGroup for more information on using the CreateRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the CreateRuleGroupRequest method.
req, resp := client.CreateRuleGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/CreateRuleGroup

func (*NetworkFirewall) CreateRuleGroupWithContext

func (c *NetworkFirewall) CreateRuleGroupWithContext(ctx aws.Context, input *CreateRuleGroupInput, opts ...request.Option) (*CreateRuleGroupOutput, error)

CreateRuleGroupWithContext is the same as CreateRuleGroup with the addition of the ability to pass a context and additional request options.

See CreateRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DeleteFirewall

func (c *NetworkFirewall) DeleteFirewall(input *DeleteFirewallInput) (*DeleteFirewallOutput, error)

DeleteFirewall API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DeleteFirewall for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • UnsupportedOperationException The operation you requested isn't supported by Network Firewall.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteFirewall

func (*NetworkFirewall) DeleteFirewallPolicy

func (c *NetworkFirewall) DeleteFirewallPolicy(input *DeleteFirewallPolicyInput) (*DeleteFirewallPolicyOutput, error)

DeleteFirewallPolicy API operation for AWS Network Firewall.

Deletes the specified FirewallPolicy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DeleteFirewallPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • UnsupportedOperationException The operation you requested isn't supported by Network Firewall.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteFirewallPolicy

func (*NetworkFirewall) DeleteFirewallPolicyRequest

func (c *NetworkFirewall) DeleteFirewallPolicyRequest(input *DeleteFirewallPolicyInput) (req *request.Request, output *DeleteFirewallPolicyOutput)

DeleteFirewallPolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteFirewallPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFirewallPolicy for more information on using the DeleteFirewallPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFirewallPolicyRequest method.
req, resp := client.DeleteFirewallPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteFirewallPolicy

func (*NetworkFirewall) DeleteFirewallPolicyWithContext

func (c *NetworkFirewall) DeleteFirewallPolicyWithContext(ctx aws.Context, input *DeleteFirewallPolicyInput, opts ...request.Option) (*DeleteFirewallPolicyOutput, error)

DeleteFirewallPolicyWithContext is the same as DeleteFirewallPolicy with the addition of the ability to pass a context and additional request options.

See DeleteFirewallPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DeleteFirewallRequest

func (c *NetworkFirewall) DeleteFirewallRequest(input *DeleteFirewallInput) (req *request.Request, output *DeleteFirewallOutput)

DeleteFirewallRequest generates a "aws/request.Request" representing the client's request for the DeleteFirewall operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteFirewall for more information on using the DeleteFirewall API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteFirewallRequest method.
req, resp := client.DeleteFirewallRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteFirewall

func (*NetworkFirewall) DeleteFirewallWithContext

func (c *NetworkFirewall) DeleteFirewallWithContext(ctx aws.Context, input *DeleteFirewallInput, opts ...request.Option) (*DeleteFirewallOutput, error)

DeleteFirewallWithContext is the same as DeleteFirewall with the addition of the ability to pass a context and additional request options.

See DeleteFirewall for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DeleteResourcePolicy

func (c *NetworkFirewall) DeleteResourcePolicy(input *DeleteResourcePolicyInput) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicy API operation for AWS Network Firewall.

Deletes a resource policy that you created in a PutResourcePolicy request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DeleteResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidResourcePolicyException The policy statement failed validation.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteResourcePolicy

func (*NetworkFirewall) DeleteResourcePolicyRequest

func (c *NetworkFirewall) DeleteResourcePolicyRequest(input *DeleteResourcePolicyInput) (req *request.Request, output *DeleteResourcePolicyOutput)

DeleteResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DeleteResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteResourcePolicy for more information on using the DeleteResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteResourcePolicyRequest method.
req, resp := client.DeleteResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteResourcePolicy

func (*NetworkFirewall) DeleteResourcePolicyWithContext

func (c *NetworkFirewall) DeleteResourcePolicyWithContext(ctx aws.Context, input *DeleteResourcePolicyInput, opts ...request.Option) (*DeleteResourcePolicyOutput, error)

DeleteResourcePolicyWithContext is the same as DeleteResourcePolicy with the addition of the ability to pass a context and additional request options.

See DeleteResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DeleteRuleGroup

func (c *NetworkFirewall) DeleteRuleGroup(input *DeleteRuleGroupInput) (*DeleteRuleGroupOutput, error)

DeleteRuleGroup API operation for AWS Network Firewall.

Deletes the specified RuleGroup.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DeleteRuleGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • UnsupportedOperationException The operation you requested isn't supported by Network Firewall.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteRuleGroup

func (*NetworkFirewall) DeleteRuleGroupRequest

func (c *NetworkFirewall) DeleteRuleGroupRequest(input *DeleteRuleGroupInput) (req *request.Request, output *DeleteRuleGroupOutput)

DeleteRuleGroupRequest generates a "aws/request.Request" representing the client's request for the DeleteRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DeleteRuleGroup for more information on using the DeleteRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DeleteRuleGroupRequest method.
req, resp := client.DeleteRuleGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DeleteRuleGroup

func (*NetworkFirewall) DeleteRuleGroupWithContext

func (c *NetworkFirewall) DeleteRuleGroupWithContext(ctx aws.Context, input *DeleteRuleGroupInput, opts ...request.Option) (*DeleteRuleGroupOutput, error)

DeleteRuleGroupWithContext is the same as DeleteRuleGroup with the addition of the ability to pass a context and additional request options.

See DeleteRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeFirewall

func (c *NetworkFirewall) DescribeFirewall(input *DescribeFirewallInput) (*DescribeFirewallOutput, error)

DescribeFirewall API operation for AWS Network Firewall.

Returns the data objects for the specified firewall.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeFirewall for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeFirewall

func (*NetworkFirewall) DescribeFirewallPolicy

func (c *NetworkFirewall) DescribeFirewallPolicy(input *DescribeFirewallPolicyInput) (*DescribeFirewallPolicyOutput, error)

DescribeFirewallPolicy API operation for AWS Network Firewall.

Returns the data objects for the specified firewall policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeFirewallPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeFirewallPolicy

func (*NetworkFirewall) DescribeFirewallPolicyRequest

func (c *NetworkFirewall) DescribeFirewallPolicyRequest(input *DescribeFirewallPolicyInput) (req *request.Request, output *DescribeFirewallPolicyOutput)

DescribeFirewallPolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeFirewallPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFirewallPolicy for more information on using the DescribeFirewallPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFirewallPolicyRequest method.
req, resp := client.DescribeFirewallPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeFirewallPolicy

func (*NetworkFirewall) DescribeFirewallPolicyWithContext

func (c *NetworkFirewall) DescribeFirewallPolicyWithContext(ctx aws.Context, input *DescribeFirewallPolicyInput, opts ...request.Option) (*DescribeFirewallPolicyOutput, error)

DescribeFirewallPolicyWithContext is the same as DescribeFirewallPolicy with the addition of the ability to pass a context and additional request options.

See DescribeFirewallPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeFirewallRequest

func (c *NetworkFirewall) DescribeFirewallRequest(input *DescribeFirewallInput) (req *request.Request, output *DescribeFirewallOutput)

DescribeFirewallRequest generates a "aws/request.Request" representing the client's request for the DescribeFirewall operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeFirewall for more information on using the DescribeFirewall API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeFirewallRequest method.
req, resp := client.DescribeFirewallRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeFirewall

func (*NetworkFirewall) DescribeFirewallWithContext

func (c *NetworkFirewall) DescribeFirewallWithContext(ctx aws.Context, input *DescribeFirewallInput, opts ...request.Option) (*DescribeFirewallOutput, error)

DescribeFirewallWithContext is the same as DescribeFirewall with the addition of the ability to pass a context and additional request options.

See DescribeFirewall for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeLoggingConfiguration

DescribeLoggingConfiguration API operation for AWS Network Firewall.

Returns the logging configuration for the specified firewall.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeLoggingConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeLoggingConfiguration

func (*NetworkFirewall) DescribeLoggingConfigurationRequest

func (c *NetworkFirewall) DescribeLoggingConfigurationRequest(input *DescribeLoggingConfigurationInput) (req *request.Request, output *DescribeLoggingConfigurationOutput)

DescribeLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the DescribeLoggingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeLoggingConfiguration for more information on using the DescribeLoggingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeLoggingConfigurationRequest method.
req, resp := client.DescribeLoggingConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeLoggingConfiguration

func (*NetworkFirewall) DescribeLoggingConfigurationWithContext

func (c *NetworkFirewall) DescribeLoggingConfigurationWithContext(ctx aws.Context, input *DescribeLoggingConfigurationInput, opts ...request.Option) (*DescribeLoggingConfigurationOutput, error)

DescribeLoggingConfigurationWithContext is the same as DescribeLoggingConfiguration with the addition of the ability to pass a context and additional request options.

See DescribeLoggingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeResourcePolicy

func (c *NetworkFirewall) DescribeResourcePolicy(input *DescribeResourcePolicyInput) (*DescribeResourcePolicyOutput, error)

DescribeResourcePolicy API operation for AWS Network Firewall.

Retrieves a resource policy that you created in a PutResourcePolicy request.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeResourcePolicy

func (*NetworkFirewall) DescribeResourcePolicyRequest

func (c *NetworkFirewall) DescribeResourcePolicyRequest(input *DescribeResourcePolicyInput) (req *request.Request, output *DescribeResourcePolicyOutput)

DescribeResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the DescribeResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeResourcePolicy for more information on using the DescribeResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeResourcePolicyRequest method.
req, resp := client.DescribeResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeResourcePolicy

func (*NetworkFirewall) DescribeResourcePolicyWithContext

func (c *NetworkFirewall) DescribeResourcePolicyWithContext(ctx aws.Context, input *DescribeResourcePolicyInput, opts ...request.Option) (*DescribeResourcePolicyOutput, error)

DescribeResourcePolicyWithContext is the same as DescribeResourcePolicy with the addition of the ability to pass a context and additional request options.

See DescribeResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeRuleGroup

func (c *NetworkFirewall) DescribeRuleGroup(input *DescribeRuleGroupInput) (*DescribeRuleGroupOutput, error)

DescribeRuleGroup API operation for AWS Network Firewall.

Returns the data objects for the specified rule group.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeRuleGroup for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeRuleGroup

func (*NetworkFirewall) DescribeRuleGroupMetadata added in v1.42.22

DescribeRuleGroupMetadata API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DescribeRuleGroupMetadata for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeRuleGroupMetadata

func (*NetworkFirewall) DescribeRuleGroupMetadataRequest added in v1.42.22

func (c *NetworkFirewall) DescribeRuleGroupMetadataRequest(input *DescribeRuleGroupMetadataInput) (req *request.Request, output *DescribeRuleGroupMetadataOutput)

DescribeRuleGroupMetadataRequest generates a "aws/request.Request" representing the client's request for the DescribeRuleGroupMetadata operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRuleGroupMetadata for more information on using the DescribeRuleGroupMetadata API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRuleGroupMetadataRequest method.
req, resp := client.DescribeRuleGroupMetadataRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeRuleGroupMetadata

func (*NetworkFirewall) DescribeRuleGroupMetadataWithContext added in v1.42.22

func (c *NetworkFirewall) DescribeRuleGroupMetadataWithContext(ctx aws.Context, input *DescribeRuleGroupMetadataInput, opts ...request.Option) (*DescribeRuleGroupMetadataOutput, error)

DescribeRuleGroupMetadataWithContext is the same as DescribeRuleGroupMetadata with the addition of the ability to pass a context and additional request options.

See DescribeRuleGroupMetadata for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DescribeRuleGroupRequest

func (c *NetworkFirewall) DescribeRuleGroupRequest(input *DescribeRuleGroupInput) (req *request.Request, output *DescribeRuleGroupOutput)

DescribeRuleGroupRequest generates a "aws/request.Request" representing the client's request for the DescribeRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DescribeRuleGroup for more information on using the DescribeRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DescribeRuleGroupRequest method.
req, resp := client.DescribeRuleGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DescribeRuleGroup

func (*NetworkFirewall) DescribeRuleGroupWithContext

func (c *NetworkFirewall) DescribeRuleGroupWithContext(ctx aws.Context, input *DescribeRuleGroupInput, opts ...request.Option) (*DescribeRuleGroupOutput, error)

DescribeRuleGroupWithContext is the same as DescribeRuleGroup with the addition of the ability to pass a context and additional request options.

See DescribeRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) DisassociateSubnets

func (c *NetworkFirewall) DisassociateSubnets(input *DisassociateSubnetsInput) (*DisassociateSubnetsOutput, error)

DisassociateSubnets API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation DisassociateSubnets for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • InvalidOperationException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DisassociateSubnets

func (*NetworkFirewall) DisassociateSubnetsRequest

func (c *NetworkFirewall) DisassociateSubnetsRequest(input *DisassociateSubnetsInput) (req *request.Request, output *DisassociateSubnetsOutput)

DisassociateSubnetsRequest generates a "aws/request.Request" representing the client's request for the DisassociateSubnets operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See DisassociateSubnets for more information on using the DisassociateSubnets API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the DisassociateSubnetsRequest method.
req, resp := client.DisassociateSubnetsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/DisassociateSubnets

func (*NetworkFirewall) DisassociateSubnetsWithContext

func (c *NetworkFirewall) DisassociateSubnetsWithContext(ctx aws.Context, input *DisassociateSubnetsInput, opts ...request.Option) (*DisassociateSubnetsOutput, error)

DisassociateSubnetsWithContext is the same as DisassociateSubnets with the addition of the ability to pass a context and additional request options.

See DisassociateSubnets for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListFirewallPolicies

func (c *NetworkFirewall) ListFirewallPolicies(input *ListFirewallPoliciesInput) (*ListFirewallPoliciesOutput, error)

ListFirewallPolicies API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation ListFirewallPolicies for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListFirewallPolicies

func (*NetworkFirewall) ListFirewallPoliciesPages

func (c *NetworkFirewall) ListFirewallPoliciesPages(input *ListFirewallPoliciesInput, fn func(*ListFirewallPoliciesOutput, bool) bool) error

ListFirewallPoliciesPages iterates over the pages of a ListFirewallPolicies operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFirewallPolicies method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFirewallPolicies operation.
pageNum := 0
err := client.ListFirewallPoliciesPages(params,
    func(page *networkfirewall.ListFirewallPoliciesOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*NetworkFirewall) ListFirewallPoliciesPagesWithContext

func (c *NetworkFirewall) ListFirewallPoliciesPagesWithContext(ctx aws.Context, input *ListFirewallPoliciesInput, fn func(*ListFirewallPoliciesOutput, bool) bool, opts ...request.Option) error

ListFirewallPoliciesPagesWithContext same as ListFirewallPoliciesPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListFirewallPoliciesRequest

func (c *NetworkFirewall) ListFirewallPoliciesRequest(input *ListFirewallPoliciesInput) (req *request.Request, output *ListFirewallPoliciesOutput)

ListFirewallPoliciesRequest generates a "aws/request.Request" representing the client's request for the ListFirewallPolicies operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFirewallPolicies for more information on using the ListFirewallPolicies API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFirewallPoliciesRequest method.
req, resp := client.ListFirewallPoliciesRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListFirewallPolicies

func (*NetworkFirewall) ListFirewallPoliciesWithContext

func (c *NetworkFirewall) ListFirewallPoliciesWithContext(ctx aws.Context, input *ListFirewallPoliciesInput, opts ...request.Option) (*ListFirewallPoliciesOutput, error)

ListFirewallPoliciesWithContext is the same as ListFirewallPolicies with the addition of the ability to pass a context and additional request options.

See ListFirewallPolicies for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListFirewalls

func (c *NetworkFirewall) ListFirewalls(input *ListFirewallsInput) (*ListFirewallsOutput, error)

ListFirewalls API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation ListFirewalls for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ThrottlingException Unable to process the request due to throttling limitations.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListFirewalls

func (*NetworkFirewall) ListFirewallsPages

func (c *NetworkFirewall) ListFirewallsPages(input *ListFirewallsInput, fn func(*ListFirewallsOutput, bool) bool) error

ListFirewallsPages iterates over the pages of a ListFirewalls operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListFirewalls method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListFirewalls operation.
pageNum := 0
err := client.ListFirewallsPages(params,
    func(page *networkfirewall.ListFirewallsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*NetworkFirewall) ListFirewallsPagesWithContext

func (c *NetworkFirewall) ListFirewallsPagesWithContext(ctx aws.Context, input *ListFirewallsInput, fn func(*ListFirewallsOutput, bool) bool, opts ...request.Option) error

ListFirewallsPagesWithContext same as ListFirewallsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListFirewallsRequest

func (c *NetworkFirewall) ListFirewallsRequest(input *ListFirewallsInput) (req *request.Request, output *ListFirewallsOutput)

ListFirewallsRequest generates a "aws/request.Request" representing the client's request for the ListFirewalls operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListFirewalls for more information on using the ListFirewalls API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListFirewallsRequest method.
req, resp := client.ListFirewallsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListFirewalls

func (*NetworkFirewall) ListFirewallsWithContext

func (c *NetworkFirewall) ListFirewallsWithContext(ctx aws.Context, input *ListFirewallsInput, opts ...request.Option) (*ListFirewallsOutput, error)

ListFirewallsWithContext is the same as ListFirewalls with the addition of the ability to pass a context and additional request options.

See ListFirewalls for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListRuleGroups

func (c *NetworkFirewall) ListRuleGroups(input *ListRuleGroupsInput) (*ListRuleGroupsOutput, error)

ListRuleGroups API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation ListRuleGroups for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListRuleGroups

func (*NetworkFirewall) ListRuleGroupsPages

func (c *NetworkFirewall) ListRuleGroupsPages(input *ListRuleGroupsInput, fn func(*ListRuleGroupsOutput, bool) bool) error

ListRuleGroupsPages iterates over the pages of a ListRuleGroups operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListRuleGroups method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListRuleGroups operation.
pageNum := 0
err := client.ListRuleGroupsPages(params,
    func(page *networkfirewall.ListRuleGroupsOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*NetworkFirewall) ListRuleGroupsPagesWithContext

func (c *NetworkFirewall) ListRuleGroupsPagesWithContext(ctx aws.Context, input *ListRuleGroupsInput, fn func(*ListRuleGroupsOutput, bool) bool, opts ...request.Option) error

ListRuleGroupsPagesWithContext same as ListRuleGroupsPages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListRuleGroupsRequest

func (c *NetworkFirewall) ListRuleGroupsRequest(input *ListRuleGroupsInput) (req *request.Request, output *ListRuleGroupsOutput)

ListRuleGroupsRequest generates a "aws/request.Request" representing the client's request for the ListRuleGroups operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListRuleGroups for more information on using the ListRuleGroups API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListRuleGroupsRequest method.
req, resp := client.ListRuleGroupsRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListRuleGroups

func (*NetworkFirewall) ListRuleGroupsWithContext

func (c *NetworkFirewall) ListRuleGroupsWithContext(ctx aws.Context, input *ListRuleGroupsInput, opts ...request.Option) (*ListRuleGroupsOutput, error)

ListRuleGroupsWithContext is the same as ListRuleGroups with the addition of the ability to pass a context and additional request options.

See ListRuleGroups for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListTagsForResource

func (c *NetworkFirewall) ListTagsForResource(input *ListTagsForResourceInput) (*ListTagsForResourceOutput, error)

ListTagsForResource API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation ListTagsForResource for usage and error information.

Returned Error Types:

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • InvalidRequestException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListTagsForResource

func (*NetworkFirewall) ListTagsForResourcePages

func (c *NetworkFirewall) ListTagsForResourcePages(input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool) error

ListTagsForResourcePages iterates over the pages of a ListTagsForResource operation, calling the "fn" function with the response data for each page. To stop iterating, return false from the fn function.

See ListTagsForResource method for more information on how to use this operation.

Note: This operation can generate multiple requests to a service.

// Example iterating over at most 3 pages of a ListTagsForResource operation.
pageNum := 0
err := client.ListTagsForResourcePages(params,
    func(page *networkfirewall.ListTagsForResourceOutput, lastPage bool) bool {
        pageNum++
        fmt.Println(page)
        return pageNum <= 3
    })

func (*NetworkFirewall) ListTagsForResourcePagesWithContext

func (c *NetworkFirewall) ListTagsForResourcePagesWithContext(ctx aws.Context, input *ListTagsForResourceInput, fn func(*ListTagsForResourceOutput, bool) bool, opts ...request.Option) error

ListTagsForResourcePagesWithContext same as ListTagsForResourcePages except it takes a Context and allows setting request options on the pages.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) ListTagsForResourceRequest

func (c *NetworkFirewall) ListTagsForResourceRequest(input *ListTagsForResourceInput) (req *request.Request, output *ListTagsForResourceOutput)

ListTagsForResourceRequest generates a "aws/request.Request" representing the client's request for the ListTagsForResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See ListTagsForResource for more information on using the ListTagsForResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the ListTagsForResourceRequest method.
req, resp := client.ListTagsForResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/ListTagsForResource

func (*NetworkFirewall) ListTagsForResourceWithContext

func (c *NetworkFirewall) ListTagsForResourceWithContext(ctx aws.Context, input *ListTagsForResourceInput, opts ...request.Option) (*ListTagsForResourceOutput, error)

ListTagsForResourceWithContext is the same as ListTagsForResource with the addition of the ability to pass a context and additional request options.

See ListTagsForResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) PutResourcePolicy

func (c *NetworkFirewall) PutResourcePolicy(input *PutResourcePolicyInput) (*PutResourcePolicyOutput, error)

PutResourcePolicy API operation for AWS Network Firewall.

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.

For additional information about resource sharing using RAM, see Resource Access Manager User Guide (https://docs.aws.amazon.com/ram/latest/userguide/what-is.html).

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation PutResourcePolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidResourcePolicyException The policy statement failed validation.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/PutResourcePolicy

func (*NetworkFirewall) PutResourcePolicyRequest

func (c *NetworkFirewall) PutResourcePolicyRequest(input *PutResourcePolicyInput) (req *request.Request, output *PutResourcePolicyOutput)

PutResourcePolicyRequest generates a "aws/request.Request" representing the client's request for the PutResourcePolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See PutResourcePolicy for more information on using the PutResourcePolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the PutResourcePolicyRequest method.
req, resp := client.PutResourcePolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/PutResourcePolicy

func (*NetworkFirewall) PutResourcePolicyWithContext

func (c *NetworkFirewall) PutResourcePolicyWithContext(ctx aws.Context, input *PutResourcePolicyInput, opts ...request.Option) (*PutResourcePolicyOutput, error)

PutResourcePolicyWithContext is the same as PutResourcePolicy with the addition of the ability to pass a context and additional request options.

See PutResourcePolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) TagResource

func (c *NetworkFirewall) TagResource(input *TagResourceInput) (*TagResourceOutput, error)

TagResource API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation TagResource for usage and error information.

Returned Error Types:

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • InvalidRequestException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/TagResource

func (*NetworkFirewall) TagResourceRequest

func (c *NetworkFirewall) TagResourceRequest(input *TagResourceInput) (req *request.Request, output *TagResourceOutput)

TagResourceRequest generates a "aws/request.Request" representing the client's request for the TagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See TagResource for more information on using the TagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the TagResourceRequest method.
req, resp := client.TagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/TagResource

func (*NetworkFirewall) TagResourceWithContext

func (c *NetworkFirewall) TagResourceWithContext(ctx aws.Context, input *TagResourceInput, opts ...request.Option) (*TagResourceOutput, error)

TagResourceWithContext is the same as TagResource with the addition of the ability to pass a context and additional request options.

See TagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UntagResource

func (c *NetworkFirewall) UntagResource(input *UntagResourceInput) (*UntagResourceOutput, error)

UntagResource API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UntagResource for usage and error information.

Returned Error Types:

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • InvalidRequestException 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.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UntagResource

func (*NetworkFirewall) UntagResourceRequest

func (c *NetworkFirewall) UntagResourceRequest(input *UntagResourceInput) (req *request.Request, output *UntagResourceOutput)

UntagResourceRequest generates a "aws/request.Request" representing the client's request for the UntagResource operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UntagResource for more information on using the UntagResource API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UntagResourceRequest method.
req, resp := client.UntagResourceRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UntagResource

func (*NetworkFirewall) UntagResourceWithContext

func (c *NetworkFirewall) UntagResourceWithContext(ctx aws.Context, input *UntagResourceInput, opts ...request.Option) (*UntagResourceOutput, error)

UntagResourceWithContext is the same as UntagResource with the addition of the ability to pass a context and additional request options.

See UntagResource for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateFirewallDeleteProtection

UpdateFirewallDeleteProtection API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateFirewallDeleteProtection for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • ResourceOwnerCheckException Unable to change the resource because your account doesn't own it.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallDeleteProtection

func (*NetworkFirewall) UpdateFirewallDeleteProtectionRequest

func (c *NetworkFirewall) UpdateFirewallDeleteProtectionRequest(input *UpdateFirewallDeleteProtectionInput) (req *request.Request, output *UpdateFirewallDeleteProtectionOutput)

UpdateFirewallDeleteProtectionRequest generates a "aws/request.Request" representing the client's request for the UpdateFirewallDeleteProtection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFirewallDeleteProtection for more information on using the UpdateFirewallDeleteProtection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFirewallDeleteProtectionRequest method.
req, resp := client.UpdateFirewallDeleteProtectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallDeleteProtection

func (*NetworkFirewall) UpdateFirewallDeleteProtectionWithContext

func (c *NetworkFirewall) UpdateFirewallDeleteProtectionWithContext(ctx aws.Context, input *UpdateFirewallDeleteProtectionInput, opts ...request.Option) (*UpdateFirewallDeleteProtectionOutput, error)

UpdateFirewallDeleteProtectionWithContext is the same as UpdateFirewallDeleteProtection with the addition of the ability to pass a context and additional request options.

See UpdateFirewallDeleteProtection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateFirewallDescription

UpdateFirewallDescription API operation for AWS Network Firewall.

Modifies the description for the specified firewall. Use the description to help you identify the firewall when you're working with it.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateFirewallDescription for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallDescription

func (*NetworkFirewall) UpdateFirewallDescriptionRequest

func (c *NetworkFirewall) UpdateFirewallDescriptionRequest(input *UpdateFirewallDescriptionInput) (req *request.Request, output *UpdateFirewallDescriptionOutput)

UpdateFirewallDescriptionRequest generates a "aws/request.Request" representing the client's request for the UpdateFirewallDescription operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFirewallDescription for more information on using the UpdateFirewallDescription API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFirewallDescriptionRequest method.
req, resp := client.UpdateFirewallDescriptionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallDescription

func (*NetworkFirewall) UpdateFirewallDescriptionWithContext

func (c *NetworkFirewall) UpdateFirewallDescriptionWithContext(ctx aws.Context, input *UpdateFirewallDescriptionInput, opts ...request.Option) (*UpdateFirewallDescriptionOutput, error)

UpdateFirewallDescriptionWithContext is the same as UpdateFirewallDescription with the addition of the ability to pass a context and additional request options.

See UpdateFirewallDescription for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateFirewallEncryptionConfiguration added in v1.44.1

UpdateFirewallEncryptionConfiguration API operation for AWS Network Firewall.

A complex type that contains settings for encryption of your firewall resources.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateFirewallEncryptionConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • ResourceOwnerCheckException Unable to change the resource because your account doesn't own it.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration

func (*NetworkFirewall) UpdateFirewallEncryptionConfigurationRequest added in v1.44.1

func (c *NetworkFirewall) UpdateFirewallEncryptionConfigurationRequest(input *UpdateFirewallEncryptionConfigurationInput) (req *request.Request, output *UpdateFirewallEncryptionConfigurationOutput)

UpdateFirewallEncryptionConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateFirewallEncryptionConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFirewallEncryptionConfiguration for more information on using the UpdateFirewallEncryptionConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFirewallEncryptionConfigurationRequest method.
req, resp := client.UpdateFirewallEncryptionConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallEncryptionConfiguration

func (*NetworkFirewall) UpdateFirewallEncryptionConfigurationWithContext added in v1.44.1

func (c *NetworkFirewall) UpdateFirewallEncryptionConfigurationWithContext(ctx aws.Context, input *UpdateFirewallEncryptionConfigurationInput, opts ...request.Option) (*UpdateFirewallEncryptionConfigurationOutput, error)

UpdateFirewallEncryptionConfigurationWithContext is the same as UpdateFirewallEncryptionConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateFirewallEncryptionConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateFirewallPolicy

func (c *NetworkFirewall) UpdateFirewallPolicy(input *UpdateFirewallPolicyInput) (*UpdateFirewallPolicyOutput, error)

UpdateFirewallPolicy API operation for AWS Network Firewall.

Updates the properties of the specified firewall policy.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateFirewallPolicy for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallPolicy

func (*NetworkFirewall) UpdateFirewallPolicyChangeProtection

UpdateFirewallPolicyChangeProtection API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateFirewallPolicyChangeProtection for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • ResourceOwnerCheckException Unable to change the resource because your account doesn't own it.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection

func (*NetworkFirewall) UpdateFirewallPolicyChangeProtectionRequest

func (c *NetworkFirewall) UpdateFirewallPolicyChangeProtectionRequest(input *UpdateFirewallPolicyChangeProtectionInput) (req *request.Request, output *UpdateFirewallPolicyChangeProtectionOutput)

UpdateFirewallPolicyChangeProtectionRequest generates a "aws/request.Request" representing the client's request for the UpdateFirewallPolicyChangeProtection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFirewallPolicyChangeProtection for more information on using the UpdateFirewallPolicyChangeProtection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFirewallPolicyChangeProtectionRequest method.
req, resp := client.UpdateFirewallPolicyChangeProtectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallPolicyChangeProtection

func (*NetworkFirewall) UpdateFirewallPolicyChangeProtectionWithContext

func (c *NetworkFirewall) UpdateFirewallPolicyChangeProtectionWithContext(ctx aws.Context, input *UpdateFirewallPolicyChangeProtectionInput, opts ...request.Option) (*UpdateFirewallPolicyChangeProtectionOutput, error)

UpdateFirewallPolicyChangeProtectionWithContext is the same as UpdateFirewallPolicyChangeProtection with the addition of the ability to pass a context and additional request options.

See UpdateFirewallPolicyChangeProtection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateFirewallPolicyRequest

func (c *NetworkFirewall) UpdateFirewallPolicyRequest(input *UpdateFirewallPolicyInput) (req *request.Request, output *UpdateFirewallPolicyOutput)

UpdateFirewallPolicyRequest generates a "aws/request.Request" representing the client's request for the UpdateFirewallPolicy operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateFirewallPolicy for more information on using the UpdateFirewallPolicy API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateFirewallPolicyRequest method.
req, resp := client.UpdateFirewallPolicyRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateFirewallPolicy

func (*NetworkFirewall) UpdateFirewallPolicyWithContext

func (c *NetworkFirewall) UpdateFirewallPolicyWithContext(ctx aws.Context, input *UpdateFirewallPolicyInput, opts ...request.Option) (*UpdateFirewallPolicyOutput, error)

UpdateFirewallPolicyWithContext is the same as UpdateFirewallPolicy with the addition of the ability to pass a context and additional request options.

See UpdateFirewallPolicy for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateLoggingConfiguration

UpdateLoggingConfiguration API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateLoggingConfiguration for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • LogDestinationPermissionException Unable to send logs to a configured logging destination.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateLoggingConfiguration

func (*NetworkFirewall) UpdateLoggingConfigurationRequest

func (c *NetworkFirewall) UpdateLoggingConfigurationRequest(input *UpdateLoggingConfigurationInput) (req *request.Request, output *UpdateLoggingConfigurationOutput)

UpdateLoggingConfigurationRequest generates a "aws/request.Request" representing the client's request for the UpdateLoggingConfiguration operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateLoggingConfiguration for more information on using the UpdateLoggingConfiguration API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateLoggingConfigurationRequest method.
req, resp := client.UpdateLoggingConfigurationRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateLoggingConfiguration

func (*NetworkFirewall) UpdateLoggingConfigurationWithContext

func (c *NetworkFirewall) UpdateLoggingConfigurationWithContext(ctx aws.Context, input *UpdateLoggingConfigurationInput, opts ...request.Option) (*UpdateLoggingConfigurationOutput, error)

UpdateLoggingConfigurationWithContext is the same as UpdateLoggingConfiguration with the addition of the ability to pass a context and additional request options.

See UpdateLoggingConfiguration for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateRuleGroup

func (c *NetworkFirewall) UpdateRuleGroup(input *UpdateRuleGroupInput) (*UpdateRuleGroupOutput, error)

UpdateRuleGroup API operation for AWS Network Firewall.

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.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateRuleGroup for usage and error information.

Returned Error Types:

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • InvalidRequestException 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.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateRuleGroup

func (*NetworkFirewall) UpdateRuleGroupRequest

func (c *NetworkFirewall) UpdateRuleGroupRequest(input *UpdateRuleGroupInput) (req *request.Request, output *UpdateRuleGroupOutput)

UpdateRuleGroupRequest generates a "aws/request.Request" representing the client's request for the UpdateRuleGroup operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateRuleGroup for more information on using the UpdateRuleGroup API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateRuleGroupRequest method.
req, resp := client.UpdateRuleGroupRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateRuleGroup

func (*NetworkFirewall) UpdateRuleGroupWithContext

func (c *NetworkFirewall) UpdateRuleGroupWithContext(ctx aws.Context, input *UpdateRuleGroupInput, opts ...request.Option) (*UpdateRuleGroupOutput, error)

UpdateRuleGroupWithContext is the same as UpdateRuleGroup with the addition of the ability to pass a context and additional request options.

See UpdateRuleGroup for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

func (*NetworkFirewall) UpdateSubnetChangeProtection

UpdateSubnetChangeProtection API operation for AWS Network Firewall.

Returns awserr.Error for service API and SDK errors. Use runtime type assertions with awserr.Error's Code and Message methods to get detailed information about the error.

See the AWS API reference guide for AWS Network Firewall's API operation UpdateSubnetChangeProtection for usage and error information.

Returned Error Types:

  • InvalidRequestException 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.

  • InternalServerError Your request is valid, but Network Firewall couldn’t perform the operation because of a system problem. Retry your request.

  • ResourceNotFoundException Unable to locate a resource using the parameters that you provided.

  • ThrottlingException Unable to process the request due to throttling limitations.

  • InvalidTokenException The token you provided is stale or isn't valid for the operation.

  • ResourceOwnerCheckException Unable to change the resource because your account doesn't own it.

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateSubnetChangeProtection

func (*NetworkFirewall) UpdateSubnetChangeProtectionRequest

func (c *NetworkFirewall) UpdateSubnetChangeProtectionRequest(input *UpdateSubnetChangeProtectionInput) (req *request.Request, output *UpdateSubnetChangeProtectionOutput)

UpdateSubnetChangeProtectionRequest generates a "aws/request.Request" representing the client's request for the UpdateSubnetChangeProtection operation. The "output" return value will be populated with the request's response once the request completes successfully.

Use "Send" method on the returned Request to send the API call to the service. the "output" return value is not valid until after Send returns without error.

See UpdateSubnetChangeProtection for more information on using the UpdateSubnetChangeProtection API call, and error handling.

This method is useful when you want to inject custom logic or configuration into the SDK's request lifecycle. Such as custom headers, or retry logic.

// Example sending a request using the UpdateSubnetChangeProtectionRequest method.
req, resp := client.UpdateSubnetChangeProtectionRequest(params)

err := req.Send()
if err == nil { // resp is now filled
    fmt.Println(resp)
}

See also, https://docs.aws.amazon.com/goto/WebAPI/network-firewall-2020-11-12/UpdateSubnetChangeProtection

func (*NetworkFirewall) UpdateSubnetChangeProtectionWithContext

func (c *NetworkFirewall) UpdateSubnetChangeProtectionWithContext(ctx aws.Context, input *UpdateSubnetChangeProtectionInput, opts ...request.Option) (*UpdateSubnetChangeProtectionOutput, error)

UpdateSubnetChangeProtectionWithContext is the same as UpdateSubnetChangeProtection with the addition of the ability to pass a context and additional request options.

See UpdateSubnetChangeProtection for details on how to use this API operation.

The context must be non-nil and will be used for request cancellation. If the context is nil a panic will occur. In the future the SDK may create sub-contexts for http.Requests. See https://golang.org/pkg/context/ for more information on using Contexts.

type PerObjectStatus

type PerObjectStatus struct {

	// Indicates whether this object is in sync with the version indicated in the
	// update token.
	SyncStatus *string `type:"string" enum:"PerObjectSyncStatus"`

	// The current version of the object that is either in sync or pending synchronization.
	UpdateToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (PerObjectStatus) GoString

func (s PerObjectStatus) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PerObjectStatus) SetSyncStatus

func (s *PerObjectStatus) SetSyncStatus(v string) *PerObjectStatus

SetSyncStatus sets the SyncStatus field's value.

func (*PerObjectStatus) SetUpdateToken added in v1.37.25

func (s *PerObjectStatus) SetUpdateToken(v string) *PerObjectStatus

SetUpdateToken sets the UpdateToken field's value.

func (PerObjectStatus) String

func (s PerObjectStatus) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PortRange

type PortRange struct {

	// The lower limit of the port range. This must be less than or equal to the
	// ToPort specification.
	//
	// FromPort is a required field
	FromPort *int64 `type:"integer" required:"true"`

	// The upper limit of the port range. This must be greater than or equal to
	// the FromPort specification.
	//
	// ToPort is a required field
	ToPort *int64 `type:"integer" required:"true"`
	// contains filtered or unexported fields
}

A single port range specification. This is used for source and destination port ranges in the stateless rule MatchAttributes, SourcePorts, and DestinationPorts settings.

func (PortRange) GoString

func (s PortRange) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortRange) SetFromPort

func (s *PortRange) SetFromPort(v int64) *PortRange

SetFromPort sets the FromPort field's value.

func (*PortRange) SetToPort

func (s *PortRange) SetToPort(v int64) *PortRange

SetToPort sets the ToPort field's value.

func (PortRange) String

func (s PortRange) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortRange) Validate

func (s *PortRange) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PortSet

type PortSet struct {

	// The set of port ranges.
	Definition []*string `type:"list"`
	// contains filtered or unexported fields
}

A set of port ranges for use in the rules in a rule group.

func (PortSet) GoString

func (s PortSet) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PortSet) SetDefinition

func (s *PortSet) SetDefinition(v []*string) *PortSet

SetDefinition sets the Definition field's value.

func (PortSet) String

func (s PortSet) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type PublishMetricAction

type PublishMetricAction struct {

	// Dimensions is a required field
	Dimensions []*Dimension `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

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.

func (PublishMetricAction) GoString

func (s PublishMetricAction) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishMetricAction) SetDimensions

func (s *PublishMetricAction) SetDimensions(v []*Dimension) *PublishMetricAction

SetDimensions sets the Dimensions field's value.

func (PublishMetricAction) String

func (s PublishMetricAction) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PublishMetricAction) Validate

func (s *PublishMetricAction) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutResourcePolicyInput

type PutResourcePolicyInput struct {

	// 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:CreateFirewall
	//
	//    * network-firewall:UpdateFirewall
	//
	//    * 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.
	//
	// Policy is a required field
	Policy *string `min:"1" type:"string" required:"true"`

	// The Amazon Resource Name (ARN) of the account that you want to share rule
	// groups and firewall policies with.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (PutResourcePolicyInput) GoString

func (s PutResourcePolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutResourcePolicyInput) SetPolicy

SetPolicy sets the Policy field's value.

func (*PutResourcePolicyInput) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (PutResourcePolicyInput) String

func (s PutResourcePolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*PutResourcePolicyInput) Validate

func (s *PutResourcePolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type PutResourcePolicyOutput

type PutResourcePolicyOutput struct {
	// contains filtered or unexported fields
}

func (PutResourcePolicyOutput) GoString

func (s PutResourcePolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (PutResourcePolicyOutput) String

func (s PutResourcePolicyOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ReferenceSets added in v1.44.60

type ReferenceSets struct {

	// The list of IP set references.
	IPSetReferences map[string]*IPSetReference `type:"map"`
	// contains filtered or unexported fields
}

Contains a set of IP set references.

func (ReferenceSets) GoString added in v1.44.60

func (s ReferenceSets) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReferenceSets) SetIPSetReferences added in v1.44.60

func (s *ReferenceSets) SetIPSetReferences(v map[string]*IPSetReference) *ReferenceSets

SetIPSetReferences sets the IPSetReferences field's value.

func (ReferenceSets) String added in v1.44.60

func (s ReferenceSets) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ReferenceSets) Validate added in v1.44.60

func (s *ReferenceSets) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type ResourceNotFoundException

type ResourceNotFoundException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unable to locate a resource using the parameters that you provided.

func (*ResourceNotFoundException) Code

Code returns the exception type name.

func (*ResourceNotFoundException) Error

func (s *ResourceNotFoundException) Error() string

func (ResourceNotFoundException) GoString

func (s ResourceNotFoundException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceNotFoundException) Message

func (s *ResourceNotFoundException) Message() string

Message returns the exception's message.

func (*ResourceNotFoundException) OrigErr

func (s *ResourceNotFoundException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceNotFoundException) RequestID

func (s *ResourceNotFoundException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceNotFoundException) StatusCode

func (s *ResourceNotFoundException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceNotFoundException) String

func (s ResourceNotFoundException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ResourceOwnerCheckException

type ResourceOwnerCheckException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unable to change the resource because your account doesn't own it.

func (*ResourceOwnerCheckException) Code

Code returns the exception type name.

func (*ResourceOwnerCheckException) Error

func (ResourceOwnerCheckException) GoString

func (s ResourceOwnerCheckException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ResourceOwnerCheckException) Message

func (s *ResourceOwnerCheckException) Message() string

Message returns the exception's message.

func (*ResourceOwnerCheckException) OrigErr

func (s *ResourceOwnerCheckException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ResourceOwnerCheckException) RequestID

func (s *ResourceOwnerCheckException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ResourceOwnerCheckException) StatusCode

func (s *ResourceOwnerCheckException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ResourceOwnerCheckException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleDefinition

type RuleDefinition struct {

	// 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”].
	//
	// Actions is a required field
	Actions []*string `type:"list" required:"true"`

	// 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.
	//
	// MatchAttributes is a required field
	MatchAttributes *MatchAttributes `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

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.

func (RuleDefinition) GoString

func (s RuleDefinition) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleDefinition) SetActions

func (s *RuleDefinition) SetActions(v []*string) *RuleDefinition

SetActions sets the Actions field's value.

func (*RuleDefinition) SetMatchAttributes

func (s *RuleDefinition) SetMatchAttributes(v *MatchAttributes) *RuleDefinition

SetMatchAttributes sets the MatchAttributes field's value.

func (RuleDefinition) String

func (s RuleDefinition) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleDefinition) Validate

func (s *RuleDefinition) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RuleGroup

type RuleGroup struct {

	// The list of a rule group's reference sets.
	ReferenceSets *ReferenceSets `type:"structure"`

	// Settings that are available for use in the rules in the rule group. You can
	// only use these for stateful rule groups.
	RuleVariables *RuleVariables `type:"structure"`

	// The stateful rules or stateless rules for the rule group.
	//
	// RulesSource is a required field
	RulesSource *RulesSource `type:"structure" required:"true"`

	// 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 `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (RuleGroup) GoString

func (s RuleGroup) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroup) SetReferenceSets added in v1.44.60

func (s *RuleGroup) SetReferenceSets(v *ReferenceSets) *RuleGroup

SetReferenceSets sets the ReferenceSets field's value.

func (*RuleGroup) SetRuleVariables

func (s *RuleGroup) SetRuleVariables(v *RuleVariables) *RuleGroup

SetRuleVariables sets the RuleVariables field's value.

func (*RuleGroup) SetRulesSource

func (s *RuleGroup) SetRulesSource(v *RulesSource) *RuleGroup

SetRulesSource sets the RulesSource field's value.

func (*RuleGroup) SetStatefulRuleOptions added in v1.40.53

func (s *RuleGroup) SetStatefulRuleOptions(v *StatefulRuleOptions) *RuleGroup

SetStatefulRuleOptions sets the StatefulRuleOptions field's value.

func (RuleGroup) String

func (s RuleGroup) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroup) Validate

func (s *RuleGroup) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RuleGroupMetadata

type RuleGroupMetadata struct {

	// The Amazon Resource Name (ARN) of the rule group.
	Arn *string `min:"1" type:"string"`

	// The descriptive name of the rule group. You can't change the name of a rule
	// group after you create it.
	Name *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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.

func (RuleGroupMetadata) GoString

func (s RuleGroupMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupMetadata) SetArn

SetArn sets the Arn field's value.

func (*RuleGroupMetadata) SetName

SetName sets the Name field's value.

func (RuleGroupMetadata) String

func (s RuleGroupMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleGroupResponse

type RuleGroupResponse struct {

	// 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 *int64 `type:"integer"`

	// The number of capacity units currently consumed by the rule group rules.
	ConsumedCapacity *int64 `type:"integer"`

	// A description of the rule group.
	Description *string `type:"string"`

	// A complex type that contains the Amazon Web Services KMS encryption configuration
	// settings for your rule group.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The last time that the rule group was changed.
	LastModifiedTime *time.Time `type:"timestamp"`

	// The number of firewall policies that use this rule group.
	NumberOfAssociations *int64 `type:"integer"`

	// 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.
	//
	// RuleGroupArn is a required field
	RuleGroupArn *string `min:"1" type:"string" required:"true"`

	// The unique identifier for the rule group.
	//
	// RuleGroupId is a required field
	RuleGroupId *string `min:"36" type:"string" required:"true"`

	// The descriptive name of the rule group. You can't change the name of a rule
	// group after you create it.
	//
	// RuleGroupName is a required field
	RuleGroupName *string `min:"1" type:"string" required:"true"`

	// Detailed information about the current status of a rule group.
	RuleGroupStatus *string `type:"string" enum:"ResourceStatus"`

	// 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.
	// (https://docs.aws.amazon.com/sns/latest/dg/welcome.html).
	SnsTopic *string `min:"1" type:"string"`

	// 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 `type:"structure"`

	// The key:value pairs to associate with the resource.
	Tags []*Tag `min:"1" type:"list"`

	// 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 *string `type:"string" enum:"RuleGroupType"`
	// contains filtered or unexported fields
}

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.

func (RuleGroupResponse) GoString

func (s RuleGroupResponse) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleGroupResponse) SetCapacity

func (s *RuleGroupResponse) SetCapacity(v int64) *RuleGroupResponse

SetCapacity sets the Capacity field's value.

func (*RuleGroupResponse) SetConsumedCapacity added in v1.40.53

func (s *RuleGroupResponse) SetConsumedCapacity(v int64) *RuleGroupResponse

SetConsumedCapacity sets the ConsumedCapacity field's value.

func (*RuleGroupResponse) SetDescription

func (s *RuleGroupResponse) SetDescription(v string) *RuleGroupResponse

SetDescription sets the Description field's value.

func (*RuleGroupResponse) SetEncryptionConfiguration added in v1.44.1

func (s *RuleGroupResponse) SetEncryptionConfiguration(v *EncryptionConfiguration) *RuleGroupResponse

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*RuleGroupResponse) SetLastModifiedTime added in v1.44.3

func (s *RuleGroupResponse) SetLastModifiedTime(v time.Time) *RuleGroupResponse

SetLastModifiedTime sets the LastModifiedTime field's value.

func (*RuleGroupResponse) SetNumberOfAssociations added in v1.40.53

func (s *RuleGroupResponse) SetNumberOfAssociations(v int64) *RuleGroupResponse

SetNumberOfAssociations sets the NumberOfAssociations field's value.

func (*RuleGroupResponse) SetRuleGroupArn

func (s *RuleGroupResponse) SetRuleGroupArn(v string) *RuleGroupResponse

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*RuleGroupResponse) SetRuleGroupId

func (s *RuleGroupResponse) SetRuleGroupId(v string) *RuleGroupResponse

SetRuleGroupId sets the RuleGroupId field's value.

func (*RuleGroupResponse) SetRuleGroupName

func (s *RuleGroupResponse) SetRuleGroupName(v string) *RuleGroupResponse

SetRuleGroupName sets the RuleGroupName field's value.

func (*RuleGroupResponse) SetRuleGroupStatus

func (s *RuleGroupResponse) SetRuleGroupStatus(v string) *RuleGroupResponse

SetRuleGroupStatus sets the RuleGroupStatus field's value.

func (*RuleGroupResponse) SetSnsTopic added in v1.44.3

func (s *RuleGroupResponse) SetSnsTopic(v string) *RuleGroupResponse

SetSnsTopic sets the SnsTopic field's value.

func (*RuleGroupResponse) SetSourceMetadata added in v1.44.3

func (s *RuleGroupResponse) SetSourceMetadata(v *SourceMetadata) *RuleGroupResponse

SetSourceMetadata sets the SourceMetadata field's value.

func (*RuleGroupResponse) SetTags

func (s *RuleGroupResponse) SetTags(v []*Tag) *RuleGroupResponse

SetTags sets the Tags field's value.

func (*RuleGroupResponse) SetType

SetType sets the Type field's value.

func (RuleGroupResponse) String

func (s RuleGroupResponse) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type RuleOption

type RuleOption struct {

	// Keyword is a required field
	Keyword *string `min:"1" type:"string" required:"true"`

	Settings []*string `type:"list"`
	// contains filtered or unexported fields
}

Additional settings for a stateful rule. This is part of the StatefulRule configuration.

func (RuleOption) GoString

func (s RuleOption) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleOption) SetKeyword

func (s *RuleOption) SetKeyword(v string) *RuleOption

SetKeyword sets the Keyword field's value.

func (*RuleOption) SetSettings

func (s *RuleOption) SetSettings(v []*string) *RuleOption

SetSettings sets the Settings field's value.

func (RuleOption) String

func (s RuleOption) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleOption) Validate

func (s *RuleOption) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RuleVariables

type RuleVariables struct {

	// A list of IP addresses and address ranges, in CIDR notation.
	IPSets map[string]*IPSet `type:"map"`

	// A list of port ranges.
	PortSets map[string]*PortSet `type:"map"`
	// contains filtered or unexported fields
}

Settings that are available for use in the rules in the RuleGroup where this is defined.

func (RuleVariables) GoString

func (s RuleVariables) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleVariables) SetIPSets

func (s *RuleVariables) SetIPSets(v map[string]*IPSet) *RuleVariables

SetIPSets sets the IPSets field's value.

func (*RuleVariables) SetPortSets

func (s *RuleVariables) SetPortSets(v map[string]*PortSet) *RuleVariables

SetPortSets sets the PortSets field's value.

func (RuleVariables) String

func (s RuleVariables) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RuleVariables) Validate

func (s *RuleVariables) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RulesSource

type RulesSource struct {

	// Stateful inspection criteria for a domain list rule group.
	RulesSourceList *RulesSourceList `type:"structure"`

	// 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 *string `type:"string"`

	// 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 (https://suricata.readthedocs.io/rules/intro.html#).
	StatefulRules []*StatefulRule `type:"list"`

	// Stateless inspection criteria to be used in a stateless rule group.
	StatelessRulesAndCustomActions *StatelessRulesAndCustomActions `type:"structure"`
	// contains filtered or unexported fields
}

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.

func (RulesSource) GoString

func (s RulesSource) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesSource) SetRulesSourceList

func (s *RulesSource) SetRulesSourceList(v *RulesSourceList) *RulesSource

SetRulesSourceList sets the RulesSourceList field's value.

func (*RulesSource) SetRulesString

func (s *RulesSource) SetRulesString(v string) *RulesSource

SetRulesString sets the RulesString field's value.

func (*RulesSource) SetStatefulRules

func (s *RulesSource) SetStatefulRules(v []*StatefulRule) *RulesSource

SetStatefulRules sets the StatefulRules field's value.

func (*RulesSource) SetStatelessRulesAndCustomActions

func (s *RulesSource) SetStatelessRulesAndCustomActions(v *StatelessRulesAndCustomActions) *RulesSource

SetStatelessRulesAndCustomActions sets the StatelessRulesAndCustomActions field's value.

func (RulesSource) String

func (s RulesSource) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesSource) Validate

func (s *RulesSource) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type RulesSourceList

type RulesSourceList struct {

	// Whether you want to allow or deny access to the domains in your target list.
	//
	// GeneratedRulesType is a required field
	GeneratedRulesType *string `type:"string" required:"true" enum:"GeneratedRulesType"`

	// The protocols you want to inspect. Specify TLS_SNI for HTTPS. Specify HTTP_HOST
	// for HTTP. You can specify either or both.
	//
	// TargetTypes is a required field
	TargetTypes []*string `type:"list" required:"true" enum:"TargetType"`

	// 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.
	//
	// Targets is a required field
	Targets []*string `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) in the Network Firewall Developer Guide.

func (RulesSourceList) GoString

func (s RulesSourceList) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesSourceList) SetGeneratedRulesType

func (s *RulesSourceList) SetGeneratedRulesType(v string) *RulesSourceList

SetGeneratedRulesType sets the GeneratedRulesType field's value.

func (*RulesSourceList) SetTargetTypes

func (s *RulesSourceList) SetTargetTypes(v []*string) *RulesSourceList

SetTargetTypes sets the TargetTypes field's value.

func (*RulesSourceList) SetTargets

func (s *RulesSourceList) SetTargets(v []*string) *RulesSourceList

SetTargets sets the Targets field's value.

func (RulesSourceList) String

func (s RulesSourceList) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*RulesSourceList) Validate

func (s *RulesSourceList) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SourceMetadata added in v1.44.3

type SourceMetadata struct {

	// The Amazon Resource Name (ARN) of the rule group that your own rule group
	// is copied from.
	SourceArn *string `min:"1" type:"string"`

	// 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 (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html#networkfirewall-DescribeRuleGroup-response-UpdateToken).
	SourceUpdateToken *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

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 (https://docs.aws.amazon.com/network-firewall/latest/APIReference/API_DescribeRuleGroup.html).

func (SourceMetadata) GoString added in v1.44.3

func (s SourceMetadata) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceMetadata) SetSourceArn added in v1.44.3

func (s *SourceMetadata) SetSourceArn(v string) *SourceMetadata

SetSourceArn sets the SourceArn field's value.

func (*SourceMetadata) SetSourceUpdateToken added in v1.44.3

func (s *SourceMetadata) SetSourceUpdateToken(v string) *SourceMetadata

SetSourceUpdateToken sets the SourceUpdateToken field's value.

func (SourceMetadata) String added in v1.44.3

func (s SourceMetadata) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SourceMetadata) Validate added in v1.44.3

func (s *SourceMetadata) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatefulEngineOptions added in v1.40.53

type StatefulEngineOptions struct {

	// 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 (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html)
	// in the Network Firewall Developer Guide.
	RuleOrder *string `type:"string" enum:"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.
	StreamExceptionPolicy *string `type:"string" enum:"StreamExceptionPolicy"`
	// contains filtered or unexported fields
}

Configuration settings for the handling of the stateful rule groups in a firewall policy.

func (StatefulEngineOptions) GoString added in v1.40.53

func (s StatefulEngineOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulEngineOptions) SetRuleOrder added in v1.40.53

SetRuleOrder sets the RuleOrder field's value.

func (*StatefulEngineOptions) SetStreamExceptionPolicy added in v1.44.112

func (s *StatefulEngineOptions) SetStreamExceptionPolicy(v string) *StatefulEngineOptions

SetStreamExceptionPolicy sets the StreamExceptionPolicy field's value.

func (StatefulEngineOptions) String added in v1.40.53

func (s StatefulEngineOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatefulRule

type StatefulRule struct {

	// 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.
	//
	// Action is a required field
	Action *string `type:"string" required:"true" enum:"StatefulAction"`

	// The stateful inspection criteria for this rule, used to inspect traffic flows.
	//
	// Header is a required field
	Header *Header `type:"structure" required:"true"`

	// Additional options for the rule. These are the Suricata RuleOptions settings.
	//
	// RuleOptions is a required field
	RuleOptions []*RuleOption `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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 (https://suricata.readthedocs.io/rules/intro.html#).

func (StatefulRule) GoString

func (s StatefulRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRule) SetAction

func (s *StatefulRule) SetAction(v string) *StatefulRule

SetAction sets the Action field's value.

func (*StatefulRule) SetHeader

func (s *StatefulRule) SetHeader(v *Header) *StatefulRule

SetHeader sets the Header field's value.

func (*StatefulRule) SetRuleOptions

func (s *StatefulRule) SetRuleOptions(v []*RuleOption) *StatefulRule

SetRuleOptions sets the RuleOptions field's value.

func (StatefulRule) String

func (s StatefulRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRule) Validate

func (s *StatefulRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatefulRuleGroupOverride added in v1.42.22

type StatefulRuleGroupOverride struct {

	// The action that changes the rule group from DROP to ALERT. This only applies
	// to managed rule groups.
	Action *string `type:"string" enum:"OverrideAction"`
	// contains filtered or unexported fields
}

The setting that allows the policy owner to change the behavior of the rule group within a policy.

func (StatefulRuleGroupOverride) GoString added in v1.42.22

func (s StatefulRuleGroupOverride) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRuleGroupOverride) SetAction added in v1.42.22

SetAction sets the Action field's value.

func (StatefulRuleGroupOverride) String added in v1.42.22

func (s StatefulRuleGroupOverride) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatefulRuleGroupReference

type StatefulRuleGroupReference struct {

	// The action that allows the policy owner to override the behavior of the rule
	// group within a policy.
	Override *StatefulRuleGroupOverride `type:"structure"`

	// 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 *int64 `min:"1" type:"integer"`

	// The Amazon Resource Name (ARN) of the stateful rule group.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

func (StatefulRuleGroupReference) GoString

func (s StatefulRuleGroupReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRuleGroupReference) SetOverride added in v1.42.22

SetOverride sets the Override field's value.

func (*StatefulRuleGroupReference) SetPriority added in v1.40.53

SetPriority sets the Priority field's value.

func (*StatefulRuleGroupReference) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (StatefulRuleGroupReference) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRuleGroupReference) Validate

func (s *StatefulRuleGroupReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatefulRuleOptions added in v1.40.53

type StatefulRuleOptions struct {

	// 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 (https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html)
	// in the Network Firewall Developer Guide.
	RuleOrder *string `type:"string" enum:"RuleOrder"`
	// contains filtered or unexported fields
}

Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.

func (StatefulRuleOptions) GoString added in v1.40.53

func (s StatefulRuleOptions) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatefulRuleOptions) SetRuleOrder added in v1.40.53

func (s *StatefulRuleOptions) SetRuleOrder(v string) *StatefulRuleOptions

SetRuleOrder sets the RuleOrder field's value.

func (StatefulRuleOptions) String added in v1.40.53

func (s StatefulRuleOptions) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type StatelessRule

type StatelessRule struct {

	// 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.
	//
	// Priority is a required field
	Priority *int64 `min:"1" type:"integer" required:"true"`

	// Defines the stateless 5-tuple packet inspection criteria and the action to
	// take on a packet that matches the criteria.
	//
	// RuleDefinition is a required field
	RuleDefinition *RuleDefinition `type:"structure" required:"true"`
	// contains filtered or unexported fields
}

A single stateless rule. This is used in StatelessRulesAndCustomActions.

func (StatelessRule) GoString

func (s StatelessRule) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRule) SetPriority

func (s *StatelessRule) SetPriority(v int64) *StatelessRule

SetPriority sets the Priority field's value.

func (*StatelessRule) SetRuleDefinition

func (s *StatelessRule) SetRuleDefinition(v *RuleDefinition) *StatelessRule

SetRuleDefinition sets the RuleDefinition field's value.

func (StatelessRule) String

func (s StatelessRule) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRule) Validate

func (s *StatelessRule) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatelessRuleGroupReference

type StatelessRuleGroupReference struct {

	// 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.
	//
	// Priority is a required field
	Priority *int64 `min:"1" type:"integer" required:"true"`

	// The Amazon Resource Name (ARN) of the stateless rule group.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

func (StatelessRuleGroupReference) GoString

func (s StatelessRuleGroupReference) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRuleGroupReference) SetPriority

SetPriority sets the Priority field's value.

func (*StatelessRuleGroupReference) SetResourceArn

SetResourceArn sets the ResourceArn field's value.

func (StatelessRuleGroupReference) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRuleGroupReference) Validate

func (s *StatelessRuleGroupReference) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type StatelessRulesAndCustomActions

type StatelessRulesAndCustomActions struct {

	// 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 []*CustomAction `type:"list"`

	// Defines the set of stateless rules for use in a stateless rule group.
	//
	// StatelessRules is a required field
	StatelessRules []*StatelessRule `type:"list" required:"true"`
	// contains filtered or unexported fields
}

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

func (StatelessRulesAndCustomActions) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRulesAndCustomActions) SetCustomActions

SetCustomActions sets the CustomActions field's value.

func (*StatelessRulesAndCustomActions) SetStatelessRules

SetStatelessRules sets the StatelessRules field's value.

func (StatelessRulesAndCustomActions) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*StatelessRulesAndCustomActions) Validate

func (s *StatelessRulesAndCustomActions) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SubnetMapping

type SubnetMapping struct {

	// The unique identifier for the subnet.
	//
	// SubnetId is a required field
	SubnetId *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (SubnetMapping) GoString

func (s SubnetMapping) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubnetMapping) SetSubnetId

func (s *SubnetMapping) SetSubnetId(v string) *SubnetMapping

SetSubnetId sets the SubnetId field's value.

func (SubnetMapping) String

func (s SubnetMapping) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SubnetMapping) Validate

func (s *SubnetMapping) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type SyncState

type SyncState struct {

	// 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 `type:"structure"`

	// 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 map[string]*PerObjectStatus `type:"map"`
	// contains filtered or unexported fields
}

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.

func (SyncState) GoString

func (s SyncState) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*SyncState) SetAttachment

func (s *SyncState) SetAttachment(v *Attachment) *SyncState

SetAttachment sets the Attachment field's value.

func (*SyncState) SetConfig

func (s *SyncState) SetConfig(v map[string]*PerObjectStatus) *SyncState

SetConfig sets the Config field's value.

func (SyncState) String

func (s SyncState) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type TCPFlagField

type TCPFlagField struct {

	// 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.
	//
	// Flags is a required field
	Flags []*string `type:"list" required:"true" enum:"TCPFlag"`

	// The set of flags to consider in the inspection. To inspect all flags in the
	// valid values list, leave this with no setting.
	Masks []*string `type:"list" enum:"TCPFlag"`
	// contains filtered or unexported fields
}

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

func (TCPFlagField) GoString

func (s TCPFlagField) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TCPFlagField) SetFlags

func (s *TCPFlagField) SetFlags(v []*string) *TCPFlagField

SetFlags sets the Flags field's value.

func (*TCPFlagField) SetMasks

func (s *TCPFlagField) SetMasks(v []*string) *TCPFlagField

SetMasks sets the Masks field's value.

func (TCPFlagField) String

func (s TCPFlagField) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TCPFlagField) Validate

func (s *TCPFlagField) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type Tag

type Tag struct {

	// 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.
	//
	// Key is a required field
	Key *string `min:"1" type:"string" required:"true"`

	// 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.
	//
	// Value is a required field
	Value *string `type:"string" required:"true"`
	// contains filtered or unexported fields
}

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.

func (Tag) GoString

func (s Tag) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) SetKey

func (s *Tag) SetKey(v string) *Tag

SetKey sets the Key field's value.

func (*Tag) SetValue

func (s *Tag) SetValue(v string) *Tag

SetValue sets the Value field's value.

func (Tag) String

func (s Tag) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*Tag) Validate

func (s *Tag) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceInput

type TagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// Tags is a required field
	Tags []*Tag `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (TagResourceInput) GoString

func (s TagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) SetResourceArn

func (s *TagResourceInput) SetResourceArn(v string) *TagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*TagResourceInput) SetTags

func (s *TagResourceInput) SetTags(v []*Tag) *TagResourceInput

SetTags sets the Tags field's value.

func (TagResourceInput) String

func (s TagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*TagResourceInput) Validate

func (s *TagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type TagResourceOutput

type TagResourceOutput struct {
	// contains filtered or unexported fields
}

func (TagResourceOutput) GoString

func (s TagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (TagResourceOutput) String

func (s TagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type ThrottlingException

type ThrottlingException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

Unable to process the request due to throttling limitations.

func (*ThrottlingException) Code

func (s *ThrottlingException) Code() string

Code returns the exception type name.

func (*ThrottlingException) Error

func (s *ThrottlingException) Error() string

func (ThrottlingException) GoString

func (s ThrottlingException) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*ThrottlingException) Message

func (s *ThrottlingException) Message() string

Message returns the exception's message.

func (*ThrottlingException) OrigErr

func (s *ThrottlingException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*ThrottlingException) RequestID

func (s *ThrottlingException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*ThrottlingException) StatusCode

func (s *ThrottlingException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (ThrottlingException) String

func (s ThrottlingException) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UnsupportedOperationException

type UnsupportedOperationException struct {
	RespMetadata protocol.ResponseMetadata `json:"-" xml:"-"`

	Message_ *string `locationName:"Message" type:"string"`
	// contains filtered or unexported fields
}

The operation you requested isn't supported by Network Firewall.

func (*UnsupportedOperationException) Code

Code returns the exception type name.

func (*UnsupportedOperationException) Error

func (UnsupportedOperationException) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UnsupportedOperationException) Message

Message returns the exception's message.

func (*UnsupportedOperationException) OrigErr

func (s *UnsupportedOperationException) OrigErr() error

OrigErr always returns nil, satisfies awserr.Error interface.

func (*UnsupportedOperationException) RequestID

func (s *UnsupportedOperationException) RequestID() string

RequestID returns the service's response RequestID for request.

func (*UnsupportedOperationException) StatusCode

func (s *UnsupportedOperationException) StatusCode() int

Status code returns the HTTP status code for the request's response error.

func (UnsupportedOperationException) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UntagResourceInput

type UntagResourceInput struct {

	// The Amazon Resource Name (ARN) of the resource.
	//
	// ResourceArn is a required field
	ResourceArn *string `min:"1" type:"string" required:"true"`

	// TagKeys is a required field
	TagKeys []*string `min:"1" type:"list" required:"true"`
	// contains filtered or unexported fields
}

func (UntagResourceInput) GoString

func (s UntagResourceInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) SetResourceArn

func (s *UntagResourceInput) SetResourceArn(v string) *UntagResourceInput

SetResourceArn sets the ResourceArn field's value.

func (*UntagResourceInput) SetTagKeys

func (s *UntagResourceInput) SetTagKeys(v []*string) *UntagResourceInput

SetTagKeys sets the TagKeys field's value.

func (UntagResourceInput) String

func (s UntagResourceInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UntagResourceInput) Validate

func (s *UntagResourceInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UntagResourceOutput

type UntagResourceOutput struct {
	// contains filtered or unexported fields
}

func (UntagResourceOutput) GoString

func (s UntagResourceOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (UntagResourceOutput) String

func (s UntagResourceOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFirewallDeleteProtectionInput

type UpdateFirewallDeleteProtectionInput struct {

	// 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 is a required field
	DeleteProtection *bool `type:"boolean" required:"true"`

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallDeleteProtectionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDeleteProtectionInput) SetDeleteProtection

SetDeleteProtection sets the DeleteProtection field's value.

func (*UpdateFirewallDeleteProtectionInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallDeleteProtectionInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallDeleteProtectionInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallDeleteProtectionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDeleteProtectionInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateFirewallDeleteProtectionOutput

type UpdateFirewallDeleteProtectionOutput struct {

	// 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 *bool `type:"boolean"`

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallDeleteProtectionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDeleteProtectionOutput) SetDeleteProtection

SetDeleteProtection sets the DeleteProtection field's value.

func (*UpdateFirewallDeleteProtectionOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallDeleteProtectionOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallDeleteProtectionOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallDeleteProtectionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFirewallDescriptionInput

type UpdateFirewallDescriptionInput struct {

	// The new description for the firewall. If you omit this setting, Network Firewall
	// removes the description for the firewall.
	Description *string `type:"string"`

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallDescriptionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDescriptionInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateFirewallDescriptionInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallDescriptionInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallDescriptionInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallDescriptionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDescriptionInput) Validate

func (s *UpdateFirewallDescriptionInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFirewallDescriptionOutput

type UpdateFirewallDescriptionOutput struct {

	// A description of the firewall.
	Description *string `type:"string"`

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallDescriptionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallDescriptionOutput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateFirewallDescriptionOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallDescriptionOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallDescriptionOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallDescriptionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFirewallEncryptionConfigurationInput added in v1.44.1

type UpdateFirewallEncryptionConfigurationInput struct {

	// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)
	// in the Network Firewall Developer Guide.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallEncryptionConfigurationInput) GoString added in v1.44.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallEncryptionConfigurationInput) SetEncryptionConfiguration added in v1.44.1

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*UpdateFirewallEncryptionConfigurationInput) SetFirewallArn added in v1.44.1

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallEncryptionConfigurationInput) SetFirewallName added in v1.44.1

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallEncryptionConfigurationInput) SetUpdateToken added in v1.44.1

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallEncryptionConfigurationInput) String added in v1.44.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallEncryptionConfigurationInput) Validate added in v1.44.1

Validate inspects the fields of the type to determine if they are valid.

type UpdateFirewallEncryptionConfigurationOutput added in v1.44.1

type UpdateFirewallEncryptionConfigurationOutput struct {

	// 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 (https://docs.aws.amazon.com/kms/latest/developerguide/kms-encryption-at-rest.html)
	// in the Network Firewall Developer Guide.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallEncryptionConfigurationOutput) GoString added in v1.44.1

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallEncryptionConfigurationOutput) SetEncryptionConfiguration added in v1.44.1

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*UpdateFirewallEncryptionConfigurationOutput) SetFirewallArn added in v1.44.1

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallEncryptionConfigurationOutput) SetFirewallName added in v1.44.1

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallEncryptionConfigurationOutput) SetUpdateToken added in v1.44.1

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallEncryptionConfigurationOutput) String added in v1.44.1

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFirewallPolicyChangeProtectionInput

type UpdateFirewallPolicyChangeProtectionInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 is a required field
	FirewallPolicyChangeProtection *bool `type:"boolean" required:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallPolicyChangeProtectionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyChangeProtectionInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallPolicyChangeProtectionInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallPolicyChangeProtectionInput) SetFirewallPolicyChangeProtection

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*UpdateFirewallPolicyChangeProtectionInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallPolicyChangeProtectionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyChangeProtectionInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateFirewallPolicyChangeProtectionOutput

type UpdateFirewallPolicyChangeProtectionOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *bool `type:"boolean"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateFirewallPolicyChangeProtectionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyChangeProtectionOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateFirewallPolicyChangeProtectionOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateFirewallPolicyChangeProtectionOutput) SetFirewallPolicyChangeProtection

SetFirewallPolicyChangeProtection sets the FirewallPolicyChangeProtection field's value.

func (*UpdateFirewallPolicyChangeProtectionOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallPolicyChangeProtectionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateFirewallPolicyInput

type UpdateFirewallPolicyInput struct {

	// A description of the firewall policy.
	Description *string `type:"string"`

	// 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 *bool `type:"boolean"`

	// A complex type that contains settings for encryption of your firewall policy
	// resources.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// The updated firewall policy to use for the firewall.
	//
	// FirewallPolicy is a required field
	FirewallPolicy *FirewallPolicy `type:"structure" required:"true"`

	// The Amazon Resource Name (ARN) of the firewall policy.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallPolicyArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFirewallPolicyInput) GoString

func (s UpdateFirewallPolicyInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyInput) SetDescription

SetDescription sets the Description field's value.

func (*UpdateFirewallPolicyInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*UpdateFirewallPolicyInput) SetEncryptionConfiguration added in v1.44.1

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*UpdateFirewallPolicyInput) SetFirewallPolicy

SetFirewallPolicy sets the FirewallPolicy field's value.

func (*UpdateFirewallPolicyInput) SetFirewallPolicyArn

func (s *UpdateFirewallPolicyInput) SetFirewallPolicyArn(v string) *UpdateFirewallPolicyInput

SetFirewallPolicyArn sets the FirewallPolicyArn field's value.

func (*UpdateFirewallPolicyInput) SetFirewallPolicyName

func (s *UpdateFirewallPolicyInput) SetFirewallPolicyName(v string) *UpdateFirewallPolicyInput

SetFirewallPolicyName sets the FirewallPolicyName field's value.

func (*UpdateFirewallPolicyInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallPolicyInput) String

func (s UpdateFirewallPolicyInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyInput) Validate

func (s *UpdateFirewallPolicyInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateFirewallPolicyOutput

type UpdateFirewallPolicyOutput struct {

	// 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.
	//
	// FirewallPolicyResponse is a required field
	FirewallPolicyResponse *FirewallPolicyResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateFirewallPolicyOutput) GoString

func (s UpdateFirewallPolicyOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateFirewallPolicyOutput) SetFirewallPolicyResponse

SetFirewallPolicyResponse sets the FirewallPolicyResponse field's value.

func (*UpdateFirewallPolicyOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateFirewallPolicyOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateLoggingConfigurationInput

type UpdateLoggingConfigurationInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// Defines how Network Firewall performs logging for a firewall. If you omit
	// this setting, Network Firewall disables logging for the firewall.
	LoggingConfiguration *LoggingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateLoggingConfigurationInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateLoggingConfigurationInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateLoggingConfigurationInput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (UpdateLoggingConfigurationInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationInput) Validate

func (s *UpdateLoggingConfigurationInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateLoggingConfigurationOutput

type UpdateLoggingConfigurationOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// Defines how Network Firewall performs logging for a Firewall.
	LoggingConfiguration *LoggingConfiguration `type:"structure"`
	// contains filtered or unexported fields
}

func (UpdateLoggingConfigurationOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateLoggingConfigurationOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateLoggingConfigurationOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateLoggingConfigurationOutput) SetLoggingConfiguration

SetLoggingConfiguration sets the LoggingConfiguration field's value.

func (UpdateLoggingConfigurationOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateRuleGroupInput

type UpdateRuleGroupInput struct {

	// A description of the rule group.
	Description *string `type:"string"`

	// 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 *bool `type:"boolean"`

	// A complex type that contains settings for encryption of your rule group resources.
	EncryptionConfiguration *EncryptionConfiguration `type:"structure"`

	// 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 `type:"structure"`

	// The Amazon Resource Name (ARN) of the rule group.
	//
	// You must specify the ARN or the name, and you can specify both.
	RuleGroupArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 *string `type:"string"`

	// 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 `type:"structure"`

	// 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 *string `type:"string" enum:"RuleGroupType"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRuleGroupInput) GoString

func (s UpdateRuleGroupInput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleGroupInput) SetDescription

func (s *UpdateRuleGroupInput) SetDescription(v string) *UpdateRuleGroupInput

SetDescription sets the Description field's value.

func (*UpdateRuleGroupInput) SetDryRun

SetDryRun sets the DryRun field's value.

func (*UpdateRuleGroupInput) SetEncryptionConfiguration added in v1.44.1

func (s *UpdateRuleGroupInput) SetEncryptionConfiguration(v *EncryptionConfiguration) *UpdateRuleGroupInput

SetEncryptionConfiguration sets the EncryptionConfiguration field's value.

func (*UpdateRuleGroupInput) SetRuleGroup

SetRuleGroup sets the RuleGroup field's value.

func (*UpdateRuleGroupInput) SetRuleGroupArn

func (s *UpdateRuleGroupInput) SetRuleGroupArn(v string) *UpdateRuleGroupInput

SetRuleGroupArn sets the RuleGroupArn field's value.

func (*UpdateRuleGroupInput) SetRuleGroupName

func (s *UpdateRuleGroupInput) SetRuleGroupName(v string) *UpdateRuleGroupInput

SetRuleGroupName sets the RuleGroupName field's value.

func (*UpdateRuleGroupInput) SetRules

SetRules sets the Rules field's value.

func (*UpdateRuleGroupInput) SetSourceMetadata added in v1.44.3

func (s *UpdateRuleGroupInput) SetSourceMetadata(v *SourceMetadata) *UpdateRuleGroupInput

SetSourceMetadata sets the SourceMetadata field's value.

func (*UpdateRuleGroupInput) SetType

SetType sets the Type field's value.

func (*UpdateRuleGroupInput) SetUpdateToken

func (s *UpdateRuleGroupInput) SetUpdateToken(v string) *UpdateRuleGroupInput

SetUpdateToken sets the UpdateToken field's value.

func (UpdateRuleGroupInput) String

func (s UpdateRuleGroupInput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleGroupInput) Validate

func (s *UpdateRuleGroupInput) Validate() error

Validate inspects the fields of the type to determine if they are valid.

type UpdateRuleGroupOutput

type UpdateRuleGroupOutput struct {

	// 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.
	//
	// RuleGroupResponse is a required field
	RuleGroupResponse *RuleGroupResponse `type:"structure" required:"true"`

	// 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.
	//
	// UpdateToken is a required field
	UpdateToken *string `min:"1" type:"string" required:"true"`
	// contains filtered or unexported fields
}

func (UpdateRuleGroupOutput) GoString

func (s UpdateRuleGroupOutput) GoString() string

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateRuleGroupOutput) SetRuleGroupResponse

func (s *UpdateRuleGroupOutput) SetRuleGroupResponse(v *RuleGroupResponse) *UpdateRuleGroupOutput

SetRuleGroupResponse sets the RuleGroupResponse field's value.

func (*UpdateRuleGroupOutput) SetUpdateToken

func (s *UpdateRuleGroupOutput) SetUpdateToken(v string) *UpdateRuleGroupOutput

SetUpdateToken sets the UpdateToken field's value.

func (UpdateRuleGroupOutput) String

func (s UpdateRuleGroupOutput) String() string

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

type UpdateSubnetChangeProtectionInput

type UpdateSubnetChangeProtectionInput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	//
	// You must specify the ARN or the name, and you can specify both.
	FirewallArn *string `min:"1" type:"string"`

	// 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 *string `min:"1" type:"string"`

	// 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 is a required field
	SubnetChangeProtection *bool `type:"boolean" required:"true"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSubnetChangeProtectionInput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSubnetChangeProtectionInput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateSubnetChangeProtectionInput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateSubnetChangeProtectionInput) SetSubnetChangeProtection

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*UpdateSubnetChangeProtectionInput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateSubnetChangeProtectionInput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSubnetChangeProtectionInput) Validate

Validate inspects the fields of the type to determine if they are valid.

type UpdateSubnetChangeProtectionOutput

type UpdateSubnetChangeProtectionOutput struct {

	// The Amazon Resource Name (ARN) of the firewall.
	FirewallArn *string `min:"1" type:"string"`

	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	FirewallName *string `min:"1" type:"string"`

	// 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 *bool `type:"boolean"`

	// 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 *string `min:"1" type:"string"`
	// contains filtered or unexported fields
}

func (UpdateSubnetChangeProtectionOutput) GoString

GoString returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

func (*UpdateSubnetChangeProtectionOutput) SetFirewallArn

SetFirewallArn sets the FirewallArn field's value.

func (*UpdateSubnetChangeProtectionOutput) SetFirewallName

SetFirewallName sets the FirewallName field's value.

func (*UpdateSubnetChangeProtectionOutput) SetSubnetChangeProtection

SetSubnetChangeProtection sets the SubnetChangeProtection field's value.

func (*UpdateSubnetChangeProtectionOutput) SetUpdateToken

SetUpdateToken sets the UpdateToken field's value.

func (UpdateSubnetChangeProtectionOutput) String

String returns the string representation.

API parameter values that are decorated as "sensitive" in the API will not be included in the string output. The member name will be present, but the value will be replaced with "sensitive".

Directories

Path Synopsis
Package networkfirewalliface provides an interface to enable mocking the AWS Network Firewall service client for testing your code.
Package networkfirewalliface provides an interface to enable mocking the AWS Network Firewall service client for testing your code.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL