Package software.amazon.awscdk.services.networkfirewall

Class CfnLoggingConfiguration

java.lang.Object
software.amazon.jsii.JsiiObject
software.constructs.Construct
software.amazon.awscdk.CfnElement
software.amazon.awscdk.CfnRefElement
software.amazon.awscdk.CfnResource
software.amazon.awscdk.services.networkfirewall.CfnLoggingConfiguration
All Implemented Interfaces:
IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct, software.constructs.IDependable
@Generated(value="jsii-pacmak/1.97.0 (build 729de35)", date="2024-04-18T17:54:20.138Z") @Stability(Stable) public class CfnLoggingConfiguration extends CfnResource implements IInspectable
Use the LoggingConfiguration to define the destinations and logging options for an Firewall .

You must change the logging configuration by changing one LogDestinationConfig setting at a time in your LogDestinationConfigs .

You can make only one of the following changes to your LoggingConfiguration resource:

  • Create a new log destination object by adding a single LogDestinationConfig array element to LogDestinationConfigs .
  • Delete a log destination object by removing a single LogDestinationConfig array element from LogDestinationConfigs .
  • Change the LogDestination setting in a single LogDestinationConfig array element.

You can't change the LogDestinationType or LogType in a LogDestinationConfig . To change these settings, delete the existing LogDestinationConfig object and create a new one, in two separate modifications.

Example: 

 // The code below shows an example of how to instantiate this type.
 // The values are placeholders you should change.
 import software.amazon.awscdk.services.networkfirewall.*;
 CfnLoggingConfiguration cfnLoggingConfiguration = CfnLoggingConfiguration.Builder.create(this, "MyCfnLoggingConfiguration")
         .firewallArn("firewallArn")
         .loggingConfiguration(LoggingConfigurationProperty.builder()
                 .logDestinationConfigs(List.of(LogDestinationConfigProperty.builder()
                         .logDestination(Map.of(
                                 "logDestinationKey", "logDestination"))
                         .logDestinationType("logDestinationType")
                         .logType("logType")
                         .build()))
                 .build())
         // the properties below are optional
         .firewallName("firewallName")
         .build();

See Also:

  • Field Details

    • CFN_RESOURCE_TYPE_NAME

      @Stability(Stable) public static final String CFN_RESOURCE_TYPE_NAME
      The CloudFormation resource type name for this resource class.

  • Constructor Details

    • CfnLoggingConfiguration

      protected CfnLoggingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

    • CfnLoggingConfiguration

      protected CfnLoggingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)

    • CfnLoggingConfiguration

      @Stability(Stable) public CfnLoggingConfiguration(@NotNull software.constructs.Construct scope, @NotNull String id, @NotNull CfnLoggingConfigurationProps props)
      Parameters:
      scope - Scope in which this resource is defined. This parameter is required.
      id - Construct identifier for this resource (unique in its scope). This parameter is required.
      props - Resource properties. This parameter is required.

  • Method Details

    • inspect

      @Stability(Stable) public void inspect(@NotNull TreeInspector inspector)
      Examines the CloudFormation resource and discloses attributes.

      Specified by:
      inspect in interface IInspectable
      Parameters:
      inspector - tree inspector to collect and process attributes. This parameter is required.

    • renderProperties

      @Stability(Stable) @NotNull protected Map<String,Object> renderProperties(@NotNull Map<String,Object> props)
      Overrides:
      renderProperties in class CfnResource
      Parameters:
      props - This parameter is required.

    • getCfnProperties

      @Stability(Stable) @NotNull protected Map<String,Object> getCfnProperties()
      Overrides:
      getCfnProperties in class CfnResource

    • getFirewallArn

      @Stability(Stable) @NotNull public String getFirewallArn()
      The Amazon Resource Name (ARN) of the Firewall that the logging configuration is associated with.

    • setFirewallArn

      @Stability(Stable) public void setFirewallArn(@NotNull String value)
      The Amazon Resource Name (ARN) of the Firewall that the logging configuration is associated with.

    • getLoggingConfiguration

      @Stability(Stable) @NotNull public Object getLoggingConfiguration()
      Defines how AWS Network Firewall performs logging for a Firewall .

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@NotNull IResolvable value)
      Defines how AWS Network Firewall performs logging for a Firewall .

    • setLoggingConfiguration

      @Stability(Stable) public void setLoggingConfiguration(@NotNull CfnLoggingConfiguration.LoggingConfigurationProperty value)
      Defines how AWS Network Firewall performs logging for a Firewall .

    • getFirewallName

      @Stability(Stable) @Nullable public String getFirewallName()
      The name of the firewall that the logging configuration is associated with.

    • setFirewallName

      @Stability(Stable) public void setFirewallName(@Nullable String value)
      The name of the firewall that the logging configuration is associated with.