v1alpha1

package
v0.0.5 Latest Latest
Warning

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

 Go to latest Published: Apr 22, 2024 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

+k8s:deepcopy-gen=package Package v1alpha1 is the v1alpha1 version of the networkfirewall.services.k8s.aws API. +groupName=networkfirewall.services.k8s.aws

Index

Constants

This section is empty.

Variables

View Source 
var (
	// GroupVersion is the API Group Version used to register the objects
	GroupVersion = schema.GroupVersion{Group: "networkfirewall.services.k8s.aws", Version: "v1alpha1"}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme
	SchemeBuilder = &scheme.Builder{GroupVersion: GroupVersion}

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Functions

This section is empty.

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.
	PublishMetricAction *PublishMetricAction `json:"publishMetricAction,omitempty"`
}

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

func (*ActionDefinition) DeepCopy 

func (in *ActionDefinition) DeepCopy() *ActionDefinition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ActionDefinition.

func (*ActionDefinition) DeepCopyInto 

func (in *ActionDefinition) DeepCopyInto(out *ActionDefinition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Address 

type Address struct {
	AddressDefinition *string `json:"addressDefinition,omitempty"`
}

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

func (*Address) DeepCopy 

func (in *Address) DeepCopy() *Address

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Address.

func (*Address) DeepCopyInto 

func (in *Address) DeepCopyInto(out *Address)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AnalysisResult 

type AnalysisResult struct {
	AnalysisDetail    *string   `json:"analysisDetail,omitempty"`
	IDentifiedRuleIDs []*string `json:"identifiedRuleIDs,omitempty"`
	IDentifiedType    *string   `json:"identifiedType,omitempty"`
}

The analysis result for Network Firewall's stateless rule group analyzer. Every time you call CreateRuleGroup, UpdateRuleGroup, or DescribeRuleGroup on a stateless rule group, Network Firewall analyzes the stateless rule groups in your account and identifies the rules that might adversely effect your firewall's functionality. For example, if Network Firewall detects a rule that's routing traffic asymmetrically, which impacts the service's ability to properly process traffic, the service includes the rule in a list of analysis results.

func (*AnalysisResult) DeepCopy 

func (in *AnalysisResult) DeepCopy() *AnalysisResult

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new AnalysisResult.

func (*AnalysisResult) DeepCopyInto 

func (in *AnalysisResult) DeepCopyInto(out *AnalysisResult)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Attachment 

type Attachment struct {
	EndpointID    *string `json:"endpointID,omitempty"`
	Status        *string `json:"status,omitempty"`
	StatusMessage *string `json:"statusMessage,omitempty"`
	SubnetID      *string `json:"subnetID,omitempty"`
}

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) DeepCopy 

func (in *Attachment) DeepCopy() *Attachment

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Attachment.

func (*Attachment) DeepCopyInto 

func (in *Attachment) DeepCopyInto(out *Attachment)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type AttachmentStatus 

type AttachmentStatus string
const (
	AttachmentStatus_CREATING AttachmentStatus = "CREATING"
	AttachmentStatus_DELETING AttachmentStatus = "DELETING"
	AttachmentStatus_FAILED   AttachmentStatus = "FAILED"
	AttachmentStatus_ERROR    AttachmentStatus = "ERROR"
	AttachmentStatus_SCALING  AttachmentStatus = "SCALING"
	AttachmentStatus_READY    AttachmentStatus = "READY"
)

type CIDRSummary 

type CIDRSummary struct {
	AvailableCIDRCount *int64                    `json:"availableCIDRCount,omitempty"`
	IPSetReferences    map[string]*IPSetMetadata `json:"iPSetReferences,omitempty"`
	UtilizedCIDRCount  *int64                    `json:"utilizedCIDRCount,omitempty"`
}

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) DeepCopy 

func (in *CIDRSummary) DeepCopy() *CIDRSummary

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CIDRSummary.

func (*CIDRSummary) DeepCopyInto 

func (in *CIDRSummary) DeepCopyInto(out *CIDRSummary)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type CapacityUsageSummary 

type CapacityUsageSummary struct {
	// 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.
	CIDRs *CIDRSummary `json:"cidrs,omitempty"`
}

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

func (*CapacityUsageSummary) DeepCopy 

func (in *CapacityUsageSummary) DeepCopy() *CapacityUsageSummary

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CapacityUsageSummary.

func (*CapacityUsageSummary) DeepCopyInto 

func (in *CapacityUsageSummary) DeepCopyInto(out *CapacityUsageSummary)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ConfigurationSyncState 

type ConfigurationSyncState string
const (
	ConfigurationSyncState_PENDING              ConfigurationSyncState = "PENDING"
	ConfigurationSyncState_IN_SYNC              ConfigurationSyncState = "IN_SYNC"
	ConfigurationSyncState_CAPACITY_CONSTRAINED ConfigurationSyncState = "CAPACITY_CONSTRAINED"
)

type CustomAction 

type CustomAction struct {
	// A custom action to use in stateless rule actions settings. This is used in
	// CustomAction.
	ActionDefinition *ActionDefinition `json:"actionDefinition,omitempty"`
	ActionName       *string           `json:"actionName,omitempty"`
}

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) DeepCopy 

func (in *CustomAction) DeepCopy() *CustomAction

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CustomAction.

func (*CustomAction) DeepCopyInto 

func (in *CustomAction) DeepCopyInto(out *CustomAction)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Dimension 

type Dimension struct {
	Value *string `json:"value,omitempty"`
}

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) DeepCopy 

func (in *Dimension) DeepCopy() *Dimension

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dimension.

func (*Dimension) DeepCopyInto 

func (in *Dimension) DeepCopyInto(out *Dimension)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EncryptionConfiguration 

type EncryptionConfiguration struct {
	KeyID *string `json:"keyID,omitempty"`
	Type  *string `json:"type_,omitempty"`
}

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) DeepCopy 

func (in *EncryptionConfiguration) DeepCopy() *EncryptionConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new EncryptionConfiguration.

func (*EncryptionConfiguration) DeepCopyInto 

func (in *EncryptionConfiguration) DeepCopyInto(out *EncryptionConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type EncryptionType 

type EncryptionType string
const (
	EncryptionType_CUSTOMER_KMS      EncryptionType = "CUSTOMER_KMS"
	EncryptionType_AWS_OWNED_KMS_KEY EncryptionType = "AWS_OWNED_KMS_KEY"
)

type Firewall 

type Firewall struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              FirewallSpec   `json:"spec,omitempty"`
	Status            FirewallStatus `json:"status,omitempty"`
}

Firewall is the Schema for the Firewalls API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*Firewall) DeepCopy 

func (in *Firewall) DeepCopy() *Firewall

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Firewall.

func (*Firewall) DeepCopyInto 

