Network Firewall

6 resource kinds. Generated from the operator's CRD schemas.

API Group: aws.konfig.io/v1alpha1

Firewall # GA

Firewall is the Schema for managing AWS Network Firewall firewalls.

kubectl get firewalls · example on GitHub

Example

# Firewall — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#firewall
apiVersion: aws.konfig.io/v1alpha1
kind: Firewall
metadata:
  name: example-firewall
  namespace: default
spec:
  deleteProtection: true
  description: Managed by konfig-konector
  firewallPolicyRef:
    name: example-firewallpolicy
  name: example-firewall
  providerRef:
    name: example-firewall
    region: us-east-1
  subnetRefs:
  - name: example-subnetrefs
  tags:
    environment: dev
    team: platform
  vpcRef:
    name: example-vpc

Spec

FieldTypeRequiredDescription
deleteProtectionboolean—DeleteProtection prevents deletion of the firewall while enabled.
descriptionstring—Description of the firewall.
firewallPolicyRefobjectyesFirewallPolicyRef references the firewall policy to use.
firewallPolicyRef.arnstring—ARN is a direct AWS firewall policy ARN.
firewallPolicyRef.namestring—Name of a FirewallPolicy CR in the same namespace.
namestringyesName is the descriptive name of the firewall.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
subnetRefsarray<object>yesSubnetRefs are the subnets to place firewall endpoints in.
subnetRefs[].idstring—ID is a direct AWS Subnet ID (e.g.
subnetRefs[].namestring—Name of a Subnet CR in the same namespace.
tagsmap<string>—Tags are AWS resource tags to apply.
vpcRefobjectyesVPCRef references the VPC where the firewall is created.
vpcRef.idstring—ID is a direct AWS VPC ID (e.g.
vpcRef.namestring—Name of a VPC CR in the same namespace.

Status

FieldTypeRequiredDescription
arnstring—ARN is the Amazon Resource Name of the firewall.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—ID is the unique identifier of the firewall.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
statestring—State is the readiness state reported by AWS (PROVISIONING, READY, DELETING).

FirewallPolicy # GA

FirewallPolicy is the Schema for managing AWS Network Firewall policies.

kubectl get firewallpolicies · example on GitHub

Example

# FirewallPolicy — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#firewallpolicy
apiVersion: aws.konfig.io/v1alpha1
kind: FirewallPolicy
metadata:
  name: example-firewallpolicy
  namespace: default
spec:
  description: Managed by konfig-konector
  name: example-firewallpolicy
  providerRef:
    name: example-firewallpolicy
    region: us-east-1
  statefulRuleGroupRefs:
  - name: example-statefulrulegrouprefs
  statelessDefaultActions:
  - example
  statelessFragmentDefaultActions:
  - example
  statelessRuleGroupRefs:
  - arn: arn:aws:iam::123456789012:role/example-role
    name: example-firewallpolicy
    priority: 1
  tags:
    environment: dev
    team: platform

Spec

FieldTypeRequiredDescription
descriptionstring—Description of the firewall policy.
namestringyesName is the descriptive name of the firewall policy.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
statefulRuleGroupRefsarray<object>—StatefulRuleGroupRefs references the stateful rule groups in the policy.
statefulRuleGroupRefs[].arnstring—ARN is a direct AWS rule group ARN.
statefulRuleGroupRefs[].namestring—Name of a FirewallRuleGroup CR in the same namespace.
statelessDefaultActionsarray<string>yesStatelessDefaultActions are the actions for packets that don't match any stateless rule (e.g.
statelessFragmentDefaultActionsarray<string>yesStatelessFragmentDefaultActions are the actions for fragmented UDP packets that don't match any stateless rule.
statelessRuleGroupRefsarray<object>—StatelessRuleGroupRefs references the stateless rule groups in the policy.
statelessRuleGroupRefs[].arnstring—ARN is a direct AWS rule group ARN.
statelessRuleGroupRefs[].namestring—Name of a FirewallRuleGroup CR in the same namespace.
statelessRuleGroupRefs[].priorityintegeryesPriority is the order in which to run this rule group.
tagsmap<string>—Tags are AWS resource tags to apply.

Status

FieldTypeRequiredDescription
arnstring—ARN is the Amazon Resource Name of the firewall policy.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—ID is the unique identifier of the firewall policy.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
updateTokenstring—UpdateToken is the optimistic-locking token from the last read.

FirewallRuleGroup # GA

FirewallRuleGroup is the Schema for managing AWS Network Firewall rule groups.

kubectl get firewallrulegroups · example on GitHub

Example

# FirewallRuleGroup — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#firewallrulegroup
apiVersion: aws.konfig.io/v1alpha1
kind: FirewallRuleGroup
metadata:
  name: example-firewallrulegroup
  namespace: default
spec:
  capacity: 1
  description: Managed by konfig-konector
  name: example-firewallrulegroup
  providerRef:
    name: example-firewallrulegroup
    region: us-east-1
  rulesString: example
  tags:
    environment: dev
    team: platform
  type: STATELESS

Spec

FieldTypeRequiredDescription
capacityintegeryesCapacity is the maximum operating resources this rule group can use.
descriptionstring—Description of the rule group.
namestringyesName is the descriptive name of the rule group.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
rulesStringstring—RulesString contains the rule definitions in Suricata-compatible format (stateful) or as a rules source string (stateless).
tagsmap<string>—Tags are AWS resource tags to apply.
typeenumyesType indicates whether the rule group is stateless or stateful. Allowed: STATELESS, STATEFUL

Status

FieldTypeRequiredDescription
arnstring—ARN is the Amazon Resource Name of the rule group.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
idstring—ID is the unique identifier of the rule group.
lastSyncTimestring—LastSyncTime is when the resource was last successfully reconciled.
observedGenerationinteger—ObservedGeneration is the most recent .metadata.generation reconciled.
updateTokenstring—UpdateToken is the optimistic-locking token from the last read.

NetworkFirewallLoggingConfiguration # CLOUD CONTROL · AWS::NetworkFirewall::LoggingConfiguration

NetworkFirewallLoggingConfiguration manages AWS::NetworkFirewall::LoggingConfiguration through the AWS Cloud Control API.

kubectl get networkfirewallloggingconfigurations · example on GitHub

Example

# NetworkFirewallLoggingConfiguration — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#networkfirewallloggingconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: NetworkFirewallLoggingConfiguration
metadata:
  name: example-networkfirewallloggingconfiguration
  namespace: default
spec:
  enableMonitoringDashboard: true
  firewallArn: arn:aws:iam::123456789012:role/example-role
  firewallName: example-networkfirewallloggingconfiguration
  loggingConfiguration:
    logDestinationConfigs:
    - logDestination:
        key: value
      logDestinationType: S3
      logType: ALERT
  providerRef:
    name: example-networkfirewallloggingconfiguration
    region: us-east-1

Spec

FieldTypeRequiredDescription
enableMonitoringDashboardboolean—
firewallArnstringyesCreate-only in AWS: changing it requires replacing the resource.
firewallNamestring—Create-only in AWS: changing it requires replacing the resource.
loggingConfigurationobjectyesNetworkFirewallLoggingConfigurationLoggingConfiguration is a nested property type of AWS::NetworkFirewall::LoggingConfiguration.
loggingConfiguration.logDestinationConfigsarray<object>yes
loggingConfiguration.logDestinationConfigs[].logDestinationmap<string>yesA key-value pair to configure the logDestinations.
loggingConfiguration.logDestinationConfigs[].logDestinationTypeenumyesAllowed: S3, CloudWatchLogs, KinesisDataFirehose
loggingConfiguration.logDestinationConfigs[].logTypeenumyesAllowed: ALERT, FLOW, TLS
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.

NetworkFirewallTLSInspectionConfiguration # CLOUD CONTROL · AWS::NetworkFirewall::TLSInspectionConfiguration

NetworkFirewallTLSInspectionConfiguration manages AWS::NetworkFirewall::TLSInspectionConfiguration through the AWS Cloud Control API.

kubectl get networkfirewalltlsinspectionconfigurations · example on GitHub

Example

# NetworkFirewallTLSInspectionConfiguration — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#networkfirewalltlsinspectionconfiguration
apiVersion: aws.konfig.io/v1alpha1
kind: NetworkFirewallTLSInspectionConfiguration
metadata:
  name: example-networkfirewalltlsinspectionconfiguration
  namespace: default
spec:
  description: Managed by konfig-konector
  providerRef:
    name: example-networkfirewalltlsinspectionconfiguration
    region: us-east-1
  tags:
  - key: example
    value: example
  tlsInspectionConfiguration:
    serverCertificateConfigurations:
    - certificateAuthorityArn: arn:aws:iam::123456789012:role/example-role
      scopes:
      - destinationPorts:
        - fromPort: 1
          toPort: 1
        destinations:
        - addressDefinition: example
        protocols:
        - 1
        sourcePorts:
        - fromPort: 1
          toPort: 1
        sources:
        - addressDefinition: example
      serverCertificates:
      - resourceArn: arn:aws:iam::123456789012:role/example-role
  tlsInspectionConfigurationName: example-networkfirewalltlsinspectionconfiguration

Spec

FieldTypeRequiredDescription
descriptionstring—
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
tlsInspectionConfigurationobjectyesNetworkFirewallTLSInspectionConfigurationTLSInspectionConfiguration is a nested property type of AWS::NetworkFirewall::TLSInspectionConfiguration.
tlsInspectionConfiguration.serverCertificateConfigurationsarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].certificateAuthorityArnstring—
tlsInspectionConfiguration.serverCertificateConfigurations[].checkCertificateRevocationStatusobject—NetworkFirewallTLSInspectionConfigurationServerCertificateConfigurationCheckCertificateRevocationStatus is a nested property type of AWS::NetworkFirewall::TLSInspectionConfiguration.
tlsInspectionConfiguration.serverCertificateConfigurations[].checkCertificateRevocationStatus.revokedStatusActionenum—Allowed: PASS, DROP, REJECT
tlsInspectionConfiguration.serverCertificateConfigurations[].checkCertificateRevocationStatus.unknownStatusActionenum—Allowed: PASS, DROP, REJECT
tlsInspectionConfiguration.serverCertificateConfigurations[].scopesarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].destinationPortsarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].destinationPorts[].fromPortintegeryes
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].destinationPorts[].toPortintegeryes
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].destinationsarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].destinations[].addressDefinitionstringyes
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].protocolsarray<integer>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].sourcePortsarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].sourcePorts[].fromPortintegeryes
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].sourcePorts[].toPortintegeryes
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].sourcesarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].scopes[].sources[].addressDefinitionstringyes
tlsInspectionConfiguration.serverCertificateConfigurations[].serverCertificatesarray<object>—
tlsInspectionConfiguration.serverCertificateConfigurations[].serverCertificates[].resourceArnstring—
tlsInspectionConfigurationNamestringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
tlsInspectionConfigurationArnstring—Read-only: reported by AWS after creation.
tlsInspectionConfigurationIdstring—Read-only: reported by AWS after creation.

