software.amazon.awscdk.services.networkfirewall

Class CfnLoggingConfiguration

java.lang.Object

software.amazon.jsii.JsiiObject

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:

IDependable, IInspectable, software.amazon.jsii.JsiiSerializable, software.constructs.IConstruct

@Generated(value="jsii-pacmak/1.71.0 (build f1f58ae)",
           date="2022-12-07T17:24:37.343Z")
 @Stability(value=Stable)
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 class software.amazon.jsii.JsiiObject

software.amazon.jsii.JsiiObject.InitializationMode

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 String	CFN_RESOURCE_TYPE_NAME The CloudFormation resource type name for this resource class.

Constructor Summary

Constructors

Modifier	Constructor and Description
	CfnLoggingConfiguration(Construct scope, 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 Map<String,Object>	getCfnProperties()
String	getFirewallArn() The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.
String	getFirewallName() The name of the firewall that the logging configuration is associated with.
Object	getLoggingConfiguration() Defines how AWS Network Firewall performs logging for a `Firewall` .
void	inspect(TreeInspector inspector) Examines the CloudFormation resource and discloses attributes.
protected Map<String,Object>	renderProperties(Map<String,Object> props)
void	setFirewallArn(String value) The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with.
void	setFirewallName(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 software.amazon.jsii.JsiiObject

jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object

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

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

Field Detail

CFN_RESOURCE_TYPE_NAME

@Stability(value=Stable)
public static final 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

@Stability(value=Stable)
public CfnLoggingConfiguration(@NotNull
                                                        Construct scope,
                                                        @NotNull
                                                        String id,
                                                        @NotNull
                                                        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

@Stability(value=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(value=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(value=Stable)
 @NotNull
protected Map<String,Object> getCfnProperties()

Overrides:

getCfnProperties in class CfnResource

getFirewallArn

@Stability(value=Stable)
 @NotNull
public 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

@Stability(value=Stable)
public void setFirewallArn(@NotNull
                                                    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

@Stability(value=Stable)
 @NotNull
public Object getLoggingConfiguration()

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

setLoggingConfiguration

@Stability(value=Stable)
public void setLoggingConfiguration(@NotNull
                                                             IResolvable value)

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

setLoggingConfiguration

@Stability(value=Stable)
public void setLoggingConfiguration(@NotNull
                                                             CfnLoggingConfiguration.LoggingConfigurationProperty value)

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

getFirewallName

@Stability(value=Stable)
 @Nullable
public 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

@Stability(value=Stable)
public void setFirewallName(@Nullable
                                                     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.