func (in *Firewall) DeepCopyInto(out *Firewall)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Firewall) DeepCopyObject 

func (in *Firewall) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FirewallList 

type FirewallList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Firewall `json:"items"`
}

FirewallList contains a list of Firewall +kubebuilder:object:root=true

func (*FirewallList) DeepCopy 

func (in *FirewallList) DeepCopy() *FirewallList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallList.

func (*FirewallList) DeepCopyInto 

func (in *FirewallList) DeepCopyInto(out *FirewallList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FirewallList) DeepCopyObject 

func (in *FirewallList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FirewallMetadata 

type FirewallMetadata struct {
	FirewallARN  *string `json:"firewallARN,omitempty"`
	FirewallName *string `json:"firewallName,omitempty"`
}

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) DeepCopy 

func (in *FirewallMetadata) DeepCopy() *FirewallMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallMetadata.

func (*FirewallMetadata) DeepCopyInto 

func (in *FirewallMetadata) DeepCopyInto(out *FirewallMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallPolicy 

type FirewallPolicy struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              FirewallPolicySpec   `json:"spec,omitempty"`
	Status            FirewallPolicyStatus `json:"status,omitempty"`
}

FirewallPolicy is the Schema for the FirewallPolicies API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*FirewallPolicy) DeepCopy 

func (in *FirewallPolicy) DeepCopy() *FirewallPolicy

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicy.

func (*FirewallPolicy) DeepCopyInto 

func (in *FirewallPolicy) DeepCopyInto(out *FirewallPolicy)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FirewallPolicy) DeepCopyObject 

func (in *FirewallPolicy) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FirewallPolicyList 

type FirewallPolicyList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []FirewallPolicy `json:"items"`
}

FirewallPolicyList contains a list of FirewallPolicy +kubebuilder:object:root=true

func (*FirewallPolicyList) DeepCopy 

func (in *FirewallPolicyList) DeepCopy() *FirewallPolicyList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicyList.

func (*FirewallPolicyList) DeepCopyInto 

func (in *FirewallPolicyList) DeepCopyInto(out *FirewallPolicyList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*FirewallPolicyList) DeepCopyObject 

func (in *FirewallPolicyList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FirewallPolicyMetadata 

type FirewallPolicyMetadata struct {
	ARN  *string `json:"arn,omitempty"`
	Name *string `json:"name,omitempty"`
}

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) DeepCopy 

func (in *FirewallPolicyMetadata) DeepCopy() *FirewallPolicyMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicyMetadata.

func (*FirewallPolicyMetadata) DeepCopyInto 

func (in *FirewallPolicyMetadata) DeepCopyInto(out *FirewallPolicyMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallPolicyResponse 

type FirewallPolicyResponse struct {
	ConsumedStatefulRuleCapacity  *int64  `json:"consumedStatefulRuleCapacity,omitempty"`
	ConsumedStatelessRuleCapacity *int64  `json:"consumedStatelessRuleCapacity,omitempty"`
	Description                   *string `json:"description,omitempty"`
	// 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 `json:"encryptionConfiguration,omitempty"`
	FirewallPolicyARN       *string                  `json:"firewallPolicyARN,omitempty"`
	FirewallPolicyID        *string                  `json:"firewallPolicyID,omitempty"`
	FirewallPolicyName      *string                  `json:"firewallPolicyName,omitempty"`
	FirewallPolicyStatus    *string                  `json:"firewallPolicyStatus,omitempty"`
	LastModifiedTime        *metav1.Time             `json:"lastModifiedTime,omitempty"`
	NumberOfAssociations    *int64                   `json:"numberOfAssociations,omitempty"`
	Tags                    []*Tag                   `json:"tags,omitempty"`
}

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) DeepCopy 

func (in *FirewallPolicyResponse) DeepCopy() *FirewallPolicyResponse

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicyResponse.

func (*FirewallPolicyResponse) DeepCopyInto 

func (in *FirewallPolicyResponse) DeepCopyInto(out *FirewallPolicyResponse)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallPolicySpec 

type FirewallPolicySpec struct {

	// A description of the firewall policy.
	Description *string `json:"description,omitempty"`
	// A complex type that contains settings for encryption of your firewall policy
	// resources.
	EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`
	// The rule groups and policy actions to use in the firewall policy.
	// +kubebuilder:validation:Required
	FirewallPolicy *FirewallPolicy_SDK `json:"firewallPolicy"`
	// The descriptive name of the firewall policy. You can't change the name of
	// a firewall policy after you create it.
	// +kubebuilder:validation:Required
	FirewallPolicyName *string `json:"firewallPolicyName"`
	// The key:value pairs to associate with the resource.
	Tags []*Tag `json:"tags,omitempty"`
}

FirewallPolicySpec defines the desired state of FirewallPolicy.

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 (*FirewallPolicySpec) DeepCopy 

func (in *FirewallPolicySpec) DeepCopy() *FirewallPolicySpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicySpec.

func (*FirewallPolicySpec) DeepCopyInto 

func (in *FirewallPolicySpec) DeepCopyInto(out *FirewallPolicySpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallPolicyStatus 

type FirewallPolicyStatus struct {
	// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
	// that is used to contain resource sync state, account ownership,
	// constructed ARN for the resource
	// +kubebuilder:validation:Optional
	ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
	// All CRS managed by ACK have a common `Status.Conditions` member that
	// contains a collection of `ackv1alpha1.Condition` objects that describe
	// the various terminal states of the CR and its backend AWS service API
	// resource
	// +kubebuilder:validation:Optional
	Conditions []*ackv1alpha1.Condition `json:"conditions"`
	// 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.
	// +kubebuilder:validation:Optional
	FirewallPolicyResponse *FirewallPolicyResponse `json:"firewallPolicyResponse,omitempty"`
	// 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.
	// +kubebuilder:validation:Optional
	UpdateToken *string `json:"updateToken,omitempty"`
}

FirewallPolicyStatus defines the observed state of FirewallPolicy

func (*FirewallPolicyStatus) DeepCopy 

func (in *FirewallPolicyStatus) DeepCopy() *FirewallPolicyStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicyStatus.

func (*FirewallPolicyStatus) DeepCopyInto 

func (in *FirewallPolicyStatus) DeepCopyInto(out *FirewallPolicyStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallPolicy_SDK 

type FirewallPolicy_SDK struct {
	// Contains variables that you can use to override default Suricata settings
	// in your firewall policy.
	PolicyVariables        *PolicyVariables `json:"policyVariables,omitempty"`
	StatefulDefaultActions []*string        `json:"statefulDefaultActions,omitempty"`
	// Configuration settings for the handling of the stateful rule groups in a
	// firewall policy.
	StatefulEngineOptions           *StatefulEngineOptions         `json:"statefulEngineOptions,omitempty"`
	StatefulRuleGroupReferences     []*StatefulRuleGroupReference  `json:"statefulRuleGroupReferences,omitempty"`
	StatelessCustomActions          []*CustomAction                `json:"statelessCustomActions,omitempty"`
	StatelessDefaultActions         []*string                      `json:"statelessDefaultActions,omitempty"`
	StatelessFragmentDefaultActions []*string                      `json:"statelessFragmentDefaultActions,omitempty"`
	StatelessRuleGroupReferences    []*StatelessRuleGroupReference `json:"statelessRuleGroupReferences,omitempty"`
	TLSInspectionConfigurationARN   *string                        `json:"tlsInspectionConfigurationARN,omitempty"`
}

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_SDK) DeepCopy 

func (in *FirewallPolicy_SDK) DeepCopy() *FirewallPolicy_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallPolicy_SDK.

func (*FirewallPolicy_SDK) DeepCopyInto 

func (in *FirewallPolicy_SDK) DeepCopyInto(out *FirewallPolicy_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallSpec 

type FirewallSpec 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 `json:"deleteProtection,omitempty"`
	// A description of the firewall.
	Description *string `json:"description,omitempty"`
	// A complex type that contains settings for encryption of your firewall resources.
	EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`
	// The descriptive name of the firewall. You can't change the name of a firewall
	// after you create it.
	// +kubebuilder:validation:Required
	FirewallName *string `json:"firewallName"`
	// The Amazon Resource Name (ARN) of the FirewallPolicy that you want to use
	// for the firewall.
	// +kubebuilder:validation:Required
	FirewallPolicyARN *string `json:"firewallPolicyARN"`
	// 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 `json:"firewallPolicyChangeProtection,omitempty"`
	// 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 `json:"subnetChangeProtection,omitempty"`
	// 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.
	// +kubebuilder:validation:Required
	SubnetMappings []*SubnetMapping `json:"subnetMappings"`
	// The key:value pairs to associate with the resource.
	Tags []*Tag `json:"tags,omitempty"`
	// The unique identifier of the VPC where Network Firewall should create the
	// firewall.
	//
	// You can't change this setting after you create the firewall.
	// +kubebuilder:validation:Required
	VPCID *string `json:"vpcID"`
}