NetworkFirewallVpcEndpointAssociation # CLOUD CONTROL · AWS::NetworkFirewall::VpcEndpointAssociation

NetworkFirewallVpcEndpointAssociation manages AWS::NetworkFirewall::VpcEndpointAssociation through the AWS Cloud Control API.

kubectl get networkfirewallvpcendpointassociations · example on GitHub

Example

# NetworkFirewallVpcEndpointAssociation — Network Firewall
# Full-options example generated from the CRD schema. Optional fields are
# included with sample values; delete what you don't need. Field reference:
# https://konfig-konector.io/docs/networkfirewall.html#networkfirewallvpcendpointassociation
apiVersion: aws.konfig.io/v1alpha1
kind: NetworkFirewallVpcEndpointAssociation
metadata:
  name: example-networkfirewallvpcendpointassociation
  namespace: default
spec:
  description: Managed by konfig-konector
  firewallArn: arn:aws:iam::123456789012:role/example-role
  providerRef:
    name: example-networkfirewallvpcendpointassociation
    region: us-east-1
  subnetMapping:
    ipAddressType: example
    subnetId: subnet-0abc12def3456789
  tags:
  - key: example
    value: example
  vpcId: vpc-0abc12def3456789

Spec

FieldTypeRequiredDescription
descriptionstring—Create-only in AWS: changing it requires replacing the resource.
firewallArnstringyesCreate-only in AWS: changing it requires replacing the resource.
providerRefobject—ProviderRef selects the AWSProvider (account/region) this resource is reconciled against.
providerRef.namestringyesName of a cluster-scoped AWSProvider.
providerRef.regionstring—Region overrides the provider's region for this resource only.
subnetMappingobjectyesCreate-only in AWS: changing it requires replacing the resource.
subnetMapping.ipAddressTypestring—A IPAddressType
subnetMapping.subnetIdstringyesA SubnetId.
tagsarray<object>—
tags[].keystringyes
tags[].valuestringyes
vpcIdstringyesCreate-only in AWS: changing it requires replacing the resource.

