@Generated(value="jsii-pacmak/1.74.0 (build 6d08790)", date="2023-03-22T19:35:38.891Z") 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:
LogDestinationConfig
array element to LogDestinationConfigs
.LogDestinationConfig
array element from LogDestinationConfigs
.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();
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` .
|
IInspectable.Jsii$Default, IInspectable.Jsii$Proxy
IConstruct.Jsii$Default
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CFN_RESOURCE_TYPE_NAME
The CloudFormation resource type name for this resource class.
|
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) |
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` .
|
addDeletionOverride, addDependsOn, addMetadata, addOverride, addPropertyDeletionOverride, addPropertyOverride, applyRemovalPolicy, applyRemovalPolicy, applyRemovalPolicy, getAtt, getCfnOptions, getCfnResourceType, getMetadata, getUpdatedProperites, isCfnResource, shouldSynthesize, toString, validateProperties
getRef
getCreationStack, getLogicalId, getStack, isCfnElement, overrideLogicalId
getNode, isConstruct, onPrepare, onSynthesize, onValidate, prepare, synthesize, validate
public static final java.lang.String CFN_RESOURCE_TYPE_NAME
protected CfnLoggingConfiguration(software.amazon.jsii.JsiiObjectRef objRef)
protected CfnLoggingConfiguration(software.amazon.jsii.JsiiObject.InitializationMode initializationMode)
public CfnLoggingConfiguration(Construct scope, java.lang.String id, CfnLoggingConfigurationProps props)
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.public void inspect(TreeInspector inspector)
inspect
in interface IInspectable
inspector
- - tree inspector to collect and process attributes. This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> renderProperties(java.util.Map<java.lang.String,java.lang.Object> props)
renderProperties
in class CfnResource
props
- This parameter is required.protected java.util.Map<java.lang.String,java.lang.Object> getCfnProperties()
getCfnProperties
in class CfnResource
public java.lang.String getFirewallArn()
You can't change the firewall specification after you create the logging configuration.
public void setFirewallArn(java.lang.String value)
You can't change the firewall specification after you create the logging configuration.
public java.lang.Object getLoggingConfiguration()
public void setLoggingConfiguration(IResolvable value)
public void setLoggingConfiguration(CfnLoggingConfiguration.LoggingConfigurationProperty value)
public java.lang.String getFirewallName()
You can't change the firewall specification after you create the logging configuration.
public void setFirewallName(java.lang.String value)
You can't change the firewall specification after you create the logging configuration.