FirewallSpec defines the desired state of Firewall.

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 (*FirewallSpec) DeepCopy 

func (in *FirewallSpec) DeepCopy() *FirewallSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallSpec.

func (*FirewallSpec) DeepCopyInto 

func (in *FirewallSpec) DeepCopyInto(out *FirewallSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallStatus 

type FirewallStatus struct {
	// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
	// that is used to contain resource sync state, account ownership,
	// constructed ARN for the resource
	// +kubebuilder:validation:Optional
	ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
	// All CRS managed by ACK have a common `Status.Conditions` member that
	// contains a collection of `ackv1alpha1.Condition` objects that describe
	// the various terminal states of the CR and its backend AWS service API
	// resource
	// +kubebuilder:validation:Optional
	Conditions []*ackv1alpha1.Condition `json:"conditions"`
	// The configuration settings for the firewall. These settings include the firewall
	// policy and the subnets in your VPC to use for the firewall endpoints.
	// +kubebuilder:validation:Optional
	Firewall *Firewall_SDK `json:"firewall,omitempty"`
	// 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.
	// +kubebuilder:validation:Optional
	FirewallStatus *FirewallStatus_SDK `json:"firewallStatus,omitempty"`
}

FirewallStatus defines the observed state of Firewall

func (*FirewallStatus) DeepCopy 

func (in *FirewallStatus) DeepCopy() *FirewallStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallStatus.

func (*FirewallStatus) DeepCopyInto 

func (in *FirewallStatus) DeepCopyInto(out *FirewallStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FirewallStatusValue 

type FirewallStatusValue string
const (
	FirewallStatusValue_PROVISIONING FirewallStatusValue = "PROVISIONING"
	FirewallStatusValue_DELETING     FirewallStatusValue = "DELETING"
	FirewallStatusValue_READY        FirewallStatusValue = "READY"
)

type FirewallStatus_SDK 

type FirewallStatus_SDK struct {
	// The capacity usage summary of the resources used by the ReferenceSets in
	// a firewall.
	CapacityUsageSummary          *CapacityUsageSummary `json:"capacityUsageSummary,omitempty"`
	ConfigurationSyncStateSummary *string               `json:"configurationSyncStateSummary,omitempty"`
	Status                        *string               `json:"status,omitempty"`
	SyncStates                    map[string]*SyncState `json:"syncStates,omitempty"`
}

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_SDK) DeepCopy 

func (in *FirewallStatus_SDK) DeepCopy() *FirewallStatus_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FirewallStatus_SDK.

func (*FirewallStatus_SDK) DeepCopyInto 

func (in *FirewallStatus_SDK) DeepCopyInto(out *FirewallStatus_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Firewall_SDK 

type Firewall_SDK struct {
	DeleteProtection *bool   `json:"deleteProtection,omitempty"`
	Description      *string `json:"description,omitempty"`
	// 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 `json:"encryptionConfiguration,omitempty"`
	FirewallARN                    *string                  `json:"firewallARN,omitempty"`
	FirewallID                     *string                  `json:"firewallID,omitempty"`
	FirewallName                   *string                  `json:"firewallName,omitempty"`
	FirewallPolicyARN              *string                  `json:"firewallPolicyARN,omitempty"`
	FirewallPolicyChangeProtection *bool                    `json:"firewallPolicyChangeProtection,omitempty"`
	SubnetChangeProtection         *bool                    `json:"subnetChangeProtection,omitempty"`
	SubnetMappings                 []*SubnetMapping         `json:"subnetMappings,omitempty"`
	Tags                           []*Tag                   `json:"tags,omitempty"`
	VPCID                          *string                  `json:"vpcID,omitempty"`
}

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_SDK) DeepCopy 

func (in *Firewall_SDK) DeepCopy() *Firewall_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Firewall_SDK.

func (*Firewall_SDK) DeepCopyInto 

func (in *Firewall_SDK) DeepCopyInto(out *Firewall_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GeneratedRulesType 

type GeneratedRulesType string
const (
	GeneratedRulesType_ALLOWLIST GeneratedRulesType = "ALLOWLIST"
	GeneratedRulesType_DENYLIST  GeneratedRulesType = "DENYLIST"
)
type Header struct {
	Destination     *string `json:"destination,omitempty"`
	DestinationPort *string `json:"destinationPort,omitempty"`
	Direction       *string `json:"direction,omitempty"`
	Protocol        *string `json:"protocol,omitempty"`
	Source          *string `json:"source,omitempty"`
	SourcePort      *string `json:"sourcePort,omitempty"`
}

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) DeepCopy 

func (in *Header) DeepCopy() *Header

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Header.

func (*Header) DeepCopyInto 

func (in *Header) DeepCopyInto(out *Header)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IDentifiedType 

type IDentifiedType string
const (
	IDentifiedType_STATELESS_RULE_FORWARDING_ASYMMETRICALLY IDentifiedType = "STATELESS_RULE_FORWARDING_ASYMMETRICALLY"
	IDentifiedType_STATELESS_RULE_CONTAINS_TCP_FLAGS        IDentifiedType = "STATELESS_RULE_CONTAINS_TCP_FLAGS"
)

type IPAddressType 

type IPAddressType string
const (
	IPAddressType_DUALSTACK IPAddressType = "DUALSTACK"
	IPAddressType_IPV4      IPAddressType = "IPV4"
	IPAddressType_IPV6      IPAddressType = "IPV6"
)

type IPSet 

type IPSet struct {
	Definition []*string `json:"definition,omitempty"`
}

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

func (*IPSet) DeepCopy 

func (in *IPSet) DeepCopy() *IPSet

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPSet.

func (*IPSet) DeepCopyInto 

func (in *IPSet) DeepCopyInto(out *IPSet)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IPSetMetadata 

type IPSetMetadata struct {
	ResolvedCIDRCount *int64 `json:"resolvedCIDRCount,omitempty"`
}

General information about the IP set.

func (*IPSetMetadata) DeepCopy 

func (in *IPSetMetadata) DeepCopy() *IPSetMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPSetMetadata.

func (*IPSetMetadata) DeepCopyInto 

func (in *IPSetMetadata) DeepCopyInto(out *IPSetMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type IPSetReference 

type IPSetReference struct {
	ReferenceARN *string `json:"referenceARN,omitempty"`
}

Configures one or more IP set references for a Suricata-compatible rule group. This is used in CreateRuleGroup or UpdateRuleGroup. An IP set reference is a rule variable that references resources that you create and manage in another Amazon Web Services service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the resource you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall, see Using IP set references (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references) in the Network Firewall Developer Guide.

Network Firewall currently supports Amazon VPC prefix lists (https://docs.aws.amazon.com/vpc/latest/userguide/managed-prefix-lists.html) and resource groups (https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html#rule-groups-referencing-resource-groups) in IP set references.

func (*IPSetReference) DeepCopy 

func (in *IPSetReference) DeepCopy() *IPSetReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new IPSetReference.

func (*IPSetReference) DeepCopyInto 

func (in *IPSetReference) DeepCopyInto(out *IPSetReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type LogDestinationType 

type LogDestinationType string
const (
	LogDestinationType_S3                  LogDestinationType = "S3"
	LogDestinationType_CloudWatchLogs      LogDestinationType = "CloudWatchLogs"
	LogDestinationType_KinesisDataFirehose LogDestinationType = "KinesisDataFirehose"
)

type LogType 

type LogType string
const (
	LogType_ALERT LogType = "ALERT"
	LogType_FLOW  LogType = "FLOW"
)

type MatchAttributes 

type MatchAttributes struct {
	DestinationPorts []*PortRange    `json:"destinationPorts,omitempty"`
	Destinations     []*Address      `json:"destinations,omitempty"`
	Protocols        []*int64        `json:"protocols,omitempty"`
	SourcePorts      []*PortRange    `json:"sourcePorts,omitempty"`
	Sources          []*Address      `json:"sources,omitempty"`
	TCPFlags         []*TCPFlagField `json:"tcpFlags,omitempty"`
}

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) DeepCopy 

func (in *MatchAttributes) DeepCopy() *MatchAttributes

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MatchAttributes.

func (*MatchAttributes) DeepCopyInto 

func (in *MatchAttributes) DeepCopyInto(out *MatchAttributes)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type OverrideAction 

type OverrideAction string
const (
	OverrideAction_DROP_TO_ALERT OverrideAction = "DROP_TO_ALERT"
)

type PerObjectStatus 

type PerObjectStatus struct {
	SyncStatus  *string `json:"syncStatus,omitempty"`
	UpdateToken *string `json:"updateToken,omitempty"`
}

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) DeepCopy 

func (in *PerObjectStatus) DeepCopy() *PerObjectStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PerObjectStatus.

func (*PerObjectStatus) DeepCopyInto 

func (in *PerObjectStatus) DeepCopyInto(out *PerObjectStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PerObjectSyncStatus 

type PerObjectSyncStatus string
const (
	PerObjectSyncStatus_PENDING              PerObjectSyncStatus = "PENDING"
	PerObjectSyncStatus_IN_SYNC              PerObjectSyncStatus = "IN_SYNC"
	PerObjectSyncStatus_CAPACITY_CONSTRAINED PerObjectSyncStatus = "CAPACITY_CONSTRAINED"
)

type PolicyVariables 

type PolicyVariables struct {
	RuleVariables map[string]*IPSet `json:"ruleVariables,omitempty"`
}

Contains variables that you can use to override default Suricata settings in your firewall policy.

func (*PolicyVariables) DeepCopy 

func (in *PolicyVariables) DeepCopy() *PolicyVariables

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PolicyVariables.

func (*PolicyVariables) DeepCopyInto 

func (in *PolicyVariables) DeepCopyInto(out *PolicyVariables)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PortRange 

type PortRange struct {
	FromPort *int64 `json:"fromPort,omitempty"`
	ToPort   *int64 `json:"toPort,omitempty"`
}

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) DeepCopy 

func (in *PortRange) DeepCopy() *PortRange

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PortRange.

func (*PortRange) DeepCopyInto 

func (in *PortRange) DeepCopyInto(out *PortRange)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PortSet 

type PortSet struct {
	Definition []*string `json:"definition,omitempty"`
}

A set of port ranges for use in the rules in a rule group.

func (*PortSet) DeepCopy 

func (in *PortSet) DeepCopy() *PortSet

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PortSet.

func (*PortSet) DeepCopyInto 

func (in *PortSet) DeepCopyInto(out *PortSet)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type PublishMetricAction 

type PublishMetricAction struct {
	Dimensions []*Dimension `json:"dimensions,omitempty"`
}

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) DeepCopy 

func (in *PublishMetricAction) DeepCopy() *PublishMetricAction

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new PublishMetricAction.

func (*PublishMetricAction) DeepCopyInto 

func (in *PublishMetricAction) DeepCopyInto(out *PublishMetricAction)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ReferenceSets 

type ReferenceSets struct {
	IPSetReferences map[string]*IPSetReference `json:"iPSetReferences,omitempty"`
}

Contains a set of IP set references.

func (*ReferenceSets) DeepCopy 

func (in *ReferenceSets) DeepCopy() *ReferenceSets

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ReferenceSets.

func (*ReferenceSets) DeepCopyInto 

func (in *ReferenceSets) DeepCopyInto(out *ReferenceSets)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ResourceManagedStatus 

type ResourceManagedStatus string
const (
	ResourceManagedStatus_MANAGED ResourceManagedStatus = "MANAGED"
	ResourceManagedStatus_ACCOUNT ResourceManagedStatus = "ACCOUNT"
)

type ResourceManagedType 

type ResourceManagedType string
const (
	ResourceManagedType_AWS_MANAGED_THREAT_SIGNATURES ResourceManagedType = "AWS_MANAGED_THREAT_SIGNATURES"
	ResourceManagedType_AWS_MANAGED_DOMAIN_LISTS      ResourceManagedType = "AWS_MANAGED_DOMAIN_LISTS"
)

type ResourceStatus 

type ResourceStatus string
const (
	ResourceStatus_ACTIVE   ResourceStatus = "ACTIVE"
	ResourceStatus_DELETING ResourceStatus = "DELETING"
	ResourceStatus_ERROR    ResourceStatus = "ERROR"
)

type RevocationCheckAction 

type RevocationCheckAction string
const (
	RevocationCheckAction_PASS   RevocationCheckAction = "PASS"
	RevocationCheckAction_DROP   RevocationCheckAction = "DROP"
	RevocationCheckAction_REJECT RevocationCheckAction = "REJECT"
)

type RuleDefinition 

type RuleDefinition struct {
	Actions []*string `json:"actions,omitempty"`
	// 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 *MatchAttributes `json:"matchAttributes,omitempty"`
}

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) DeepCopy 