Status

FieldTypeRequiredDescription
attemptinteger—Attempt counts failed create/delete requests; it salts the Cloud Control idempotency token so a retry is not served the cached failure.
awsProviderobject—AWSProvider confirms the account and region this resource was reconciled against.
awsProvider.accountIdstring—AccountID the resource lives in.
awsProvider.namestring—Name of the AWSProvider used; empty when the operator's own credentials were used.
awsProvider.regionstring—Region the resource lives in (empty for global services).
conditionsarray<object>—Conditions describe the current state of the resource.
conditions[].lastTransitionTimestringyeslastTransitionTime is the last time the condition transitioned from one status to another.
conditions[].messagestringyesmessage is a human readable message indicating details about the transition.
conditions[].observedGenerationinteger—observedGeneration represents the .metadata.generation that the condition was set based upon.
conditions[].reasonstringyesreason contains a programmatic identifier indicating the reason for the condition's last transition.
conditions[].statusenumyesstatus of the condition, one of True, False, Unknown. Allowed: True, False, Unknown
conditions[].typestringyestype of condition in CamelCase or in foo.example.com/CamelCase.
endpointIdstring—Read-only: reported by AWS after creation.
identifierstring—Identifier is the Cloud Control primary identifier of the resource.
lastSyncTimestring—
observedGenerationinteger—
operationstring—Operation is the in-flight operation (CREATE, UPDATE, DELETE).
operationStatusstring—OperationStatus is the last reported operation status.
requestTokenstring—RequestToken tracks an in-flight asynchronous operation.
vpcEndpointAssociationArnstring—Read-only: reported by AWS after creation.
vpcEndpointAssociationIdstring—Read-only: reported by AWS after creation.