software.amazon.awscdk.services.networkfirewall

Class CfnLoggingConfiguration

java.lang.Object

software.constructs.Construct

software.amazon.awscdk.core.Construct

software.amazon.awscdk.core.CfnElement

software.amazon.awscdk.core.CfnRefElement

software.amazon.awscdk.core.CfnResource

software.amazon.awscdk.services.networkfirewall.CfnLoggingConfiguration

All Implemented Interfaces:

IConstruct, IDependable, IInspectable

@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)",
           date="2023-03-22T19:35:38.891Z")
public class CfnLoggingConfiguration
extends CfnResource
implements IInspectable

A CloudFormation `AWS::NetworkFirewall::LoggingConfiguration`.

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();
 

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	CfnLoggingConfiguration.Builder A fluent builder for CfnLoggingConfiguration.
static interface	CfnLoggingConfiguration.LogDestinationConfigProperty Defines where AWS Network Firewall sends logs for the firewall for one log type.
static interface	CfnLoggingConfiguration.LoggingConfigurationProperty Defines how AWS Network Firewall performs logging for a `Firewall` .

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IInspectable

IInspectable.Jsii$Default, IInspectable.Jsii$Proxy

Nested classes/interfaces inherited from interface software.amazon.awscdk.core.IConstruct

IConstruct.Jsii$Default

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLoggingConfiguration(Construct scope, java.lang.String id, CfnLoggingConfigurationProps props) Create a new `AWS::NetworkFirewall::LoggingConfiguration`.
protected	CfnLoggingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
protected	CfnLoggingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)

Method Summary

Modifier and Type	Method and Description
protected java.util.Map<java.lang.String,java.lang.Object>	getCfnProperties()
java.lang.String	getFirewallArn() The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.
java.lang.String	getFirewallName() The name of the firewall that the logging configuration is associated with.
java.lang.Object	getLoggingConfiguration() Defines how AWS Network Firewall performs logging for a `Firewall` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected java.util.Map<java.lang.String,java.lang.Object>	renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
void	setFirewallArn(java.lang.String value) The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.
void	setFirewallName(java.lang.String value) The name of the firewall that the logging configuration is associated with.
void	setLoggingConfiguration(CfnLoggingConfiguration.LoggingConfigurationProperty value) Defines how AWS Network Firewall performs logging for a `Firewall` .
void	setLoggingConfiguration(IResolvable value) Defines how AWS Network Firewall performs logging for a `Firewall` .

Methods inherited from class software.amazon.awscdk.core.CfnResource

addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties

Methods inherited from class software.amazon.awscdk.core.CfnRefElement

getRef

Methods inherited from class software.amazon.awscdk.core.CfnElement

getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId

Methods inherited from class software.amazon.awscdk.core.Construct

getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Field Detail

CFN_RESOURCE_TYPE_NAME

public static final java.lang.String CFN_RESOURCE_TYPE_NAME

The CloudFormation resource type name for this resource class.

Constructor Detail

CfnLoggingConfiguration

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

CfnLoggingConfiguration

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

CfnLoggingConfiguration

public CfnLoggingConfiguration(Construct scope,
                               java.lang.String id,
                               CfnLoggingConfigurationProps props)

Create a new `AWS::NetworkFirewall::LoggingConfiguration`.

Parameters:

scope - - scope in which this resource is defined. This parameter is required.

id - - scoped id of the resource. This parameter is required.

props - - resource properties. This parameter is required.

Method Detail

inspect

public void inspect(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

protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)

Overrides:

renderProperties in class CfnResource

Parameters:

props - This parameter is required.

getCfnProperties

protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFirewallArn

public java.lang.String getFirewallArn()

The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.

You can't change the firewall specification after you create the logging configuration.

setFirewallArn

public void setFirewallArn(java.lang.String value)

The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.

You can't change the firewall specification after you create the logging configuration.

getLoggingConfiguration

public java.lang.Object getLoggingConfiguration()

Defines how AWS Network Firewall performs logging for a `Firewall` .

setLoggingConfiguration

public void setLoggingConfiguration(IResolvable value)

Defines how AWS Network Firewall performs logging for a `Firewall` .

setLoggingConfiguration

public void setLoggingConfiguration(CfnLoggingConfiguration.LoggingConfigurationProperty value)

Defines how AWS Network Firewall performs logging for a `Firewall` .

getFirewallName

public java.lang.String getFirewallName()

The name of the firewall that the logging configuration is associated with.

You can't change the firewall specification after you create the logging configuration.

setFirewallName

public void setFirewallName(java.lang.String value)

The name of the firewall that the logging configuration is associated with.

You can't change the firewall specification after you create the logging configuration.