func (in *RuleDefinition) DeepCopy() *RuleDefinition

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleDefinition.

func (*RuleDefinition) DeepCopyInto 

func (in *RuleDefinition) DeepCopyInto(out *RuleDefinition)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleGroup 

type RuleGroup struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	Spec              RuleGroupSpec   `json:"spec,omitempty"`
	Status            RuleGroupStatus `json:"status,omitempty"`
}

RuleGroup is the Schema for the RuleGroups API +kubebuilder:object:root=true +kubebuilder:subresource:status

func (*RuleGroup) DeepCopy 

func (in *RuleGroup) DeepCopy() *RuleGroup

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroup.

func (*RuleGroup) DeepCopyInto 

func (in *RuleGroup) DeepCopyInto(out *RuleGroup)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RuleGroup) DeepCopyObject 

func (in *RuleGroup) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RuleGroupList 

type RuleGroupList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []RuleGroup `json:"items"`
}

RuleGroupList contains a list of RuleGroup +kubebuilder:object:root=true

func (*RuleGroupList) DeepCopy 

func (in *RuleGroupList) DeepCopy() *RuleGroupList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroupList.

func (*RuleGroupList) DeepCopyInto 

func (in *RuleGroupList) DeepCopyInto(out *RuleGroupList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*RuleGroupList) DeepCopyObject 

func (in *RuleGroupList) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type RuleGroupMetadata 

type RuleGroupMetadata struct {
	ARN  *string `json:"arn,omitempty"`
	Name *string `json:"name,omitempty"`
}

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) DeepCopy 

func (in *RuleGroupMetadata) DeepCopy() *RuleGroupMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroupMetadata.

func (*RuleGroupMetadata) DeepCopyInto 

func (in *RuleGroupMetadata) DeepCopyInto(out *RuleGroupMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleGroupResponse 

type RuleGroupResponse struct {
	AnalysisResults  []*AnalysisResult `json:"analysisResults,omitempty"`
	Capacity         *int64            `json:"capacity,omitempty"`
	ConsumedCapacity *int64            `json:"consumedCapacity,omitempty"`
	Description      *string           `json:"description,omitempty"`
	// 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 `json:"encryptionConfiguration,omitempty"`
	LastModifiedTime        *metav1.Time             `json:"lastModifiedTime,omitempty"`
	NumberOfAssociations    *int64                   `json:"numberOfAssociations,omitempty"`
	RuleGroupARN            *string                  `json:"ruleGroupARN,omitempty"`
	RuleGroupID             *string                  `json:"ruleGroupID,omitempty"`
	RuleGroupName           *string                  `json:"ruleGroupName,omitempty"`
	RuleGroupStatus         *string                  `json:"ruleGroupStatus,omitempty"`
	SNSTopic                *string                  `json:"snsTopic,omitempty"`
	// 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).
	SourceMetadata *SourceMetadata `json:"sourceMetadata,omitempty"`
	Tags           []*Tag          `json:"tags,omitempty"`
	Type           *string         `json:"type_,omitempty"`
}

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) DeepCopy 

func (in *RuleGroupResponse) DeepCopy() *RuleGroupResponse

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroupResponse.

func (*RuleGroupResponse) DeepCopyInto 

func (in *RuleGroupResponse) DeepCopyInto(out *RuleGroupResponse)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleGroupSpec 

type RuleGroupSpec struct {

	// Indicates whether you want Network Firewall to analyze the stateless rules
	// in the rule group for rule behavior such as asymmetric routing. If set to
	// TRUE, Network Firewall runs the analysis and then creates the rule group
	// for you. To run the stateless rule group analyzer without creating the rule
	// group, set DryRun to TRUE.
	AnalyzeRuleGroup *bool `json:"analyzeRuleGroup,omitempty"`
	// 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.
	// +kubebuilder:validation:Required
	Capacity *int64 `json:"capacity"`
	// A description of the rule group.
	Description *string `json:"description,omitempty"`
	// 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 `json:"dryRun,omitempty"`
	// A complex type that contains settings for encryption of your rule group resources.
	EncryptionConfiguration *EncryptionConfiguration `json:"encryptionConfiguration,omitempty"`
	// 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_SDK `json:"ruleGroup,omitempty"`
	// The descriptive name of the rule group. You can't change the name of a rule
	// group after you create it.
	// +kubebuilder:validation:Required
	RuleGroupName *string `json:"ruleGroupName"`
	// 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 `json:"rules,omitempty"`
	// 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 `json:"sourceMetadata,omitempty"`
	// The key:value pairs to associate with the resource.
	Tags []*Tag `json:"tags,omitempty"`
	// 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.
	// +kubebuilder:validation:Required
	Type *string `json:"type_"`
}

RuleGroupSpec defines the desired state of RuleGroup.

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 (*RuleGroupSpec) DeepCopy 

func (in *RuleGroupSpec) DeepCopy() *RuleGroupSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroupSpec.

func (*RuleGroupSpec) DeepCopyInto 

func (in *RuleGroupSpec) DeepCopyInto(out *RuleGroupSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleGroupStatus 

type RuleGroupStatus struct {
	// All CRs managed by ACK have a common `Status.ACKResourceMetadata` member
	// that is used to contain resource sync state, account ownership,
	// constructed ARN for the resource
	// +kubebuilder:validation:Optional
	ACKResourceMetadata *ackv1alpha1.ResourceMetadata `json:"ackResourceMetadata"`
	// All CRS managed by ACK have a common `Status.Conditions` member that
	// contains a collection of `ackv1alpha1.Condition` objects that describe
	// the various terminal states of the CR and its backend AWS service API
	// resource
	// +kubebuilder:validation:Optional
	Conditions []*ackv1alpha1.Condition `json:"conditions"`
	// 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.
	// +kubebuilder:validation:Optional
	RuleGroupResponse *RuleGroupResponse `json:"ruleGroupResponse,omitempty"`
	// 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.
	// +kubebuilder:validation:Optional
	UpdateToken *string `json:"updateToken,omitempty"`
}

RuleGroupStatus defines the observed state of RuleGroup

func (*RuleGroupStatus) DeepCopy 

func (in *RuleGroupStatus) DeepCopy() *RuleGroupStatus

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroupStatus.

func (*RuleGroupStatus) DeepCopyInto 

func (in *RuleGroupStatus) DeepCopyInto(out *RuleGroupStatus)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleGroupType 

type RuleGroupType string
const (
	RuleGroupType_STATELESS RuleGroupType = "STATELESS"
	RuleGroupType_STATEFUL  RuleGroupType = "STATEFUL"
)

type RuleGroup_SDK 

type RuleGroup_SDK struct {
	// Contains a set of IP set references.
	ReferenceSets *ReferenceSets `json:"referenceSets,omitempty"`
	// Settings that are available for use in the rules in the RuleGroup where this
	// is defined.
	RuleVariables *RuleVariables `json:"ruleVariables,omitempty"`
	// 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.
	RulesSource *RulesSource `json:"rulesSource,omitempty"`
	// Additional options governing how Network Firewall handles the rule group.
	// You can only use these for stateful rule groups.
	StatefulRuleOptions *StatefulRuleOptions `json:"statefulRuleOptions,omitempty"`
}

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_SDK) DeepCopy 

func (in *RuleGroup_SDK) DeepCopy() *RuleGroup_SDK

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleGroup_SDK.

func (*RuleGroup_SDK) DeepCopyInto 

func (in *RuleGroup_SDK) DeepCopyInto(out *RuleGroup_SDK)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleOption 

type RuleOption struct {
	Keyword  *string   `json:"keyword,omitempty"`
	Settings []*string `json:"settings,omitempty"`
}

Additional settings for a stateful rule. This is part of the StatefulRule configuration.

func (*RuleOption) DeepCopy 

func (in *RuleOption) DeepCopy() *RuleOption

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleOption.

func (*RuleOption) DeepCopyInto 

func (in *RuleOption) DeepCopyInto(out *RuleOption)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RuleOrder 

type RuleOrder string
const (
	RuleOrder_DEFAULT_ACTION_ORDER RuleOrder = "DEFAULT_ACTION_ORDER"
	RuleOrder_STRICT_ORDER         RuleOrder = "STRICT_ORDER"
)

type RuleVariables 

type RuleVariables struct {
	IPSets   map[string]*IPSet   `json:"iPSets,omitempty"`
	PortSets map[string]*PortSet `json:"portSets,omitempty"`
}

Settings that are available for use in the rules in the RuleGroup where this is defined.

func (*RuleVariables) DeepCopy 

func (in *RuleVariables) DeepCopy() *RuleVariables

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RuleVariables.

func (*RuleVariables) DeepCopyInto 

func (in *RuleVariables) DeepCopyInto(out *RuleVariables)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RulesSource 

type RulesSource struct {
	// 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.
	RulesSourceList *RulesSourceList `json:"rulesSourceList,omitempty"`
	RulesString     *string          `json:"rulesString,omitempty"`
	StatefulRules   []*StatefulRule  `json:"statefulRules,omitempty"`
	// Stateless inspection criteria. Each stateless rule group uses exactly one
	// of these data types to define its stateless rules.
	StatelessRulesAndCustomActions *StatelessRulesAndCustomActions `json:"statelessRulesAndCustomActions,omitempty"`
}

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) DeepCopy 

func (in *RulesSource) DeepCopy() *RulesSource

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RulesSource.

func (*RulesSource) DeepCopyInto 

func (in *RulesSource) DeepCopyInto(out *RulesSource)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type RulesSourceList 

type RulesSourceList struct {
	GeneratedRulesType *string   `json:"generatedRulesType,omitempty"`
	TargetTypes        []*string `json:"targetTypes,omitempty"`
	Targets            []*string `json:"targets,omitempty"`
}

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) DeepCopy 

func (in *RulesSourceList) DeepCopy() *RulesSourceList

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new RulesSourceList.

func (*RulesSourceList) DeepCopyInto 

func (in *RulesSourceList) DeepCopyInto(out *RulesSourceList)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServerCertificate 

type ServerCertificate struct {
	ResourceARN *string `json:"resourceARN,omitempty"`
}

Any Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a ServerCertificateConfiguration. Used in a TLSInspectionConfiguration for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in Certificate Manager, see Request a public certificate (https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) or Importing certificates (https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the Certificate Manager User Guide.

func (*ServerCertificate) DeepCopy 

func (in *ServerCertificate) DeepCopy() *ServerCertificate

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerCertificate.

func (*ServerCertificate) DeepCopyInto 

func (in *ServerCertificate) DeepCopyInto(out *ServerCertificate)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServerCertificateConfiguration 

type ServerCertificateConfiguration struct {
	CertificateAuthorityARN *string `json:"certificateAuthorityARN,omitempty"`
}

Configures the Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a TLSInspectionConfiguration. You can configure ServerCertificates for inbound SSL/TLS inspection, a CertificateAuthorityArn for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see Using SSL/TLS server certficiates with TLS inspection configurations (https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the Network Firewall Developer Guide.

If a server certificate that's associated with your TLSInspectionConfiguration is revoked, deleted, or expired it can result in client-side TLS errors.

func (*ServerCertificateConfiguration) DeepCopy 

func (in *ServerCertificateConfiguration) DeepCopy() *ServerCertificateConfiguration

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerCertificateConfiguration.

func (*ServerCertificateConfiguration) DeepCopyInto 

func (in *ServerCertificateConfiguration) DeepCopyInto(out *ServerCertificateConfiguration)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ServerCertificateScope 

type ServerCertificateScope struct {
	DestinationPorts []*PortRange `json:"destinationPorts,omitempty"`
	Destinations     []*Address   `json:"destinations,omitempty"`
	Protocols        []*int64     `json:"protocols,omitempty"`
	SourcePorts      []*PortRange `json:"sourcePorts,omitempty"`
	Sources          []*Address   `json:"sources,omitempty"`
}

Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.

func (*ServerCertificateScope) DeepCopy 

func (in *ServerCertificateScope) DeepCopy() *ServerCertificateScope

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new ServerCertificateScope.

func (*ServerCertificateScope) DeepCopyInto 

func (in *ServerCertificateScope) DeepCopyInto(out *ServerCertificateScope)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SourceMetadata 

type SourceMetadata struct {
	SourceARN         *string `json:"sourceARN,omitempty"`
	SourceUpdateToken *string `json:"sourceUpdateToken,omitempty"`
}

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) DeepCopy 

func (in *SourceMetadata) DeepCopy() *SourceMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SourceMetadata.

func (*SourceMetadata) DeepCopyInto 

func (in *SourceMetadata) DeepCopyInto(out *SourceMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulAction 

type StatefulAction string
const (
	StatefulAction_PASS   StatefulAction = "PASS"
	StatefulAction_DROP   StatefulAction = "DROP"
	StatefulAction_ALERT  StatefulAction = "ALERT"
	StatefulAction_REJECT StatefulAction = "REJECT"
)

type StatefulEngineOptions 

type StatefulEngineOptions struct {
	RuleOrder             *string `json:"ruleOrder,omitempty"`
	StreamExceptionPolicy *string `json:"streamExceptionPolicy,omitempty"`
}

Configuration settings for the handling of the stateful rule groups in a firewall policy.

func (*StatefulEngineOptions) DeepCopy 

func (in *StatefulEngineOptions) DeepCopy() *StatefulEngineOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatefulEngineOptions.

func (*StatefulEngineOptions) DeepCopyInto 

func (in *StatefulEngineOptions) DeepCopyInto(out *StatefulEngineOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulRule 

type StatefulRule struct {
	Action *string `json:"action,omitempty"`
	// 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.
	Header      *Header       `json:"header,omitempty"`
	RuleOptions []*RuleOption `json:"ruleOptions,omitempty"`
}

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/en/suricata-6.0.9/rules/intro.html).

func (*StatefulRule) DeepCopy 

func (in *StatefulRule) DeepCopy() *StatefulRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatefulRule.

func (*StatefulRule) DeepCopyInto 

func (in *StatefulRule) DeepCopyInto(out *StatefulRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulRuleDirection 

type StatefulRuleDirection string
const (
	StatefulRuleDirection_FORWARD StatefulRuleDirection = "FORWARD"
	StatefulRuleDirection_ANY     StatefulRuleDirection = "ANY"
)

type StatefulRuleGroupOverride 

type StatefulRuleGroupOverride struct {
	Action *string `json:"action,omitempty"`
}

The setting that allows the policy owner to change the behavior of the rule group within a policy.

func (*StatefulRuleGroupOverride) DeepCopy 

func (in *StatefulRuleGroupOverride) DeepCopy() *StatefulRuleGroupOverride

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatefulRuleGroupOverride.

func (*StatefulRuleGroupOverride) DeepCopyInto 

func (in *StatefulRuleGroupOverride) DeepCopyInto(out *StatefulRuleGroupOverride)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulRuleGroupReference 

type StatefulRuleGroupReference struct {
	// The setting that allows the policy owner to change the behavior of the rule
	// group within a policy.
	Override    *StatefulRuleGroupOverride `json:"override,omitempty"`
	Priority    *int64                     `json:"priority,omitempty"`
	ResourceARN *string                    `json:"resourceARN,omitempty"`
}

Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.

func (*StatefulRuleGroupReference) DeepCopy 

func (in *StatefulRuleGroupReference) DeepCopy() *StatefulRuleGroupReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatefulRuleGroupReference.

func (*StatefulRuleGroupReference) DeepCopyInto 

func (in *StatefulRuleGroupReference) DeepCopyInto(out *StatefulRuleGroupReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulRuleOptions 

type StatefulRuleOptions struct {
	RuleOrder *string `json:"ruleOrder,omitempty"`
}

Additional options governing how Network Firewall handles the rule group. You can only use these for stateful rule groups.

func (*StatefulRuleOptions) DeepCopy 

func (in *StatefulRuleOptions) DeepCopy() *StatefulRuleOptions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatefulRuleOptions.

func (*StatefulRuleOptions) DeepCopyInto 

func (in *StatefulRuleOptions) DeepCopyInto(out *StatefulRuleOptions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatefulRuleProtocol 

type StatefulRuleProtocol string
const (
	StatefulRuleProtocol_IP     StatefulRuleProtocol = "IP"
	StatefulRuleProtocol_TCP    StatefulRuleProtocol = "TCP"
	StatefulRuleProtocol_UDP    StatefulRuleProtocol = "UDP"
	StatefulRuleProtocol_ICMP   StatefulRuleProtocol = "ICMP"
	StatefulRuleProtocol_HTTP   StatefulRuleProtocol = "HTTP"
	StatefulRuleProtocol_FTP    StatefulRuleProtocol = "FTP"
	StatefulRuleProtocol_TLS    StatefulRuleProtocol = "TLS"
	StatefulRuleProtocol_SMB    StatefulRuleProtocol = "SMB"
	StatefulRuleProtocol_DNS    StatefulRuleProtocol = "DNS"
	StatefulRuleProtocol_DCERPC StatefulRuleProtocol = "DCERPC"
	StatefulRuleProtocol_SSH    StatefulRuleProtocol = "SSH"
	StatefulRuleProtocol_SMTP   StatefulRuleProtocol = "SMTP"
	StatefulRuleProtocol_IMAP   StatefulRuleProtocol = "IMAP"
	StatefulRuleProtocol_MSN    StatefulRuleProtocol = "MSN"
	StatefulRuleProtocol_KRB5   StatefulRuleProtocol = "KRB5"
	StatefulRuleProtocol_IKEV2  StatefulRuleProtocol = "IKEV2"
	StatefulRuleProtocol_TFTP   StatefulRuleProtocol = "TFTP"
	StatefulRuleProtocol_NTP    StatefulRuleProtocol = "NTP"
	StatefulRuleProtocol_DHCP   StatefulRuleProtocol = "DHCP"
)

type StatelessRule 

type StatelessRule struct {
	Priority *int64 `json:"priority,omitempty"`
	// 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.
	RuleDefinition *RuleDefinition `json:"ruleDefinition,omitempty"`
}

A single stateless rule. This is used in StatelessRulesAndCustomActions.

func (*StatelessRule) DeepCopy 

func (in *StatelessRule) DeepCopy() *StatelessRule

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatelessRule.

func (*StatelessRule) DeepCopyInto 

func (in *StatelessRule) DeepCopyInto(out *StatelessRule)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatelessRuleGroupReference 

type StatelessRuleGroupReference struct {
	Priority    *int64  `json:"priority,omitempty"`
	ResourceARN *string `json:"resourceARN,omitempty"`
}

Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.

func (*StatelessRuleGroupReference) DeepCopy 

func (in *StatelessRuleGroupReference) DeepCopy() *StatelessRuleGroupReference

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatelessRuleGroupReference.

func (*StatelessRuleGroupReference) DeepCopyInto 

func (in *StatelessRuleGroupReference) DeepCopyInto(out *StatelessRuleGroupReference)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StatelessRulesAndCustomActions 

type StatelessRulesAndCustomActions struct {
	CustomActions  []*CustomAction  `json:"customActions,omitempty"`
	StatelessRules []*StatelessRule `json:"statelessRules,omitempty"`
}

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

func (*StatelessRulesAndCustomActions) DeepCopy 

func (in *StatelessRulesAndCustomActions) DeepCopy() *StatelessRulesAndCustomActions

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new StatelessRulesAndCustomActions.

func (*StatelessRulesAndCustomActions) DeepCopyInto 

func (in *StatelessRulesAndCustomActions) DeepCopyInto(out *StatelessRulesAndCustomActions)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type StreamExceptionPolicy 

type StreamExceptionPolicy string
const (
	StreamExceptionPolicy_DROP     StreamExceptionPolicy = "DROP"
	StreamExceptionPolicy_CONTINUE StreamExceptionPolicy = "CONTINUE"
	StreamExceptionPolicy_REJECT   StreamExceptionPolicy = "REJECT"
)

type SubnetMapping 

type SubnetMapping struct {
	IPAddressType *string `json:"iPAddressType,omitempty"`
	SubnetID      *string `json:"subnetID,omitempty"`
}

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) DeepCopy 

func (in *SubnetMapping) DeepCopy() *SubnetMapping

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SubnetMapping.

func (*SubnetMapping) DeepCopyInto 

func (in *SubnetMapping) DeepCopyInto(out *SubnetMapping)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type SyncState 

type SyncState struct {
	// 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.
	Attachment *Attachment                 `json:"attachment,omitempty"`
	Config     map[string]*PerObjectStatus `json:"config,omitempty"`
}

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) DeepCopy 

func (in *SyncState) DeepCopy() *SyncState

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new SyncState.

func (*SyncState) DeepCopyInto 

func (in *SyncState) DeepCopyInto(out *SyncState)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TCPFlag 

type TCPFlag string
const (
	TCPFlag_FIN TCPFlag = "FIN"
	TCPFlag_SYN TCPFlag = "SYN"
	TCPFlag_RST TCPFlag = "RST"
	TCPFlag_PSH TCPFlag = "PSH"
	TCPFlag_ACK TCPFlag = "ACK"
	TCPFlag_URG TCPFlag = "URG"
	TCPFlag_ECE TCPFlag = "ECE"
	TCPFlag_CWR TCPFlag = "CWR"
)

type TCPFlagField 

type TCPFlagField struct {
	Flags []*string `json:"flags,omitempty"`
	Masks []*string `json:"masks,omitempty"`
}

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

func (*TCPFlagField) DeepCopy 

func (in *TCPFlagField) DeepCopy() *TCPFlagField

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TCPFlagField.

func (*TCPFlagField) DeepCopyInto 

func (in *TCPFlagField) DeepCopyInto(out *TCPFlagField)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSCertificateData 

type TLSCertificateData struct {
	CertificateARN    *string `json:"certificateARN,omitempty"`
	CertificateSerial *string `json:"certificateSerial,omitempty"`
	Status            *string `json:"status,omitempty"`
}

Contains metadata about an Certificate Manager certificate.

func (*TLSCertificateData) DeepCopy 

func (in *TLSCertificateData) DeepCopy() *TLSCertificateData

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSCertificateData.

func (*TLSCertificateData) DeepCopyInto 

func (in *TLSCertificateData) DeepCopyInto(out *TLSCertificateData)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSInspectionConfigurationMetadata 

type TLSInspectionConfigurationMetadata struct {
	ARN  *string `json:"arn,omitempty"`
	Name *string `json:"name,omitempty"`
}

High-level information about a TLS inspection configuration, returned by ListTLSInspectionConfigurations. You can use the information provided in the metadata to retrieve and manage a TLS configuration.

func (*TLSInspectionConfigurationMetadata) DeepCopy 

func (in *TLSInspectionConfigurationMetadata) DeepCopy() *TLSInspectionConfigurationMetadata

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSInspectionConfigurationMetadata.

func (*TLSInspectionConfigurationMetadata) DeepCopyInto 

func (in *TLSInspectionConfigurationMetadata) DeepCopyInto(out *TLSInspectionConfigurationMetadata)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TLSInspectionConfigurationResponse 

type TLSInspectionConfigurationResponse struct {
	Description *string `json:"description,omitempty"`
	// 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 `json:"encryptionConfiguration,omitempty"`
	LastModifiedTime                 *metav1.Time             `json:"lastModifiedTime,omitempty"`
	NumberOfAssociations             *int64                   `json:"numberOfAssociations,omitempty"`
	TLSInspectionConfigurationARN    *string                  `json:"tlsInspectionConfigurationARN,omitempty"`
	TLSInspectionConfigurationID     *string                  `json:"tlsInspectionConfigurationID,omitempty"`
	TLSInspectionConfigurationName   *string                  `json:"tlsInspectionConfigurationName,omitempty"`
	TLSInspectionConfigurationStatus *string                  `json:"tlsInspectionConfigurationStatus,omitempty"`
	Tags                             []*Tag                   `json:"tags,omitempty"`
}

The high-level properties of a TLS inspection configuration. This, along with the TLSInspectionConfiguration, define the TLS inspection configuration. You can retrieve all objects for a TLS inspection configuration by calling DescribeTLSInspectionConfiguration.

func (*TLSInspectionConfigurationResponse) DeepCopy 

func (in *TLSInspectionConfigurationResponse) DeepCopy() *TLSInspectionConfigurationResponse

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new TLSInspectionConfigurationResponse.

func (*TLSInspectionConfigurationResponse) DeepCopyInto 

func (in *TLSInspectionConfigurationResponse) DeepCopyInto(out *TLSInspectionConfigurationResponse)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Tag 

type Tag struct {
	Key   *string `json:"key,omitempty"`
	Value *string `json:"value,omitempty"`
}

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) DeepCopy 

func (in *Tag) DeepCopy() *Tag

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Tag.

func (*Tag) DeepCopyInto 

func (in *Tag) DeepCopyInto(out *Tag)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type TargetType 

type TargetType string
const (
	TargetType_TLS_SNI   TargetType = "TLS_SNI"
	TargetType_HTTP_HOST TargetType = "HTTP_HOST"
)

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.