Documentation ¶
Index ¶
- func CfnFirewallPolicy_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFirewallPolicy_IsCfnElement(x interface{}) *bool
- func CfnFirewallPolicy_IsCfnResource(x interface{}) *bool
- func CfnFirewallPolicy_IsConstruct(x interface{}) *bool
- func CfnFirewall_CFN_RESOURCE_TYPE_NAME() *string
- func CfnFirewall_IsCfnElement(x interface{}) *bool
- func CfnFirewall_IsCfnResource(x interface{}) *bool
- func CfnFirewall_IsConstruct(x interface{}) *bool
- func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnLoggingConfiguration_IsCfnElement(x interface{}) *bool
- func CfnLoggingConfiguration_IsCfnResource(x interface{}) *bool
- func CfnLoggingConfiguration_IsConstruct(x interface{}) *bool
- func CfnRuleGroup_CFN_RESOURCE_TYPE_NAME() *string
- func CfnRuleGroup_IsCfnElement(x interface{}) *bool
- func CfnRuleGroup_IsCfnResource(x interface{}) *bool
- func CfnRuleGroup_IsConstruct(x interface{}) *bool
- func CfnTLSInspectionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
- func CfnTLSInspectionConfiguration_IsCfnElement(x interface{}) *bool
- func CfnTLSInspectionConfiguration_IsCfnResource(x interface{}) *bool
- func CfnTLSInspectionConfiguration_IsConstruct(x interface{}) *bool
- func NewCfnFirewallPolicy_Override(c CfnFirewallPolicy, scope constructs.Construct, id *string, ...)
- func NewCfnFirewall_Override(c CfnFirewall, scope constructs.Construct, id *string, props *CfnFirewallProps)
- func NewCfnLoggingConfiguration_Override(c CfnLoggingConfiguration, scope constructs.Construct, id *string, ...)
- func NewCfnRuleGroup_Override(c CfnRuleGroup, scope constructs.Construct, id *string, ...)
- func NewCfnTLSInspectionConfiguration_Override(c CfnTLSInspectionConfiguration, scope constructs.Construct, id *string, ...)
- type CfnFirewall
- type CfnFirewallPolicy
- type CfnFirewallPolicyProps
- type CfnFirewallPolicy_ActionDefinitionProperty
- type CfnFirewallPolicy_CustomActionProperty
- type CfnFirewallPolicy_DimensionProperty
- type CfnFirewallPolicy_FirewallPolicyProperty
- type CfnFirewallPolicy_IPSetProperty
- type CfnFirewallPolicy_PolicyVariablesProperty
- type CfnFirewallPolicy_PublishMetricActionProperty
- type CfnFirewallPolicy_StatefulEngineOptionsProperty
- type CfnFirewallPolicy_StatefulRuleGroupOverrideProperty
- type CfnFirewallPolicy_StatefulRuleGroupReferenceProperty
- type CfnFirewallPolicy_StatelessRuleGroupReferenceProperty
- type CfnFirewallProps
- type CfnFirewall_SubnetMappingProperty
- type CfnLoggingConfiguration
- type CfnLoggingConfigurationProps
- type CfnLoggingConfiguration_LogDestinationConfigProperty
- type CfnLoggingConfiguration_LoggingConfigurationProperty
- type CfnRuleGroup
- type CfnRuleGroupProps
- type CfnRuleGroup_ActionDefinitionProperty
- type CfnRuleGroup_AddressProperty
- type CfnRuleGroup_CustomActionProperty
- type CfnRuleGroup_DimensionProperty
- type CfnRuleGroup_HeaderProperty
- type CfnRuleGroup_IPSetProperty
- type CfnRuleGroup_IPSetReferenceProperty
- type CfnRuleGroup_MatchAttributesProperty
- type CfnRuleGroup_PortRangeProperty
- type CfnRuleGroup_PortSetProperty
- type CfnRuleGroup_PublishMetricActionProperty
- type CfnRuleGroup_ReferenceSetsProperty
- type CfnRuleGroup_RuleDefinitionProperty
- type CfnRuleGroup_RuleGroupProperty
- type CfnRuleGroup_RuleOptionProperty
- type CfnRuleGroup_RuleVariablesProperty
- type CfnRuleGroup_RulesSourceListProperty
- type CfnRuleGroup_RulesSourceProperty
- type CfnRuleGroup_StatefulRuleOptionsProperty
- type CfnRuleGroup_StatefulRuleProperty
- type CfnRuleGroup_StatelessRuleProperty
- type CfnRuleGroup_StatelessRulesAndCustomActionsProperty
- type CfnRuleGroup_TCPFlagFieldProperty
- type CfnTLSInspectionConfiguration
- type CfnTLSInspectionConfigurationProps
- type CfnTLSInspectionConfiguration_AddressProperty
- type CfnTLSInspectionConfiguration_CheckCertificateRevocationStatusProperty
- type CfnTLSInspectionConfiguration_PortRangeProperty
- type CfnTLSInspectionConfiguration_ServerCertificateConfigurationProperty
- type CfnTLSInspectionConfiguration_ServerCertificateProperty
- type CfnTLSInspectionConfiguration_ServerCertificateScopeProperty
- type CfnTLSInspectionConfiguration_TLSInspectionConfigurationProperty
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func CfnFirewallPolicy_CFN_RESOURCE_TYPE_NAME ¶
func CfnFirewallPolicy_CFN_RESOURCE_TYPE_NAME() *string
func CfnFirewallPolicy_IsCfnElement ¶
func CfnFirewallPolicy_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFirewallPolicy_IsCfnResource ¶
func CfnFirewallPolicy_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFirewallPolicy_IsConstruct ¶
func CfnFirewallPolicy_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnFirewall_CFN_RESOURCE_TYPE_NAME ¶
func CfnFirewall_CFN_RESOURCE_TYPE_NAME() *string
func CfnFirewall_IsCfnElement ¶
func CfnFirewall_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnFirewall_IsCfnResource ¶
func CfnFirewall_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnFirewall_IsConstruct ¶
func CfnFirewall_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME ¶
func CfnLoggingConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnLoggingConfiguration_IsCfnElement ¶
func CfnLoggingConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnLoggingConfiguration_IsCfnResource ¶
func CfnLoggingConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnLoggingConfiguration_IsConstruct ¶
func CfnLoggingConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnRuleGroup_CFN_RESOURCE_TYPE_NAME ¶
func CfnRuleGroup_CFN_RESOURCE_TYPE_NAME() *string
func CfnRuleGroup_IsCfnElement ¶
func CfnRuleGroup_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnRuleGroup_IsCfnResource ¶
func CfnRuleGroup_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnRuleGroup_IsConstruct ¶
func CfnRuleGroup_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func CfnTLSInspectionConfiguration_CFN_RESOURCE_TYPE_NAME ¶ added in v2.117.0
func CfnTLSInspectionConfiguration_CFN_RESOURCE_TYPE_NAME() *string
func CfnTLSInspectionConfiguration_IsCfnElement ¶ added in v2.117.0
func CfnTLSInspectionConfiguration_IsCfnElement(x interface{}) *bool
Returns `true` if a construct is a stack element (i.e. part of the synthesized cloudformation template).
Uses duck-typing instead of `instanceof` to allow stack elements from different versions of this library to be included in the same stack.
Returns: The construct as a stack element or undefined if it is not a stack element.
func CfnTLSInspectionConfiguration_IsCfnResource ¶ added in v2.117.0
func CfnTLSInspectionConfiguration_IsCfnResource(x interface{}) *bool
Check whether the given object is a CfnResource.
func CfnTLSInspectionConfiguration_IsConstruct ¶ added in v2.117.0
func CfnTLSInspectionConfiguration_IsConstruct(x interface{}) *bool
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct` instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on disk are seen as independent, completely different libraries. As a consequence, the class `Construct` in each copy of the `constructs` library is seen as a different class, and an instance of one class will not test as `instanceof` the other class. `npm install` will not create installations like this, but users may manually symlink construct libraries together or use a monorepo tool: in those cases, multiple copies of the `constructs` library can be accidentally installed, and `instanceof` will behave unpredictably. It is safest to avoid using `instanceof`, and using this type-testing method instead.
Returns: true if `x` is an object created from a class which extends `Construct`.
func NewCfnFirewallPolicy_Override ¶
func NewCfnFirewallPolicy_Override(c CfnFirewallPolicy, scope constructs.Construct, id *string, props *CfnFirewallPolicyProps)
func NewCfnFirewall_Override ¶
func NewCfnFirewall_Override(c CfnFirewall, scope constructs.Construct, id *string, props *CfnFirewallProps)
func NewCfnLoggingConfiguration_Override ¶
func NewCfnLoggingConfiguration_Override(c CfnLoggingConfiguration, scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps)
func NewCfnRuleGroup_Override ¶
func NewCfnRuleGroup_Override(c CfnRuleGroup, scope constructs.Construct, id *string, props *CfnRuleGroupProps)
func NewCfnTLSInspectionConfiguration_Override ¶ added in v2.117.0
func NewCfnTLSInspectionConfiguration_Override(c CfnTLSInspectionConfiguration, scope constructs.Construct, id *string, props *CfnTLSInspectionConfigurationProps)
Types ¶
type CfnFirewall ¶
type CfnFirewall interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The unique IDs of the firewall endpoints for all of the subnets that you attached to the firewall. // // The subnets are not listed in any particular order. For example: `["us-west-2c:vpce-111122223333", "us-west-2a:vpce-987654321098", "us-west-2b:vpce-012345678901"]` . AttrEndpointIds() *[]*string // The Amazon Resource Name (ARN) of the `Firewall` . AttrFirewallArn() *string // The name of the `Firewall` resource. AttrFirewallId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A flag indicating whether it is possible to delete the firewall. DeleteProtection() interface{} SetDeleteProtection(val interface{}) // A description of the firewall. Description() *string SetDescription(val *string) // The descriptive name of the firewall. FirewallName() *string SetFirewallName(val *string) // The Amazon Resource Name (ARN) of the firewall policy. FirewallPolicyArn() *string SetFirewallPolicyArn(val *string) // A setting indicating whether the firewall is protected against a change to the firewall policy association. FirewallPolicyChangeProtection() interface{} SetFirewallPolicyChangeProtection(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // A setting indicating whether the firewall is protected against changes to the subnet associations. SubnetChangeProtection() interface{} SetSubnetChangeProtection(val interface{}) // The public subnets that Network Firewall is using for the firewall. SubnetMappings() interface{} SetSubnetMappings(val interface{}) // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // The unique identifier of the VPC where the firewall is in use. VpcId() *string SetVpcId(val *string) // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Use the `Firewall` to provide stateful, managed, network firewall and intrusion detection and prevention filtering for your VPCs in Amazon VPC .
The firewall defines the configuration settings for an AWS Network Firewall firewall. The settings include the firewall policy, the subnets in your VPC to use for the firewall endpoints, and any tags that are attached to the firewall AWS resource.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFirewall := awscdk.Aws_networkfirewall.NewCfnFirewall(this, jsii.String("MyCfnFirewall"), &CfnFirewallProps{ FirewallName: jsii.String("firewallName"), FirewallPolicyArn: jsii.String("firewallPolicyArn"), SubnetMappings: []interface{}{ &SubnetMappingProperty{ SubnetId: jsii.String("subnetId"), // the properties below are optional IpAddressType: jsii.String("ipAddressType"), }, }, VpcId: jsii.String("vpcId"), // the properties below are optional DeleteProtection: jsii.Boolean(false), Description: jsii.String("description"), FirewallPolicyChangeProtection: jsii.Boolean(false), SubnetChangeProtection: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnFirewall ¶
func NewCfnFirewall(scope constructs.Construct, id *string, props *CfnFirewallProps) CfnFirewall
type CfnFirewallPolicy ¶
type CfnFirewallPolicy interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the `FirewallPolicy` . AttrFirewallPolicyArn() *string // The unique ID of the `FirewallPolicy` resource. AttrFirewallPolicyId() *string // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the firewall policy. Description() *string SetDescription(val *string) // The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings. FirewallPolicy() interface{} SetFirewallPolicy(val interface{}) // The descriptive name of the firewall policy. FirewallPolicyName() *string SetFirewallPolicyName(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Use the `FirewallPolicy` to define the stateless and stateful network traffic filtering behavior for your `Firewall` .
You can use one firewall policy for multiple firewalls.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFirewallPolicy := awscdk.Aws_networkfirewall.NewCfnFirewallPolicy(this, jsii.String("MyCfnFirewallPolicy"), &CfnFirewallPolicyProps{ FirewallPolicy: &FirewallPolicyProperty{ StatelessDefaultActions: []*string{ jsii.String("statelessDefaultActions"), }, StatelessFragmentDefaultActions: []*string{ jsii.String("statelessFragmentDefaultActions"), }, // the properties below are optional PolicyVariables: &PolicyVariablesProperty{ RuleVariables: map[string]interface{}{ "ruleVariablesKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulDefaultActions: []*string{ jsii.String("statefulDefaultActions"), }, StatefulEngineOptions: &StatefulEngineOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), StreamExceptionPolicy: jsii.String("streamExceptionPolicy"), }, StatefulRuleGroupReferences: []interface{}{ &StatefulRuleGroupReferenceProperty{ ResourceArn: jsii.String("resourceArn"), // the properties below are optional Override: &StatefulRuleGroupOverrideProperty{ Action: jsii.String("action"), }, Priority: jsii.Number(123), }, }, StatelessCustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, StatelessRuleGroupReferences: []interface{}{ &StatelessRuleGroupReferenceProperty{ Priority: jsii.Number(123), ResourceArn: jsii.String("resourceArn"), }, }, TlsInspectionConfigurationArn: jsii.String("tlsInspectionConfigurationArn"), }, FirewallPolicyName: jsii.String("firewallPolicyName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnFirewallPolicy ¶
func NewCfnFirewallPolicy(scope constructs.Construct, id *string, props *CfnFirewallPolicyProps) CfnFirewallPolicy
type CfnFirewallPolicyProps ¶
type CfnFirewallPolicyProps struct { // The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy // FirewallPolicy interface{} `field:"required" json:"firewallPolicy" yaml:"firewallPolicy"` // The descriptive name of the firewall policy. // // You can't change the name of a firewall policy after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicyname // FirewallPolicyName *string `field:"required" json:"firewallPolicyName" yaml:"firewallPolicyName"` // A description of the firewall policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-description // Description *string `field:"optional" json:"description" yaml:"description"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnFirewallPolicy`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFirewallPolicyProps := &CfnFirewallPolicyProps{ FirewallPolicy: &FirewallPolicyProperty{ StatelessDefaultActions: []*string{ jsii.String("statelessDefaultActions"), }, StatelessFragmentDefaultActions: []*string{ jsii.String("statelessFragmentDefaultActions"), }, // the properties below are optional PolicyVariables: &PolicyVariablesProperty{ RuleVariables: map[string]interface{}{ "ruleVariablesKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulDefaultActions: []*string{ jsii.String("statefulDefaultActions"), }, StatefulEngineOptions: &StatefulEngineOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), StreamExceptionPolicy: jsii.String("streamExceptionPolicy"), }, StatefulRuleGroupReferences: []interface{}{ &StatefulRuleGroupReferenceProperty{ ResourceArn: jsii.String("resourceArn"), // the properties below are optional Override: &StatefulRuleGroupOverrideProperty{ Action: jsii.String("action"), }, Priority: jsii.Number(123), }, }, StatelessCustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, StatelessRuleGroupReferences: []interface{}{ &StatelessRuleGroupReferenceProperty{ Priority: jsii.Number(123), ResourceArn: jsii.String("resourceArn"), }, }, TlsInspectionConfigurationArn: jsii.String("tlsInspectionConfigurationArn"), }, FirewallPolicyName: jsii.String("firewallPolicyName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnFirewallPolicy_ActionDefinitionProperty ¶
type CfnFirewallPolicy_ActionDefinitionProperty struct { // Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. // // This setting defines a CloudWatch dimension value to be published. // // You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-actiondefinition.html#cfn-networkfirewall-firewallpolicy-actiondefinition-publishmetricaction // PublishMetricAction interface{} `field:"optional" json:"publishMetricAction" yaml:"publishMetricAction"` }
A custom action to use in stateless rule actions settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" actionDefinitionProperty := &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }
type CfnFirewallPolicy_CustomActionProperty ¶
type CfnFirewallPolicy_CustomActionProperty struct { // The custom action associated with the action name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actiondefinition // ActionDefinition interface{} `field:"required" json:"actionDefinition" yaml:"actionDefinition"` // The descriptive name of the custom action. // // You can't change the name of a custom action after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-customaction.html#cfn-networkfirewall-firewallpolicy-customaction-actionname // ActionName *string `field:"required" json:"actionName" yaml:"actionName"` }
An optional, non-standard action to use for stateless packet handling.
You can define this in addition to the standard action that you must specify.
You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
You can use custom actions in the following places:
- In an `RuleGroup.StatelessRulesAndCustomActions` . The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes. - In an `FirewallPolicy` specification, in `StatelessCustomActions` . The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customActionProperty := &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }
type CfnFirewallPolicy_DimensionProperty ¶
type CfnFirewallPolicy_DimensionProperty struct { // The value to use in the custom metric dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-dimension.html#cfn-networkfirewall-firewallpolicy-dimension-value // Value *string `field:"required" json:"value" yaml:"value"` }
The value to use in an Amazon CloudWatch custom metric dimension.
This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
AWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dimensionProperty := &DimensionProperty{ Value: jsii.String("value"), }
type CfnFirewallPolicy_FirewallPolicyProperty ¶
type CfnFirewallPolicy_FirewallPolicyProperty struct { // The actions to take on a packet if it doesn't match any of the stateless rules in the policy. // // If you want non-matching packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` . // // You must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice. // // For example, you could specify `["aws:pass"]` or you could specify `["aws:pass", “customActionName”]` . For information about compatibility, see the custom action descriptions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessdefaultactions // StatelessDefaultActions *[]*string `field:"required" json:"statelessDefaultActions" yaml:"statelessDefaultActions"` // The actions to take on a fragmented packet if it doesn't match any of the stateless rules in the policy. // // If you want non-matching fragmented packets to be forwarded for stateful inspection, specify `aws:forward_to_sfe` . // // You must specify one of the standard actions: `aws:pass` , `aws:drop` , or `aws:forward_to_sfe` . In addition, you can specify custom actions that are compatible with your standard section choice. // // For example, you could specify `["aws:pass"]` or you could specify `["aws:pass", “customActionName”]` . For information about compatibility, see the custom action descriptions. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessfragmentdefaultactions // StatelessFragmentDefaultActions *[]*string `field:"required" json:"statelessFragmentDefaultActions" yaml:"statelessFragmentDefaultActions"` // Contains variables that you can use to override default Suricata settings in your firewall policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-policyvariables // PolicyVariables interface{} `field:"optional" json:"policyVariables" yaml:"policyVariables"` // The default actions to take on a packet that doesn't match any stateful rules. // // The stateful default action is optional, and is only valid when using the strict rule order. // // Valid values of the stateful default action: // // - aws:drop_strict // - aws:drop_established // - aws:alert_strict // - aws:alert_established // // For more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html#suricata-strict-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefuldefaultactions // StatefulDefaultActions *[]*string `field:"optional" json:"statefulDefaultActions" yaml:"statefulDefaultActions"` // Additional options governing how Network Firewall handles stateful rules. // // The stateful rule groups that you use in your policy must have stateful rule options settings that are compatible with these settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulengineoptions // StatefulEngineOptions interface{} `field:"optional" json:"statefulEngineOptions" yaml:"statefulEngineOptions"` // References to the stateful rule groups that are used in the policy. // // These define the inspection criteria in stateful rules. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statefulrulegroupreferences // StatefulRuleGroupReferences interface{} `field:"optional" json:"statefulRuleGroupReferences" yaml:"statefulRuleGroupReferences"` // The custom action definitions that are available for use in the firewall policy's `StatelessDefaultActions` setting. // // You name each custom action that you define, and then you can use it by name in your default actions specifications. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelesscustomactions // StatelessCustomActions interface{} `field:"optional" json:"statelessCustomActions" yaml:"statelessCustomActions"` // References to the stateless rule groups that are used in the policy. // // These define the matching criteria in stateless rules. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-statelessrulegroupreferences // StatelessRuleGroupReferences interface{} `field:"optional" json:"statelessRuleGroupReferences" yaml:"statelessRuleGroupReferences"` // The Amazon Resource Name (ARN) of the TLS inspection configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-firewallpolicy.html#cfn-networkfirewall-firewallpolicy-firewallpolicy-tlsinspectionconfigurationarn // TlsInspectionConfigurationArn *string `field:"optional" json:"tlsInspectionConfigurationArn" yaml:"tlsInspectionConfigurationArn"` }
The traffic filtering behavior of a firewall policy, defined in a collection of stateless and stateful rule groups and other settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" firewallPolicyProperty := &FirewallPolicyProperty{ StatelessDefaultActions: []*string{ jsii.String("statelessDefaultActions"), }, StatelessFragmentDefaultActions: []*string{ jsii.String("statelessFragmentDefaultActions"), }, // the properties below are optional PolicyVariables: &PolicyVariablesProperty{ RuleVariables: map[string]interface{}{ "ruleVariablesKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulDefaultActions: []*string{ jsii.String("statefulDefaultActions"), }, StatefulEngineOptions: &StatefulEngineOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), StreamExceptionPolicy: jsii.String("streamExceptionPolicy"), }, StatefulRuleGroupReferences: []interface{}{ &StatefulRuleGroupReferenceProperty{ ResourceArn: jsii.String("resourceArn"), // the properties below are optional Override: &StatefulRuleGroupOverrideProperty{ Action: jsii.String("action"), }, Priority: jsii.Number(123), }, }, StatelessCustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, StatelessRuleGroupReferences: []interface{}{ &StatelessRuleGroupReferenceProperty{ Priority: jsii.Number(123), ResourceArn: jsii.String("resourceArn"), }, }, TlsInspectionConfigurationArn: jsii.String("tlsInspectionConfigurationArn"), }
type CfnFirewallPolicy_IPSetProperty ¶ added in v2.80.0
type CfnFirewallPolicy_IPSetProperty struct { // The list of IP addresses and address ranges, in CIDR notation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-ipset.html#cfn-networkfirewall-firewallpolicy-ipset-definition // Definition *[]*string `field:"optional" json:"definition" yaml:"definition"` }
A list of IP addresses and address ranges, in CIDR notation.
This is part of a `RuleVariables` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iPSetProperty := map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }
type CfnFirewallPolicy_PolicyVariablesProperty ¶ added in v2.80.0
type CfnFirewallPolicy_PolicyVariablesProperty struct { // The IPv4 or IPv6 addresses in CIDR notation to use for the Suricata `HOME_NET` variable. // // If your firewall uses an inspection VPC, you might want to override the `HOME_NET` variable with the CIDRs of your home networks. If you don't override `HOME_NET` with your own CIDRs, Network Firewall by default uses the CIDR of your inspection VPC. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-policyvariables.html#cfn-networkfirewall-firewallpolicy-policyvariables-rulevariables // RuleVariables interface{} `field:"optional" json:"ruleVariables" yaml:"ruleVariables"` }
Contains variables that you can use to override default Suricata settings in your firewall policy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" policyVariablesProperty := &PolicyVariablesProperty{ RuleVariables: map[string]interface{}{ "ruleVariablesKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, }
type CfnFirewallPolicy_PublishMetricActionProperty ¶
type CfnFirewallPolicy_PublishMetricActionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-publishmetricaction.html#cfn-networkfirewall-firewallpolicy-publishmetricaction-dimensions // Dimensions interface{} `field:"required" json:"dimensions" yaml:"dimensions"` }
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
This setting defines a CloudWatch dimension value to be published.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" publishMetricActionProperty := &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }
type CfnFirewallPolicy_StatefulEngineOptionsProperty ¶
type CfnFirewallPolicy_StatefulEngineOptionsProperty struct { // Indicates how to manage the order of stateful rule evaluation for the policy. // // `DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-ruleorder // RuleOrder *string `field:"optional" json:"ruleOrder" yaml:"ruleOrder"` // Configures how Network Firewall processes traffic when a network connection breaks midstream. // // Network connections can break due to disruptions in external networks or within the firewall itself. // // - `DROP` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. This is the default behavior. // - `CONTINUE` - Network Firewall continues to apply rules to the subsequent traffic without context from traffic before the break. This impacts the behavior of rules that depend on this context. For example, if you have a stateful rule to `drop http` traffic, Network Firewall won't match the traffic for this rule because the service won't have the context from session initialization defining the application layer protocol as HTTP. However, this behavior is rule dependent—a TCP-layer rule using a `flow:stateless` rule would still match, as would the `aws:drop_strict` default action. // - `REJECT` - Network Firewall fails closed and drops all subsequent traffic going to the firewall. Network Firewall also sends a TCP reject packet back to your client so that the client can immediately establish a new session. Network Firewall will have context about the new session and will apply rules to the subsequent traffic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulengineoptions.html#cfn-networkfirewall-firewallpolicy-statefulengineoptions-streamexceptionpolicy // StreamExceptionPolicy *string `field:"optional" json:"streamExceptionPolicy" yaml:"streamExceptionPolicy"` }
Configuration settings for the handling of the stateful rule groups in a firewall policy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statefulEngineOptionsProperty := &StatefulEngineOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), StreamExceptionPolicy: jsii.String("streamExceptionPolicy"), }
type CfnFirewallPolicy_StatefulRuleGroupOverrideProperty ¶ added in v2.51.0
type CfnFirewallPolicy_StatefulRuleGroupOverrideProperty struct { // The action that changes the rule group from `DROP` to `ALERT` . // // This only applies to managed rule groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupoverride.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupoverride-action // Action *string `field:"optional" json:"action" yaml:"action"` }
The setting that allows the policy owner to change the behavior of the rule group within a policy.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statefulRuleGroupOverrideProperty := &StatefulRuleGroupOverrideProperty{ Action: jsii.String("action"), }
type CfnFirewallPolicy_StatefulRuleGroupReferenceProperty ¶
type CfnFirewallPolicy_StatefulRuleGroupReferenceProperty struct { // The Amazon Resource Name (ARN) of the stateful rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-resourcearn // ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` // The action that allows the policy owner to override the behavior of the rule group within a policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-override // Override interface{} `field:"optional" json:"override" yaml:"override"` // An integer setting that indicates the order in which to run the stateful rule groups in a single `FirewallPolicy` . // // This setting only applies to firewall policies that specify the `STRICT_ORDER` rule order in the stateful engine options settings. // // Network Firewall evalutes each stateful rule group against a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. // // You can change the priority settings of your rule groups at any time. To make it easier to insert rule groups later, number them so there's a wide range in between, for example use 100, 200, and so on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statefulrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statefulrulegroupreference-priority // Priority *float64 `field:"optional" json:"priority" yaml:"priority"` }
Identifier for a single stateful rule group, used in a firewall policy to refer to a rule group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statefulRuleGroupReferenceProperty := &StatefulRuleGroupReferenceProperty{ ResourceArn: jsii.String("resourceArn"), // the properties below are optional Override: &StatefulRuleGroupOverrideProperty{ Action: jsii.String("action"), }, Priority: jsii.Number(123), }
type CfnFirewallPolicy_StatelessRuleGroupReferenceProperty ¶
type CfnFirewallPolicy_StatelessRuleGroupReferenceProperty struct { // An integer setting that indicates the order in which to run the stateless rule groups in a single `FirewallPolicy` . // // Network Firewall applies each stateless rule group to a packet starting with the group that has the lowest priority setting. You must ensure that the priority settings are unique within each policy. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-priority // Priority *float64 `field:"required" json:"priority" yaml:"priority"` // The Amazon Resource Name (ARN) of the stateless rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewallpolicy-statelessrulegroupreference.html#cfn-networkfirewall-firewallpolicy-statelessrulegroupreference-resourcearn // ResourceArn *string `field:"required" json:"resourceArn" yaml:"resourceArn"` }
Identifier for a single stateless rule group, used in a firewall policy to refer to the rule group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statelessRuleGroupReferenceProperty := &StatelessRuleGroupReferenceProperty{ Priority: jsii.Number(123), ResourceArn: jsii.String("resourceArn"), }
type CfnFirewallProps ¶
type CfnFirewallProps struct { // The descriptive name of the firewall. // // You can't change the name of a firewall after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallname // FirewallName *string `field:"required" json:"firewallName" yaml:"firewallName"` // The Amazon Resource Name (ARN) of the firewall policy. // // The relationship of firewall to firewall policy is many to one. Each firewall requires one firewall policy association, and you can use the same firewall policy for multiple firewalls. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicyarn // FirewallPolicyArn *string `field:"required" json:"firewallPolicyArn" yaml:"firewallPolicyArn"` // The public subnets that Network Firewall is using for the firewall. // // Each subnet must belong to a different Availability Zone. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetmappings // SubnetMappings interface{} `field:"required" json:"subnetMappings" yaml:"subnetMappings"` // The unique identifier of the VPC where the firewall is in use. // // You can't change the VPC of a firewall after you create the firewall. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-vpcid // VpcId *string `field:"required" json:"vpcId" yaml:"vpcId"` // A flag indicating whether it is possible to delete the firewall. // // A setting of `TRUE` indicates that the firewall is protected against deletion. Use this setting to protect against accidentally deleting a firewall that is in use. When you create a firewall, the operation initializes this flag to `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-deleteprotection // DeleteProtection interface{} `field:"optional" json:"deleteProtection" yaml:"deleteProtection"` // A description of the firewall. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-description // Description *string `field:"optional" json:"description" yaml:"description"` // A setting indicating whether the firewall is protected against a change to the firewall policy association. // // Use this setting to protect against accidentally modifying the firewall policy for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-firewallpolicychangeprotection // FirewallPolicyChangeProtection interface{} `field:"optional" json:"firewallPolicyChangeProtection" yaml:"firewallPolicyChangeProtection"` // A setting indicating whether the firewall is protected against changes to the subnet associations. // // Use this setting to protect against accidentally modifying the subnet associations for a firewall that is in use. When you create a firewall, the operation initializes this setting to `TRUE` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-subnetchangeprotection // SubnetChangeProtection interface{} `field:"optional" json:"subnetChangeProtection" yaml:"subnetChangeProtection"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-firewall.html#cfn-networkfirewall-firewall-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnFirewall`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnFirewallProps := &CfnFirewallProps{ FirewallName: jsii.String("firewallName"), FirewallPolicyArn: jsii.String("firewallPolicyArn"), SubnetMappings: []interface{}{ &SubnetMappingProperty{ SubnetId: jsii.String("subnetId"), // the properties below are optional IpAddressType: jsii.String("ipAddressType"), }, }, VpcId: jsii.String("vpcId"), // the properties below are optional DeleteProtection: jsii.Boolean(false), Description: jsii.String("description"), FirewallPolicyChangeProtection: jsii.Boolean(false), SubnetChangeProtection: jsii.Boolean(false), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnFirewall_SubnetMappingProperty ¶
type CfnFirewall_SubnetMappingProperty struct { // The unique identifier for the subnet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-subnetid // SubnetId *string `field:"required" json:"subnetId" yaml:"subnetId"` // The subnet's IP address type. // // You can't change the IP address type after you create the subnet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-firewall-subnetmapping.html#cfn-networkfirewall-firewall-subnetmapping-ipaddresstype // IpAddressType *string `field:"optional" json:"ipAddressType" yaml:"ipAddressType"` }
The ID for a subnet that you want to associate with the firewall.
AWS Network Firewall creates an instance of the associated firewall in each subnet that you specify, to filter traffic in the subnet's Availability Zone.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" subnetMappingProperty := &SubnetMappingProperty{ SubnetId: jsii.String("subnetId"), // the properties below are optional IpAddressType: jsii.String("ipAddressType"), }
type CfnLoggingConfiguration ¶
type CfnLoggingConfiguration interface { awscdk.CfnResource awscdk.IInspectable // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // The Amazon Resource Name (ARN) of the `Firewall` that the logging configuration is associated with. FirewallArn() *string SetFirewallArn(val *string) // The name of the firewall that the logging configuration is associated with. FirewallName() *string SetFirewallName(val *string) // Defines how AWS Network Firewall performs logging for a `Firewall` . LoggingConfiguration() interface{} SetLoggingConfiguration(val interface{}) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
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 "github.com/aws/aws-cdk-go/awscdk" cfnLoggingConfiguration := awscdk.Aws_networkfirewall.NewCfnLoggingConfiguration(this, jsii.String("MyCfnLoggingConfiguration"), &CfnLoggingConfigurationProps{ FirewallArn: jsii.String("firewallArn"), LoggingConfiguration: &LoggingConfigurationProperty{ LogDestinationConfigs: []interface{}{ &LogDestinationConfigProperty{ LogDestination: map[string]*string{ "logDestinationKey": jsii.String("logDestination"), }, LogDestinationType: jsii.String("logDestinationType"), LogType: jsii.String("logType"), }, }, }, // the properties below are optional FirewallName: jsii.String("firewallName"), })
func NewCfnLoggingConfiguration ¶
func NewCfnLoggingConfiguration(scope constructs.Construct, id *string, props *CfnLoggingConfigurationProps) CfnLoggingConfiguration
type CfnLoggingConfigurationProps ¶
type CfnLoggingConfigurationProps struct { // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallarn // FirewallArn *string `field:"required" json:"firewallArn" yaml:"firewallArn"` // Defines how AWS Network Firewall performs logging for a `Firewall` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration // LoggingConfiguration interface{} `field:"required" json:"loggingConfiguration" yaml:"loggingConfiguration"` // 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. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-firewallname // FirewallName *string `field:"optional" json:"firewallName" yaml:"firewallName"` }
Properties for defining a `CfnLoggingConfiguration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnLoggingConfigurationProps := &CfnLoggingConfigurationProps{ FirewallArn: jsii.String("firewallArn"), LoggingConfiguration: &LoggingConfigurationProperty{ LogDestinationConfigs: []interface{}{ &LogDestinationConfigProperty{ LogDestination: map[string]*string{ "logDestinationKey": jsii.String("logDestination"), }, LogDestinationType: jsii.String("logDestinationType"), LogType: jsii.String("logType"), }, }, }, // the properties below are optional FirewallName: jsii.String("firewallName"), }
type CfnLoggingConfiguration_LogDestinationConfigProperty ¶
type CfnLoggingConfiguration_LogDestinationConfigProperty struct { // The named location for the logs, provided in a key:value mapping that is specific to the chosen destination type. // // - For an Amazon S3 bucket, provide the name of the bucket, with key `bucketName` , and optionally provide a prefix, with key `prefix` . The following example specifies an Amazon S3 bucket named `DOC-EXAMPLE-BUCKET` and the prefix `alerts` : // // `"LogDestination": { "bucketName": "DOC-EXAMPLE-BUCKET", "prefix": "alerts" }` // - For a CloudWatch log group, provide the name of the CloudWatch log group, with key `logGroup` . The following example specifies a log group named `alert-log-group` : // // `"LogDestination": { "logGroup": "alert-log-group" }` // - For a Firehose delivery stream, provide the name of the delivery stream, with key `deliveryStream` . The following example specifies a delivery stream named `alert-delivery-stream` : // // `"LogDestination": { "deliveryStream": "alert-delivery-stream" }`. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestination // LogDestination interface{} `field:"required" json:"logDestination" yaml:"logDestination"` // The type of storage destination to send these logs to. // // You can send logs to an Amazon S3 bucket, a CloudWatch log group, or a Firehose delivery stream. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logdestinationtype // LogDestinationType *string `field:"required" json:"logDestinationType" yaml:"logDestinationType"` // The type of log to send. // // Alert logs report traffic that matches a stateful rule with an action setting that sends an alert log message. Flow logs are standard network traffic flow logs. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-logdestinationconfig.html#cfn-networkfirewall-loggingconfiguration-logdestinationconfig-logtype // LogType *string `field:"required" json:"logType" yaml:"logType"` }
Defines where AWS Network Firewall sends logs for the firewall for one log type.
This is used in `LoggingConfiguration` . You can send each type of log to an Amazon S3 bucket, a CloudWatch log group, or a Kinesis Data Firehose delivery stream.
Network Firewall generates logs for stateful rule groups. You can save alert and flow log types. The stateful rules engine records flow logs for all network traffic that it receives. It records alert logs for traffic that matches stateful rules that have the rule action set to `DROP` or `ALERT` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" logDestinationConfigProperty := &LogDestinationConfigProperty{ LogDestination: map[string]*string{ "logDestinationKey": jsii.String("logDestination"), }, LogDestinationType: jsii.String("logDestinationType"), LogType: jsii.String("logType"), }
type CfnLoggingConfiguration_LoggingConfigurationProperty ¶
type CfnLoggingConfiguration_LoggingConfigurationProperty struct { // Defines the logging destinations for the logs for a firewall. // // Network Firewall generates logs for stateful rule groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-loggingconfiguration-loggingconfiguration.html#cfn-networkfirewall-loggingconfiguration-loggingconfiguration-logdestinationconfigs // LogDestinationConfigs interface{} `field:"required" json:"logDestinationConfigs" yaml:"logDestinationConfigs"` }
Defines how AWS Network Firewall performs logging for a `Firewall` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" loggingConfigurationProperty := &LoggingConfigurationProperty{ LogDestinationConfigs: []interface{}{ &LogDestinationConfigProperty{ LogDestination: map[string]*string{ "logDestinationKey": jsii.String("logDestination"), }, LogDestinationType: jsii.String("logDestinationType"), LogType: jsii.String("logType"), }, }, }
type CfnRuleGroup ¶
type CfnRuleGroup interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggable // The Amazon Resource Name (ARN) of the `RuleGroup` . AttrRuleGroupArn() *string // The unique ID of the `RuleGroup` resource. AttrRuleGroupId() *string // The maximum operating resources that this rule group can use. Capacity() *float64 SetCapacity(val *float64) // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the rule group. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // An object that defines the rule group rules. RuleGroup() interface{} SetRuleGroup(val interface{}) // The descriptive name of the rule group. RuleGroupName() *string SetRuleGroupName(val *string) // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // Tag Manager which manages the tags for this resource. Tags() awscdk.TagManager // An array of key-value pairs to apply to this resource. TagsRaw() *[]*awscdk.CfnTag SetTagsRaw(val *[]*awscdk.CfnTag) // Indicates whether the rule group is stateless or stateful. Type() *string SetType(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
Use the `RuleGroup` to define a reusable collection of stateless or stateful network traffic filtering rules.
You use rule groups in an `FirewallPolicy` to specify the filtering behavior of an `Firewall` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRuleGroup := awscdk.Aws_networkfirewall.NewCfnRuleGroup(this, jsii.String("MyCfnRuleGroup"), &CfnRuleGroupProps{ Capacity: jsii.Number(123), RuleGroupName: jsii.String("ruleGroupName"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), RuleGroup: &RuleGroupProperty{ RulesSource: &RulesSourceProperty{ RulesSourceList: &RulesSourceListProperty{ GeneratedRulesType: jsii.String("generatedRulesType"), Targets: []*string{ jsii.String("targets"), }, TargetTypes: []*string{ jsii.String("targetTypes"), }, }, RulesString: jsii.String("rulesString"), StatefulRules: []interface{}{ &StatefulRuleProperty{ Action: jsii.String("action"), Header: &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }, RuleOptions: []interface{}{ &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }, }, }, }, StatelessRulesAndCustomActions: &StatelessRulesAndCustomActionsProperty{ StatelessRules: []interface{}{ &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }, }, // the properties below are optional CustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, }, }, // the properties below are optional ReferenceSets: &ReferenceSetsProperty{ IpSetReferences: map[string]interface{}{ "ipSetReferencesKey": map[string]*string{ "referenceArn": jsii.String("referenceArn"), }, }, }, RuleVariables: &RuleVariablesProperty{ IpSets: map[string]interface{}{ "ipSetsKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, PortSets: map[string]interface{}{ "portSetsKey": &PortSetProperty{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulRuleOptions: &StatefulRuleOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnRuleGroup ¶
func NewCfnRuleGroup(scope constructs.Construct, id *string, props *CfnRuleGroupProps) CfnRuleGroup
type CfnRuleGroupProps ¶
type CfnRuleGroupProps struct { // The maximum operating resources that this rule group can use. // // You can't change a rule group's capacity setting after you create the rule group. When you update a rule group, you are limited to this capacity. When you reference a rule group from a firewall policy, Network Firewall reserves this capacity for the rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-capacity // Capacity *float64 `field:"required" json:"capacity" yaml:"capacity"` // The descriptive name of the rule group. // // You can't change the name of a rule group after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroupname // RuleGroupName *string `field:"required" json:"ruleGroupName" yaml:"ruleGroupName"` // Indicates whether the rule group is stateless or stateful. // // If the rule group is stateless, it contains // stateless rules. If it is stateful, it contains stateful rules. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-type // Type *string `field:"required" json:"type" yaml:"type"` // A description of the rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-description // Description *string `field:"optional" json:"description" yaml:"description"` // An object that defines the rule group rules. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup // RuleGroup interface{} `field:"optional" json:"ruleGroup" yaml:"ruleGroup"` // An array of key-value pairs to apply to this resource. // // For more information, see [Tag](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-resource-tags.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-rulegroup.html#cfn-networkfirewall-rulegroup-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnRuleGroup`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnRuleGroupProps := &CfnRuleGroupProps{ Capacity: jsii.Number(123), RuleGroupName: jsii.String("ruleGroupName"), Type: jsii.String("type"), // the properties below are optional Description: jsii.String("description"), RuleGroup: &RuleGroupProperty{ RulesSource: &RulesSourceProperty{ RulesSourceList: &RulesSourceListProperty{ GeneratedRulesType: jsii.String("generatedRulesType"), Targets: []*string{ jsii.String("targets"), }, TargetTypes: []*string{ jsii.String("targetTypes"), }, }, RulesString: jsii.String("rulesString"), StatefulRules: []interface{}{ &StatefulRuleProperty{ Action: jsii.String("action"), Header: &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }, RuleOptions: []interface{}{ &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }, }, }, }, StatelessRulesAndCustomActions: &StatelessRulesAndCustomActionsProperty{ StatelessRules: []interface{}{ &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }, }, // the properties below are optional CustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, }, }, // the properties below are optional ReferenceSets: &ReferenceSetsProperty{ IpSetReferences: map[string]interface{}{ "ipSetReferencesKey": map[string]*string{ "referenceArn": jsii.String("referenceArn"), }, }, }, RuleVariables: &RuleVariablesProperty{ IpSets: map[string]interface{}{ "ipSetsKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, PortSets: map[string]interface{}{ "portSetsKey": &PortSetProperty{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulRuleOptions: &StatefulRuleOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), }, }, Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnRuleGroup_ActionDefinitionProperty ¶
type CfnRuleGroup_ActionDefinitionProperty struct { // Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet. // // This setting defines a CloudWatch dimension value to be published. // // You can pair this custom action with any of the standard stateless rule actions. For example, you could pair this in a rule action with the standard action that forwards the packet for stateful inspection. Then, when a packet matches the rule, Network Firewall publishes metrics for the packet and forwards it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-actiondefinition.html#cfn-networkfirewall-rulegroup-actiondefinition-publishmetricaction // PublishMetricAction interface{} `field:"optional" json:"publishMetricAction" yaml:"publishMetricAction"` }
A custom action to use in stateless rule actions settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" actionDefinitionProperty := &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }
type CfnRuleGroup_AddressProperty ¶
type CfnRuleGroup_AddressProperty struct { // Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. // // Network Firewall supports all address ranges for IPv4 and IPv6. // // Examples: // // - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` . // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` . // - To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` . // - To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` . // // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-address.html#cfn-networkfirewall-rulegroup-address-addressdefinition // AddressDefinition *string `field:"required" json:"addressDefinition" yaml:"addressDefinition"` }
A single IP address specification.
This is used in the `RuleGroup.MatchAttributes` source and destination specifications.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" addressProperty := &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }
type CfnRuleGroup_CustomActionProperty ¶
type CfnRuleGroup_CustomActionProperty struct { // The custom action associated with the action name. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actiondefinition // ActionDefinition interface{} `field:"required" json:"actionDefinition" yaml:"actionDefinition"` // The descriptive name of the custom action. // // You can't change the name of a custom action after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-customaction.html#cfn-networkfirewall-rulegroup-customaction-actionname // ActionName *string `field:"required" json:"actionName" yaml:"actionName"` }
An optional, non-standard action to use for stateless packet handling.
You can define this in addition to the standard action that you must specify.
You define and name the custom actions that you want to be able to use, and then you reference them by name in your actions settings.
You can use custom actions in the following places:
- In an `RuleGroup.StatelessRulesAndCustomActions` . The custom actions are available for use by name inside the `StatelessRulesAndCustomActions` where you define them. You can use them for your stateless rule actions to specify what to do with a packet that matches the rule's match attributes. - In an `FirewallPolicy` specification, in `StatelessCustomActions` . The custom actions are available for use inside the policy where you define them. You can use them for the policy's default stateless actions settings to specify what to do with packets that don't match any of the policy's stateless rules.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" customActionProperty := &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }
type CfnRuleGroup_DimensionProperty ¶
type CfnRuleGroup_DimensionProperty struct { // The value to use in the custom metric dimension. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-dimension.html#cfn-networkfirewall-rulegroup-dimension-value // Value *string `field:"required" json:"value" yaml:"value"` }
The value to use in an Amazon CloudWatch custom metric dimension.
This is used in the `PublishMetrics` custom action. A CloudWatch custom metric dimension is a name/value pair that's part of the identity of a metric.
AWS Network Firewall sets the dimension name to `CustomAction` and you provide the dimension value.
For more information about CloudWatch custom metric dimensions, see [Publishing Custom Metrics](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/publishingMetrics.html#usingDimensions) in the [Amazon CloudWatch User Guide](https://docs.aws.amazon.com/AmazonCloudWatch/latest/monitoring/WhatIsCloudWatch.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" dimensionProperty := &DimensionProperty{ Value: jsii.String("value"), }
type CfnRuleGroup_HeaderProperty ¶
type CfnRuleGroup_HeaderProperty struct { // The destination IP address or address range to inspect for, in CIDR notation. // // To match with any address, specify `ANY` . // // Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6. // // Examples: // // - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` . // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` . // - To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` . // - To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` . // // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destination // Destination *string `field:"required" json:"destination" yaml:"destination"` // The destination port to inspect for. // // You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-destinationport // DestinationPort *string `field:"required" json:"destinationPort" yaml:"destinationPort"` // The direction of traffic flow to inspect. // // If set to `ANY` , the inspection matches bidirectional traffic, both from the source to the destination and from the destination to the source. If set to `FORWARD` , the inspection only matches traffic going from the source to the destination. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-direction // Direction *string `field:"required" json:"direction" yaml:"direction"` // The protocol to inspect for. // // To specify all, you can use `IP` , because all traffic on AWS and on the internet is IP. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-protocol // Protocol *string `field:"required" json:"protocol" yaml:"protocol"` // The source IP address or address range to inspect for, in CIDR notation. // // To match with any address, specify `ANY` . // // Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. Network Firewall supports all address ranges for IPv4 and IPv6. // // Examples: // // - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` . // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` . // - To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` . // - To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` . // // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-source // Source *string `field:"required" json:"source" yaml:"source"` // The source port to inspect for. // // You can specify an individual port, for example `1994` and you can specify a port range, for example `1990:1994` . To match with any port, specify `ANY` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-header.html#cfn-networkfirewall-rulegroup-header-sourceport // SourcePort *string `field:"required" json:"sourcePort" yaml:"sourcePort"` }
The 5-tuple criteria for AWS Network Firewall to use to inspect packet headers in stateful traffic flow inspection.
Traffic flows that match the criteria are a match for the corresponding stateful rule.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" headerProperty := &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }
type CfnRuleGroup_IPSetProperty ¶
type CfnRuleGroup_IPSetProperty struct { // The list of IP addresses and address ranges, in CIDR notation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipset.html#cfn-networkfirewall-rulegroup-ipset-definition // Definition *[]*string `field:"optional" json:"definition" yaml:"definition"` }
A list of IP addresses and address ranges, in CIDR notation.
This is part of a `RuleGroup.RuleVariables` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iPSetProperty := map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }
type CfnRuleGroup_IPSetReferenceProperty ¶ added in v2.57.0
type CfnRuleGroup_IPSetReferenceProperty struct { // The Amazon Resource Name (ARN) of the resource to include in the `RuleGroup.IPSetReference` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ipsetreference.html#cfn-networkfirewall-rulegroup-ipsetreference-referencearn // ReferenceArn *string `field:"optional" json:"referenceArn" yaml:"referenceArn"` }
Configures one or more `IPSetReferences` for a Suricata-compatible rule group.
An IP set reference is a rule variable that references a resource that you create and manage in another AWS service, such as an Amazon VPC prefix list. Network Firewall IP set references enable you to dynamically update the contents of your rules. When you create, update, or delete the IP set you are referencing in your rule, Network Firewall automatically updates the rule's content with the changes. For more information about IP set references in Network Firewall , see [Using IP set references](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" iPSetReferenceProperty := map[string]*string{ "referenceArn": jsii.String("referenceArn"), }
type CfnRuleGroup_MatchAttributesProperty ¶
type CfnRuleGroup_MatchAttributesProperty struct { // The destination ports to inspect for. // // If not specified, this matches with any destination port. This setting is only used for protocols 6 (TCP) and 17 (UDP). // // You can specify individual ports, for example `1994` and you can specify port ranges, for example `1990:1994` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinationports // DestinationPorts interface{} `field:"optional" json:"destinationPorts" yaml:"destinationPorts"` // The destination IP addresses and address ranges to inspect for, in CIDR notation. // // If not specified, this matches with any destination address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-destinations // Destinations interface{} `field:"optional" json:"destinations" yaml:"destinations"` // The protocols to inspect for, specified using each protocol's assigned internet protocol number (IANA). // // If not specified, this matches with any protocol. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-protocols // Protocols interface{} `field:"optional" json:"protocols" yaml:"protocols"` // The source ports to inspect for. // // If not specified, this matches with any source port. This setting is only used for protocols 6 (TCP) and 17 (UDP). // // You can specify individual ports, for example `1994` and you can specify port ranges, for example `1990:1994` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sourceports // SourcePorts interface{} `field:"optional" json:"sourcePorts" yaml:"sourcePorts"` // The source IP addresses and address ranges to inspect for, in CIDR notation. // // If not specified, this matches with any source address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-sources // Sources interface{} `field:"optional" json:"sources" yaml:"sources"` // The TCP flags and masks to inspect for. // // If not specified, this matches with any settings. This setting is only used for protocol 6 (TCP). // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html#cfn-networkfirewall-rulegroup-matchattributes-tcpflags // TcpFlags interface{} `field:"optional" json:"tcpFlags" yaml:"tcpFlags"` }
Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection.
Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" matchAttributesProperty := &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }
type CfnRuleGroup_PortRangeProperty ¶
type CfnRuleGroup_PortRangeProperty struct { // The lower limit of the port range. // // This must be less than or equal to the `ToPort` specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-fromport // FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"` // The upper limit of the port range. // // This must be greater than or equal to the `FromPort` specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portrange.html#cfn-networkfirewall-rulegroup-portrange-toport // ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"` }
A single port range specification.
This is used for source and destination port ranges in the stateless `RuleGroup.MatchAttributes` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" portRangeProperty := &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }
type CfnRuleGroup_PortSetProperty ¶
type CfnRuleGroup_PortSetProperty struct { // The set of port ranges. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-portset.html#cfn-networkfirewall-rulegroup-portset-definition // Definition *[]*string `field:"optional" json:"definition" yaml:"definition"` }
A set of port ranges for use in the rules in a rule group.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" portSetProperty := &PortSetProperty{ Definition: []*string{ jsii.String("definition"), }, }
type CfnRuleGroup_PublishMetricActionProperty ¶
type CfnRuleGroup_PublishMetricActionProperty struct { // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-publishmetricaction.html#cfn-networkfirewall-rulegroup-publishmetricaction-dimensions // Dimensions interface{} `field:"required" json:"dimensions" yaml:"dimensions"` }
Stateless inspection criteria that publishes the specified metrics to Amazon CloudWatch for the matching packet.
This setting defines a CloudWatch dimension value to be published.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" publishMetricActionProperty := &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }
type CfnRuleGroup_ReferenceSetsProperty ¶ added in v2.57.0
type CfnRuleGroup_ReferenceSetsProperty struct { // The IP set references to use in the stateful rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-referencesets.html#cfn-networkfirewall-rulegroup-referencesets-ipsetreferences // IpSetReferences interface{} `field:"optional" json:"ipSetReferences" yaml:"ipSetReferences"` }
Configures the `ReferenceSets` for a stateful rule group.
For more information, see the [Using IP set references in Suricata compatible rule groups](https://docs.aws.amazon.com/network-firewall/latest/developerguide/rule-groups-ip-set-references.html) in the *Network Firewall User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" referenceSetsProperty := &ReferenceSetsProperty{ IpSetReferences: map[string]interface{}{ "ipSetReferencesKey": map[string]*string{ "referenceArn": jsii.String("referenceArn"), }, }, }
type CfnRuleGroup_RuleDefinitionProperty ¶
type CfnRuleGroup_RuleDefinitionProperty struct { // The actions to take on a packet that matches one of the stateless rule definition's match attributes. // // You must specify a standard action and you can add custom actions. // // > Network Firewall only forwards a packet for stateful rule inspection if you specify `aws:forward_to_sfe` for a rule that the packet matches, or if the packet doesn't match any stateless rule and you specify `aws:forward_to_sfe` for the `StatelessDefaultActions` setting for the `FirewallPolicy` . // // For every rule, you must specify exactly one of the following standard actions. // // - *aws:pass* - Discontinues all inspection of the packet and permits it to go to its intended destination. // - *aws:drop* - Discontinues all inspection of the packet and blocks it from going to its intended destination. // - *aws:forward_to_sfe* - Discontinues stateless inspection of the packet and forwards it to the stateful rule engine for inspection. // // Additionally, you can specify a custom action. To do this, you define a custom action by name and type, then provide the name you've assigned to the action in this `Actions` setting. // // To provide more than one action in this setting, separate the settings with a comma. For example, if you have a publish metrics custom action that you've named `MyMetricsAction` , then you could specify the standard action `aws:pass` combined with the custom action using `[“aws:pass”, “MyMetricsAction”]` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-actions // Actions *[]*string `field:"required" json:"actions" yaml:"actions"` // Criteria for Network Firewall to use to inspect an individual packet in stateless rule inspection. // // Each match attributes set can include one or more items such as IP address, CIDR range, port number, protocol, and TCP flags. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruledefinition.html#cfn-networkfirewall-rulegroup-ruledefinition-matchattributes // MatchAttributes interface{} `field:"required" json:"matchAttributes" yaml:"matchAttributes"` }
The inspection criteria and action for a single stateless rule.
AWS Network Firewall inspects each packet for the specified matching criteria. When a packet matches the criteria, Network Firewall performs the rule's actions on the packet.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ruleDefinitionProperty := &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }
type CfnRuleGroup_RuleGroupProperty ¶
type CfnRuleGroup_RuleGroupProperty struct { // The stateful rules or stateless rules for the rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulessource // RulesSource interface{} `field:"required" json:"rulesSource" yaml:"rulesSource"` // The reference sets for the stateful rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-referencesets // ReferenceSets interface{} `field:"optional" json:"referenceSets" yaml:"referenceSets"` // Settings that are available for use in the rules in the rule group. // // You can only use these for stateful rule groups. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-rulevariables // RuleVariables interface{} `field:"optional" json:"ruleVariables" yaml:"ruleVariables"` // Additional options governing how Network Firewall handles stateful rules. // // The policies where you use your stateful rule group must have stateful rule options settings that are compatible with these settings. Some limitations apply; for more information, see [Strict evaluation order](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-limitations-caveats.html) in the *AWS Network Firewall Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulegroup.html#cfn-networkfirewall-rulegroup-rulegroup-statefulruleoptions // StatefulRuleOptions interface{} `field:"optional" json:"statefulRuleOptions" yaml:"statefulRuleOptions"` }
The object that defines the rules in a rule group.
AWS Network Firewall uses a rule group to inspect and control network traffic. You define stateless rule groups to inspect individual packets and you define stateful rule groups to inspect packets in the context of their traffic flow.
To use a rule group, you include it by reference in an Network Firewall firewall policy, then you use the policy in a firewall. You can reference a rule group from more than one firewall policy, and you can use a firewall policy in more than one firewall.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ruleGroupProperty := &RuleGroupProperty{ RulesSource: &RulesSourceProperty{ RulesSourceList: &RulesSourceListProperty{ GeneratedRulesType: jsii.String("generatedRulesType"), Targets: []*string{ jsii.String("targets"), }, TargetTypes: []*string{ jsii.String("targetTypes"), }, }, RulesString: jsii.String("rulesString"), StatefulRules: []interface{}{ &StatefulRuleProperty{ Action: jsii.String("action"), Header: &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }, RuleOptions: []interface{}{ &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }, }, }, }, StatelessRulesAndCustomActions: &StatelessRulesAndCustomActionsProperty{ StatelessRules: []interface{}{ &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }, }, // the properties below are optional CustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, }, }, // the properties below are optional ReferenceSets: &ReferenceSetsProperty{ IpSetReferences: map[string]interface{}{ "ipSetReferencesKey": map[string]*string{ "referenceArn": jsii.String("referenceArn"), }, }, }, RuleVariables: &RuleVariablesProperty{ IpSets: map[string]interface{}{ "ipSetsKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, PortSets: map[string]interface{}{ "portSetsKey": &PortSetProperty{ "definition": []*string{ jsii.String("definition"), }, }, }, }, StatefulRuleOptions: &StatefulRuleOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), }, }
type CfnRuleGroup_RuleOptionProperty ¶
type CfnRuleGroup_RuleOptionProperty struct { // The Suricata rule option keywords. // // For Network Firewall , the keyword signature ID (sid) is required in the format `sid:112233` . The sid must be unique within the rule group. For information about Suricata rule option keywords, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-keyword // Keyword *string `field:"required" json:"keyword" yaml:"keyword"` // The Suricata rule option settings. // // Settings have zero or more values, and the number of possible settings and required settings depends on the keyword. The format for Settings is `number` . For information about Suricata rule option settings, see [Rule options](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html#rule-options) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-ruleoption.html#cfn-networkfirewall-rulegroup-ruleoption-settings // Settings *[]*string `field:"optional" json:"settings" yaml:"settings"` }
Additional settings for a stateful rule.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ruleOptionProperty := &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }
type CfnRuleGroup_RuleVariablesProperty ¶
type CfnRuleGroup_RuleVariablesProperty struct { // A list of IP addresses and address ranges, in CIDR notation. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-ipsets // IpSets interface{} `field:"optional" json:"ipSets" yaml:"ipSets"` // A list of port ranges. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulevariables.html#cfn-networkfirewall-rulegroup-rulevariables-portsets // PortSets interface{} `field:"optional" json:"portSets" yaml:"portSets"` }
Settings that are available for use in the rules in the `RuleGroup` where this is defined.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" ruleVariablesProperty := &RuleVariablesProperty{ IpSets: map[string]interface{}{ "ipSetsKey": map[string][]*string{ "definition": []*string{ jsii.String("definition"), }, }, }, PortSets: map[string]interface{}{ "portSetsKey": &PortSetProperty{ "definition": []*string{ jsii.String("definition"), }, }, }, }
type CfnRuleGroup_RulesSourceListProperty ¶
type CfnRuleGroup_RulesSourceListProperty struct { // Whether you want to allow or deny access to the domains in your target list. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-generatedrulestype // GeneratedRulesType *string `field:"required" json:"generatedRulesType" yaml:"generatedRulesType"` // The domains that you want to inspect for in your traffic flows. Valid domain specifications are the following:. // // - Explicit names. For example, `abc.example.com` matches only the domain `abc.example.com` . // - Names that use a domain wildcard, which you indicate with an initial ' `.` '. For example, `.example.com` matches `example.com` and matches all subdomains of `example.com` , such as `abc.example.com` and `www.example.com` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targets // Targets *[]*string `field:"required" json:"targets" yaml:"targets"` // The types of targets to inspect for. // // Valid values are `TLS_SNI` and `HTTP_HOST` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessourcelist.html#cfn-networkfirewall-rulegroup-rulessourcelist-targettypes // TargetTypes *[]*string `field:"required" json:"targetTypes" yaml:"targetTypes"` }
Stateful inspection criteria for a domain list rule group.
For HTTPS traffic, domain filtering is SNI-based. It uses the server name indicator extension of the TLS handshake.
By default, Network Firewall domain list inspection only includes traffic coming from the VPC where you deploy the firewall. To inspect traffic from IP addresses outside of the deployment VPC, you set the `HOME_NET` rule variable to include the CIDR range of the deployment VPC plus the other CIDR ranges. For more information, see `RuleGroup.RuleVariables` in this guide and [Stateful domain list rule groups in AWS Network Firewall](https://docs.aws.amazon.com/network-firewall/latest/developerguide/stateful-rule-groups-domain-names.html) in the *Network Firewall Developer Guide*
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rulesSourceListProperty := &RulesSourceListProperty{ GeneratedRulesType: jsii.String("generatedRulesType"), Targets: []*string{ jsii.String("targets"), }, TargetTypes: []*string{ jsii.String("targetTypes"), }, }
type CfnRuleGroup_RulesSourceProperty ¶
type CfnRuleGroup_RulesSourceProperty struct { // Stateful inspection criteria for a domain list rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulessourcelist // RulesSourceList interface{} `field:"optional" json:"rulesSourceList" yaml:"rulesSourceList"` // Stateful inspection criteria, provided in Suricata compatible rules. // // Suricata is an open-source threat detection framework that includes a standard rule-based language for network traffic inspection. // // These rules contain the inspection criteria and the action to take for traffic that matches the criteria, so this type of rule group doesn't have a separate action setting. // // > You can't use the `priority` keyword if the `RuleOrder` option in `StatefulRuleOptions` is set to `STRICT_ORDER` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-rulesstring // RulesString *string `field:"optional" json:"rulesString" yaml:"rulesString"` // An array of individual stateful rules inspection criteria to be used together in a stateful rule group. // // Use this option to specify simple Suricata rules with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statefulrules // StatefulRules interface{} `field:"optional" json:"statefulRules" yaml:"statefulRules"` // Stateless inspection criteria to be used in a stateless rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-rulessource.html#cfn-networkfirewall-rulegroup-rulessource-statelessrulesandcustomactions // StatelessRulesAndCustomActions interface{} `field:"optional" json:"statelessRulesAndCustomActions" yaml:"statelessRulesAndCustomActions"` }
The stateless or stateful rules definitions for use in a single rule group.
Each rule group requires a single `RulesSource` . You can use an instance of this for either stateless rules or stateful rules.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" rulesSourceProperty := &RulesSourceProperty{ RulesSourceList: &RulesSourceListProperty{ GeneratedRulesType: jsii.String("generatedRulesType"), Targets: []*string{ jsii.String("targets"), }, TargetTypes: []*string{ jsii.String("targetTypes"), }, }, RulesString: jsii.String("rulesString"), StatefulRules: []interface{}{ &StatefulRuleProperty{ Action: jsii.String("action"), Header: &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }, RuleOptions: []interface{}{ &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }, }, }, }, StatelessRulesAndCustomActions: &StatelessRulesAndCustomActionsProperty{ StatelessRules: []interface{}{ &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }, }, // the properties below are optional CustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, }, }
type CfnRuleGroup_StatefulRuleOptionsProperty ¶
type CfnRuleGroup_StatefulRuleOptionsProperty struct { // Indicates how to manage the order of the rule evaluation for the rule group. // // `DEFAULT_ACTION_ORDER` is the default behavior. Stateful rules are provided to the rule engine as Suricata compatible strings, and Suricata evaluates them based on certain settings. For more information, see [Evaluation order for stateful rules](https://docs.aws.amazon.com/network-firewall/latest/developerguide/suricata-rule-evaluation-order.html) in the *AWS Network Firewall Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulruleoptions.html#cfn-networkfirewall-rulegroup-statefulruleoptions-ruleorder // RuleOrder *string `field:"optional" json:"ruleOrder" yaml:"ruleOrder"` }
Additional options governing how Network Firewall handles the rule group.
You can only use these for stateful rule groups.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statefulRuleOptionsProperty := &StatefulRuleOptionsProperty{ RuleOrder: jsii.String("ruleOrder"), }
type CfnRuleGroup_StatefulRuleProperty ¶
type CfnRuleGroup_StatefulRuleProperty struct { // Defines what Network Firewall should do with the packets in a traffic flow when the flow matches the stateful rule criteria. // // For all actions, Network Firewall performs the specified action and discontinues stateful inspection of the traffic flow. // // The actions for a stateful rule are defined as follows: // // - *PASS* - Permits the packets to go to the intended destination. // - *DROP* - Blocks the packets from going to the intended destination and sends an alert log message, if alert logging is configured in the `Firewall` `LoggingConfiguration` . // - *REJECT* - Drops traffic that matches the conditions of the stateful rule and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. `REJECT` is available only for TCP traffic. // - *ALERT* - Permits the packets to go to the intended destination and sends an alert log message, if alert logging is configured in the `Firewall` `LoggingConfiguration` . // // You can use this action to test a rule that you intend to use to drop traffic. You can enable the rule with `ALERT` action, verify in the logs that the rule is filtering as you want, then change the action to `DROP` . // - *REJECT* - Drops TCP traffic that matches the conditions of the stateful rule, and sends a TCP reset packet back to sender of the packet. A TCP reset packet is a packet with no payload and a `RST` bit contained in the TCP header flags. Also sends an alert log mesage if alert logging is configured in the `Firewall` `LoggingConfiguration` . // // `REJECT` isn't currently available for use with IMAP and FTP protocols. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-action // Action *string `field:"required" json:"action" yaml:"action"` // The stateful inspection criteria for this rule, used to inspect traffic flows. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-header // Header interface{} `field:"required" json:"header" yaml:"header"` // Additional settings for a stateful rule, provided as keywords and settings. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statefulrule.html#cfn-networkfirewall-rulegroup-statefulrule-ruleoptions // RuleOptions interface{} `field:"required" json:"ruleOptions" yaml:"ruleOptions"` }
A single Suricata rules specification, for use in a stateful rule group.
Use this option to specify a simple Suricata rule with protocol, source and destination, ports, direction, and rule options. For information about the Suricata `Rules` format, see [Rules Format](https://docs.aws.amazon.com/https://suricata.readthedocs.io/en/suricata-6.0.9/rules/intro.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statefulRuleProperty := &StatefulRuleProperty{ Action: jsii.String("action"), Header: &HeaderProperty{ Destination: jsii.String("destination"), DestinationPort: jsii.String("destinationPort"), Direction: jsii.String("direction"), Protocol: jsii.String("protocol"), Source: jsii.String("source"), SourcePort: jsii.String("sourcePort"), }, RuleOptions: []interface{}{ &RuleOptionProperty{ Keyword: jsii.String("keyword"), // the properties below are optional Settings: []*string{ jsii.String("settings"), }, }, }, }
type CfnRuleGroup_StatelessRuleProperty ¶
type CfnRuleGroup_StatelessRuleProperty struct { // Indicates the order in which to run this rule relative to all of the rules that are defined for a stateless rule group. // // Network Firewall evaluates the rules in a rule group starting with the lowest priority setting. You must ensure that the priority settings are unique for the rule group. // // Each stateless rule group uses exactly one `StatelessRulesAndCustomActions` object, and each `StatelessRulesAndCustomActions` contains exactly one `StatelessRules` object. To ensure unique priority settings for your rule groups, set unique priorities for the stateless rules that you define inside any single `StatelessRules` object. // // You can change the priority settings of your rules at any time. To make it easier to insert rules later, number them so there's a wide range in between, for example use 100, 200, and so on. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-priority // Priority *float64 `field:"required" json:"priority" yaml:"priority"` // Defines the stateless 5-tuple packet inspection criteria and the action to take on a packet that matches the criteria. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrule.html#cfn-networkfirewall-rulegroup-statelessrule-ruledefinition // RuleDefinition interface{} `field:"required" json:"ruleDefinition" yaml:"ruleDefinition"` }
A single stateless rule.
This is used in `RuleGroup.StatelessRulesAndCustomActions` .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statelessRuleProperty := &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }
type CfnRuleGroup_StatelessRulesAndCustomActionsProperty ¶
type CfnRuleGroup_StatelessRulesAndCustomActionsProperty struct { // Defines the set of stateless rules for use in a stateless rule group. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-statelessrules // StatelessRules interface{} `field:"required" json:"statelessRules" yaml:"statelessRules"` // Defines an array of individual custom action definitions that are available for use by the stateless rules in this `StatelessRulesAndCustomActions` specification. // // You name each custom action that you define, and then you can use it by name in your stateless rule `RuleGroup.RuleDefinition` `Actions` specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-statelessrulesandcustomactions.html#cfn-networkfirewall-rulegroup-statelessrulesandcustomactions-customactions // CustomActions interface{} `field:"optional" json:"customActions" yaml:"customActions"` }
Stateless inspection criteria.
Each stateless rule group uses exactly one of these data types to define its stateless rules.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" statelessRulesAndCustomActionsProperty := &StatelessRulesAndCustomActionsProperty{ StatelessRules: []interface{}{ &StatelessRuleProperty{ Priority: jsii.Number(123), RuleDefinition: &RuleDefinitionProperty{ Actions: []*string{ jsii.String("actions"), }, MatchAttributes: &MatchAttributesProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, TcpFlags: []interface{}{ &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }, }, }, }, }, }, // the properties below are optional CustomActions: []interface{}{ &CustomActionProperty{ ActionDefinition: &ActionDefinitionProperty{ PublishMetricAction: &PublishMetricActionProperty{ Dimensions: []interface{}{ &DimensionProperty{ Value: jsii.String("value"), }, }, }, }, ActionName: jsii.String("actionName"), }, }, }
type CfnRuleGroup_TCPFlagFieldProperty ¶
type CfnRuleGroup_TCPFlagFieldProperty struct { // Used in conjunction with the `Masks` setting to define the flags that must be set and flags that must not be set in order for the packet to match. // // This setting can only specify values that are also specified in the `Masks` setting. // // For the flags that are specified in the masks setting, the following must be true for the packet to match: // // - The ones that are set in this flags setting must be set in the packet. // - The ones that are not set in this flags setting must also not be set in the packet. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-flags // Flags *[]*string `field:"required" json:"flags" yaml:"flags"` // The set of flags to consider in the inspection. // // To inspect all flags in the valid values list, leave this with no setting. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-tcpflagfield.html#cfn-networkfirewall-rulegroup-tcpflagfield-masks // Masks *[]*string `field:"optional" json:"masks" yaml:"masks"` }
TCP flags and masks to inspect packets for. This is used in the `RuleGroup.MatchAttributes` specification.
For example:
`"TCPFlags": [ { "Flags": [ "ECE", "SYN" ], "Masks": [ "SYN", "ECE" ] } ]`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tCPFlagFieldProperty := &TCPFlagFieldProperty{ Flags: []*string{ jsii.String("flags"), }, // the properties below are optional Masks: []*string{ jsii.String("masks"), }, }
type CfnTLSInspectionConfiguration ¶ added in v2.117.0
type CfnTLSInspectionConfiguration interface { awscdk.CfnResource awscdk.IInspectable awscdk.ITaggableV2 // The Amazon Resource Name (ARN) of the TLS inspection configuration. AttrTlsInspectionConfigurationArn() *string // A unique identifier for the TLS inspection configuration. // // This ID is returned in the responses to create and list commands. You provide it to operations such as update and delete. AttrTlsInspectionConfigurationId() *string // Tag Manager which manages the tags for this resource. CdkTagManager() awscdk.TagManager // Options for this resource, such as condition, update policy etc. CfnOptions() awscdk.ICfnResourceOptions CfnProperties() *map[string]interface{} // AWS resource type. CfnResourceType() *string // Returns: the stack trace of the point where this Resource was created from, sourced // from the +metadata+ entry typed +aws:cdk:logicalId+, and with the bottom-most // node +internal+ entries filtered. CreationStack() *[]*string // A description of the TLS inspection configuration. Description() *string SetDescription(val *string) // The logical ID for this CloudFormation stack element. // // The logical ID of the element // is calculated from the path of the resource node in the construct tree. // // To override this value, use `overrideLogicalId(newLogicalId)`. // // Returns: the logical ID as a stringified token. This value will only get // resolved during synthesis. LogicalId() *string // The tree node. Node() constructs.Node // Return a string that will be resolved to a CloudFormation `{ Ref }` for this element. // // If, by any chance, the intrinsic reference of a resource is not a string, you could // coerce it to an IResolvable through `Lazy.any({ produce: resource.ref })`. Ref() *string // The stack in which this element is defined. // // CfnElements must be defined within a stack scope (directly or indirectly). Stack() awscdk.Stack // The key:value pairs to associate with the resource. Tags() *[]*awscdk.CfnTag SetTags(val *[]*awscdk.CfnTag) // The object that defines a TLS inspection configuration. TlsInspectionConfiguration() interface{} SetTlsInspectionConfiguration(val interface{}) // The descriptive name of the TLS inspection configuration. TlsInspectionConfigurationName() *string SetTlsInspectionConfigurationName(val *string) // Deprecated. // Deprecated: use `updatedProperties` // // Return properties modified after initiation // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperites() *map[string]interface{} // Return properties modified after initiation. // // Resources that expose mutable properties should override this function to // collect and return the properties object for this resource. UpdatedProperties() *map[string]interface{} // Syntactic sugar for `addOverride(path, undefined)`. AddDeletionOverride(path *string) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // // This can be used for resources across stacks (or nested stack) boundaries // and the dependency will automatically be transferred to the relevant scope. AddDependency(target awscdk.CfnResource) // Indicates that this resource depends on another resource and cannot be provisioned unless the other resource has been successfully provisioned. // Deprecated: use addDependency. AddDependsOn(target awscdk.CfnResource) // Add a value to the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // AddMetadata(key *string, value interface{}) // Adds an override to the synthesized CloudFormation resource. // // To add a // property override, either use `addPropertyOverride` or prefix `path` with // "Properties." (i.e. `Properties.TopicName`). // // If the override is nested, separate each nested level using a dot (.) in the path parameter. // If there is an array as part of the nesting, specify the index in the path. // // To include a literal `.` in the property name, prefix with a `\`. In most // programming languages you will need to write this as `"\\."` because the // `\` itself will need to be escaped. // // For example, // “`typescript // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.0.Projection.NonKeyAttributes', ['myattribute']); // cfnResource.addOverride('Properties.GlobalSecondaryIndexes.1.ProjectionType', 'INCLUDE'); // “` // would add the overrides // “`json // "Properties": { // "GlobalSecondaryIndexes": [ // { // "Projection": { // "NonKeyAttributes": [ "myattribute" ] // ... // } // ... // }, // { // "ProjectionType": "INCLUDE" // ... // }, // ] // ... // } // “` // // The `value` argument to `addOverride` will not be processed or translated // in any way. Pass raw JSON values in here with the correct capitalization // for CloudFormation. If you pass CDK classes or structs, they will be // rendered with lowercased key names, and CloudFormation will reject the // template. AddOverride(path *string, value interface{}) // Adds an override that deletes the value of a property from the resource definition. AddPropertyDeletionOverride(propertyPath *string) // Adds an override to a resource property. // // Syntactic sugar for `addOverride("Properties.<...>", value)`. AddPropertyOverride(propertyPath *string, value interface{}) // Sets the deletion policy of the resource based on the removal policy specified. // // The Removal Policy controls what happens to this resource when it stops // being managed by CloudFormation, either because you've removed it from the // CDK application or because you've made a change that requires the resource // to be replaced. // // The resource can be deleted (`RemovalPolicy.DESTROY`), or left in your AWS // account for data recovery and cleanup later (`RemovalPolicy.RETAIN`). In some // cases, a snapshot can be taken of the resource prior to deletion // (`RemovalPolicy.SNAPSHOT`). A list of resources that support this policy // can be found in the following link:. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-attribute-deletionpolicy.html#aws-attribute-deletionpolicy-options // ApplyRemovalPolicy(policy awscdk.RemovalPolicy, options *awscdk.RemovalPolicyOptions) // Returns a token for an runtime attribute of this resource. // // Ideally, use generated attribute accessors (e.g. `resource.arn`), but this can be used for future compatibility // in case there is no generated attribute. GetAtt(attributeName *string, typeHint awscdk.ResolutionTypeHint) awscdk.Reference // Retrieve a value value from the CloudFormation Resource Metadata. // See: https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/metadata-section-structure.html // // Note that this is a different set of metadata from CDK node metadata; this // metadata ends up in the stack template under the resource, whereas CDK // node metadata ends up in the Cloud Assembly. // GetMetadata(key *string) interface{} // Examines the CloudFormation resource and discloses attributes. Inspect(inspector awscdk.TreeInspector) // Retrieves an array of resources this resource depends on. // // This assembles dependencies on resources across stacks (including nested stacks) // automatically. ObtainDependencies() *[]interface{} // Get a shallow copy of dependencies between this resource and other resources in the same stack. ObtainResourceDependencies() *[]awscdk.CfnResource // Overrides the auto-generated logical ID with a specific ID. OverrideLogicalId(newLogicalId *string) // Indicates that this resource no longer depends on another resource. // // This can be used for resources across stacks (including nested stacks) // and the dependency will automatically be removed from the relevant scope. RemoveDependency(target awscdk.CfnResource) RenderProperties(props *map[string]interface{}) *map[string]interface{} // Replaces one dependency with another. ReplaceDependency(target awscdk.CfnResource, newTarget awscdk.CfnResource) // Can be overridden by subclasses to determine if this resource will be rendered into the cloudformation template. // // Returns: `true` if the resource should be included or `false` is the resource // should be omitted. ShouldSynthesize() *bool // Returns a string representation of this construct. // // Returns: a string representation of this resource. ToString() *string ValidateProperties(_properties interface{}) }
The object that defines a TLS inspection configuration.
AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTLSInspectionConfiguration := awscdk.Aws_networkfirewall.NewCfnTLSInspectionConfiguration(this, jsii.String("MyCfnTLSInspectionConfiguration"), &CfnTLSInspectionConfigurationProps{ TlsInspectionConfiguration: &TLSInspectionConfigurationProperty{ ServerCertificateConfigurations: []interface{}{ &ServerCertificateConfigurationProperty{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CheckCertificateRevocationStatus: &CheckCertificateRevocationStatusProperty{ RevokedStatusAction: jsii.String("revokedStatusAction"), UnknownStatusAction: jsii.String("unknownStatusAction"), }, Scopes: []interface{}{ &ServerCertificateScopeProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, }, }, ServerCertificates: []interface{}{ &ServerCertificateProperty{ ResourceArn: jsii.String("resourceArn"), }, }, }, }, }, TlsInspectionConfigurationName: jsii.String("tlsInspectionConfigurationName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, })
func NewCfnTLSInspectionConfiguration ¶ added in v2.117.0
func NewCfnTLSInspectionConfiguration(scope constructs.Construct, id *string, props *CfnTLSInspectionConfigurationProps) CfnTLSInspectionConfiguration
type CfnTLSInspectionConfigurationProps ¶ added in v2.117.0
type CfnTLSInspectionConfigurationProps struct { // The object that defines a TLS inspection configuration. // // AWS Network Firewall uses TLS inspection configurations to decrypt your firewall's inbound and outbound SSL/TLS traffic. After decryption, AWS Network Firewall inspects the traffic according to your firewall policy's stateful rules, and then re-encrypts it before sending it to its destination. You can enable inspection of your firewall's inbound traffic, outbound traffic, or both. To use TLS inspection with your firewall, you must first import or provision certificates using AWS Certificate Manager , create a TLS inspection configuration, add that configuration to a new firewall policy, and then associate that policy with your firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration // TlsInspectionConfiguration interface{} `field:"required" json:"tlsInspectionConfiguration" yaml:"tlsInspectionConfiguration"` // The descriptive name of the TLS inspection configuration. // // You can't change the name of a TLS inspection configuration after you create it. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfigurationname // TlsInspectionConfigurationName *string `field:"required" json:"tlsInspectionConfigurationName" yaml:"tlsInspectionConfigurationName"` // A description of the TLS inspection configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-description // Description *string `field:"optional" json:"description" yaml:"description"` // The key:value pairs to associate with the resource. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tags // Tags *[]*awscdk.CfnTag `field:"optional" json:"tags" yaml:"tags"` }
Properties for defining a `CfnTLSInspectionConfiguration`.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" cfnTLSInspectionConfigurationProps := &CfnTLSInspectionConfigurationProps{ TlsInspectionConfiguration: &TLSInspectionConfigurationProperty{ ServerCertificateConfigurations: []interface{}{ &ServerCertificateConfigurationProperty{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CheckCertificateRevocationStatus: &CheckCertificateRevocationStatusProperty{ RevokedStatusAction: jsii.String("revokedStatusAction"), UnknownStatusAction: jsii.String("unknownStatusAction"), }, Scopes: []interface{}{ &ServerCertificateScopeProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, }, }, ServerCertificates: []interface{}{ &ServerCertificateProperty{ ResourceArn: jsii.String("resourceArn"), }, }, }, }, }, TlsInspectionConfigurationName: jsii.String("tlsInspectionConfigurationName"), // the properties below are optional Description: jsii.String("description"), Tags: []cfnTag{ &cfnTag{ Key: jsii.String("key"), Value: jsii.String("value"), }, }, }
type CfnTLSInspectionConfiguration_AddressProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_AddressProperty struct { // Specify an IP address or a block of IP addresses in Classless Inter-Domain Routing (CIDR) notation. // // Network Firewall supports all address ranges for IPv4 and IPv6. // // Examples: // // - To configure Network Firewall to inspect for the IP address 192.0.2.44, specify `192.0.2.44/32` . // - To configure Network Firewall to inspect for IP addresses from 192.0.2.0 to 192.0.2.255, specify `192.0.2.0/24` . // - To configure Network Firewall to inspect for the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify `1111:0000:0000:0000:0000:0000:0000:0111/128` . // - To configure Network Firewall to inspect for IP addresses from 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify `1111:0000:0000:0000:0000:0000:0000:0000/64` . // // For more information about CIDR notation, see the Wikipedia entry [Classless Inter-Domain Routing](https://docs.aws.amazon.com/https://en.wikipedia.org/wiki/Classless_Inter-Domain_Routing) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-address.html#cfn-networkfirewall-tlsinspectionconfiguration-address-addressdefinition // AddressDefinition *string `field:"required" json:"addressDefinition" yaml:"addressDefinition"` }
A single IP address specification.
This is used in the [MatchAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html) source and destination settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" addressProperty := &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }
type CfnTLSInspectionConfiguration_CheckCertificateRevocationStatusProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_CheckCertificateRevocationStatusProperty struct { // Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has a revoked status. // // - *PASS* - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection. // - *DROP* - Network Firewall closes the connection and drops subsequent packets for that connection. // - *REJECT* - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. `REJECT` is available only for TCP traffic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-revokedstatusaction // RevokedStatusAction *string `field:"optional" json:"revokedStatusAction" yaml:"revokedStatusAction"` // Configures how Network Firewall processes traffic when it determines that the certificate presented by the server in the SSL/TLS connection has an unknown status, or a status that cannot be determined for any other reason, including when the service is unable to connect to the OCSP and CRL endpoints for the certificate. // // - *PASS* - Allow the connection to continue, and pass subsequent packets to the stateful engine for inspection. // - *DROP* - Network Firewall closes the connection and drops subsequent packets for that connection. // - *REJECT* - Network Firewall sends a TCP reject packet back to your client. The service closes the connection and drops subsequent packets for that connection. `REJECT` is available only for TCP traffic. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus.html#cfn-networkfirewall-tlsinspectionconfiguration-checkcertificaterevocationstatus-unknownstatusaction // UnknownStatusAction *string `field:"optional" json:"unknownStatusAction" yaml:"unknownStatusAction"` }
When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status.
If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-servercertificateconfiguration.html) .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" checkCertificateRevocationStatusProperty := &CheckCertificateRevocationStatusProperty{ RevokedStatusAction: jsii.String("revokedStatusAction"), UnknownStatusAction: jsii.String("unknownStatusAction"), }
type CfnTLSInspectionConfiguration_PortRangeProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_PortRangeProperty struct { // The lower limit of the port range. // // This must be less than or equal to the `ToPort` specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-fromport // FromPort *float64 `field:"required" json:"fromPort" yaml:"fromPort"` // The upper limit of the port range. // // This must be greater than or equal to the `FromPort` specification. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-portrange.html#cfn-networkfirewall-tlsinspectionconfiguration-portrange-toport // ToPort *float64 `field:"required" json:"toPort" yaml:"toPort"` }
A single port range specification.
This is used for source and destination port ranges in the stateless rule [MatchAttributes](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-rulegroup-matchattributes.html) , `SourcePorts` , and `DestinationPorts` settings.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" portRangeProperty := &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }
type CfnTLSInspectionConfiguration_ServerCertificateConfigurationProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_ServerCertificateConfigurationProperty struct { // The Amazon Resource Name (ARN) of the imported certificate authority (CA) certificate within AWS Certificate Manager (ACM) to use for outbound SSL/TLS inspection. // // The following limitations apply: // // - You can use CA certificates that you imported into ACM, but you can't generate CA certificates with ACM. // - You can't use certificates issued by AWS Private Certificate Authority . // // For more information about configuring certificates for outbound inspection, see [Using SSL/TLS certificates with certificates with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the *AWS Network Firewall Developer Guide* . // // For information about working with certificates in ACM, see [Importing certificates](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *AWS Certificate Manager User Guide* . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-certificateauthorityarn // CertificateAuthorityArn *string `field:"optional" json:"certificateAuthorityArn" yaml:"certificateAuthorityArn"` // When enabled, Network Firewall checks if the server certificate presented by the server in the SSL/TLS connection has a revoked or unkown status. // // If the certificate has an unknown or revoked status, you must specify the actions that Network Firewall takes on outbound traffic. To check the certificate revocation status, you must also specify a `CertificateAuthorityArn` in [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-servercertificateconfiguration.html) . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-checkcertificaterevocationstatus // CheckCertificateRevocationStatus interface{} `field:"optional" json:"checkCertificateRevocationStatus" yaml:"checkCertificateRevocationStatus"` // A list of scopes. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-scopes // Scopes interface{} `field:"optional" json:"scopes" yaml:"scopes"` // The list of server certificates to use for inbound SSL/TLS inspection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration-servercertificates // ServerCertificates interface{} `field:"optional" json:"serverCertificates" yaml:"serverCertificates"` }
Configures the AWS Certificate Manager certificates and scope that Network Firewall uses to decrypt and re-encrypt traffic using a [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html) . You can configure `ServerCertificates` for inbound SSL/TLS inspection, a `CertificateAuthorityArn` for outbound SSL/TLS inspection, or both. For information about working with certificates for TLS inspection, see [Using SSL/TLS server certficiates with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection-certificate-requirements.html) in the *AWS Network Firewall Developer Guide* .
> If a server certificate that's associated with your [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html) is revoked, deleted, or expired it can result in client-side TLS errors.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serverCertificateConfigurationProperty := &ServerCertificateConfigurationProperty{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CheckCertificateRevocationStatus: &CheckCertificateRevocationStatusProperty{ RevokedStatusAction: jsii.String("revokedStatusAction"), UnknownStatusAction: jsii.String("unknownStatusAction"), }, Scopes: []interface{}{ &ServerCertificateScopeProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, }, }, ServerCertificates: []interface{}{ &ServerCertificateProperty{ ResourceArn: jsii.String("resourceArn"), }, }, }
type CfnTLSInspectionConfiguration_ServerCertificateProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_ServerCertificateProperty struct { // The Amazon Resource Name (ARN) of the AWS Certificate Manager SSL/TLS server certificate that's used for inbound SSL/TLS inspection. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificate.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificate-resourcearn // ResourceArn *string `field:"optional" json:"resourceArn" yaml:"resourceArn"` }
Any AWS Certificate Manager (ACM) Secure Sockets Layer/Transport Layer Security (SSL/TLS) server certificate that's associated with a [ServerCertificateConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificateconfiguration.html) . Used in a [TLSInspectionConfiguration](https://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-networkfirewall-tlsinspectionconfiguration.html) for inspection of inbound traffic to your firewall. You must request or import a SSL/TLS certificate into ACM for each domain Network Firewall needs to decrypt and inspect. AWS Network Firewall uses the SSL/TLS certificates to decrypt specified inbound SSL/TLS traffic going to your firewall. For information about working with certificates in AWS Certificate Manager , see [Request a public certificate](https://docs.aws.amazon.com/acm/latest/userguide/gs-acm-request-public.html) or [Importing certificates](https://docs.aws.amazon.com/acm/latest/userguide/import-certificate.html) in the *AWS Certificate Manager User Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serverCertificateProperty := &ServerCertificateProperty{ ResourceArn: jsii.String("resourceArn"), }
type CfnTLSInspectionConfiguration_ServerCertificateScopeProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_ServerCertificateScopeProperty struct { // The destination ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. // // If not specified, this matches with any destination port. // // You can specify individual ports, for example `1994` , and you can specify port ranges, such as `1990:1994` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinationports // DestinationPorts interface{} `field:"optional" json:"destinationPorts" yaml:"destinationPorts"` // The destination IP addresses and address ranges to decrypt for inspection, in CIDR notation. // // If not specified, this // matches with any destination address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-destinations // Destinations interface{} `field:"optional" json:"destinations" yaml:"destinations"` // The protocols to decrypt for inspection, specified using each protocol's assigned internet protocol number (IANA). // // Network Firewall currently supports only TCP. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-protocols // Protocols interface{} `field:"optional" json:"protocols" yaml:"protocols"` // The source ports to decrypt for inspection, in Transmission Control Protocol (TCP) format. // // If not specified, this matches with any source port. // // You can specify individual ports, for example `1994` , and you can specify port ranges, such as `1990:1994` . // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sourceports // SourcePorts interface{} `field:"optional" json:"sourcePorts" yaml:"sourcePorts"` // The source IP addresses and address ranges to decrypt for inspection, in CIDR notation. // // If not specified, this // matches with any source address. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-servercertificatescope.html#cfn-networkfirewall-tlsinspectionconfiguration-servercertificatescope-sources // Sources interface{} `field:"optional" json:"sources" yaml:"sources"` }
Settings that define the Secure Sockets Layer/Transport Layer Security (SSL/TLS) traffic that Network Firewall should decrypt for inspection by the stateful rule engine.
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" serverCertificateScopeProperty := &ServerCertificateScopeProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, }
type CfnTLSInspectionConfiguration_TLSInspectionConfigurationProperty ¶ added in v2.117.0
type CfnTLSInspectionConfiguration_TLSInspectionConfigurationProperty struct { // Lists the server certificate configurations that are associated with the TLS configuration. // See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-properties-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration.html#cfn-networkfirewall-tlsinspectionconfiguration-tlsinspectionconfiguration-servercertificateconfigurations // ServerCertificateConfigurations interface{} `field:"optional" json:"serverCertificateConfigurations" yaml:"serverCertificateConfigurations"` }
The object that defines a TLS inspection configuration. This defines the TLS inspection configuration.
AWS Network Firewall uses a TLS inspection configuration to decrypt traffic. Network Firewall re-encrypts the traffic before sending it to its destination.
To use a TLS inspection configuration, you add it to a new Network Firewall firewall policy, then you apply the firewall policy to a firewall. Network Firewall acts as a proxy service to decrypt and inspect the traffic traveling through your firewalls. You can reference a TLS inspection configuration from more than one firewall policy, and you can use a firewall policy in more than one firewall. For more information about using TLS inspection configurations, see [Inspecting SSL/TLS traffic with TLS inspection configurations](https://docs.aws.amazon.com/network-firewall/latest/developerguide/tls-inspection.html) in the *AWS Network Firewall Developer Guide* .
Example:
// The code below shows an example of how to instantiate this type. // The values are placeholders you should change. import "github.com/aws/aws-cdk-go/awscdk" tLSInspectionConfigurationProperty := &TLSInspectionConfigurationProperty{ ServerCertificateConfigurations: []interface{}{ &ServerCertificateConfigurationProperty{ CertificateAuthorityArn: jsii.String("certificateAuthorityArn"), CheckCertificateRevocationStatus: &CheckCertificateRevocationStatusProperty{ RevokedStatusAction: jsii.String("revokedStatusAction"), UnknownStatusAction: jsii.String("unknownStatusAction"), }, Scopes: []interface{}{ &ServerCertificateScopeProperty{ DestinationPorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Destinations: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, Protocols: []interface{}{ jsii.Number(123), }, SourcePorts: []interface{}{ &PortRangeProperty{ FromPort: jsii.Number(123), ToPort: jsii.Number(123), }, }, Sources: []interface{}{ &AddressProperty{ AddressDefinition: jsii.String("addressDefinition"), }, }, }, }, ServerCertificates: []interface{}{ &ServerCertificateProperty{ ResourceArn: jsii.String("resourceArn"), }, }, }, }, }
Source Files ¶
- CfnFirewall.go
- CfnFirewallPolicy.go
- CfnFirewallPolicyProps.go
- CfnFirewallPolicy_ActionDefinitionProperty.go
- CfnFirewallPolicy_CustomActionProperty.go
- CfnFirewallPolicy_DimensionProperty.go
- CfnFirewallPolicy_FirewallPolicyProperty.go
- CfnFirewallPolicy_IPSetProperty.go
- CfnFirewallPolicy_PolicyVariablesProperty.go
- CfnFirewallPolicy_PublishMetricActionProperty.go
- CfnFirewallPolicy_StatefulEngineOptionsProperty.go
- CfnFirewallPolicy_StatefulRuleGroupOverrideProperty.go
- CfnFirewallPolicy_StatefulRuleGroupReferenceProperty.go
- CfnFirewallPolicy_StatelessRuleGroupReferenceProperty.go
- CfnFirewallPolicy__checks.go
- CfnFirewallProps.go
- CfnFirewall_SubnetMappingProperty.go
- CfnFirewall__checks.go
- CfnLoggingConfiguration.go
- CfnLoggingConfigurationProps.go
- CfnLoggingConfiguration_LogDestinationConfigProperty.go
- CfnLoggingConfiguration_LoggingConfigurationProperty.go
- CfnLoggingConfiguration__checks.go
- CfnRuleGroup.go
- CfnRuleGroupProps.go
- CfnRuleGroup_ActionDefinitionProperty.go
- CfnRuleGroup_AddressProperty.go
- CfnRuleGroup_CustomActionProperty.go
- CfnRuleGroup_DimensionProperty.go
- CfnRuleGroup_HeaderProperty.go
- CfnRuleGroup_IPSetProperty.go
- CfnRuleGroup_IPSetReferenceProperty.go
- CfnRuleGroup_MatchAttributesProperty.go
- CfnRuleGroup_PortRangeProperty.go
- CfnRuleGroup_PortSetProperty.go
- CfnRuleGroup_PublishMetricActionProperty.go
- CfnRuleGroup_ReferenceSetsProperty.go
- CfnRuleGroup_RuleDefinitionProperty.go
- CfnRuleGroup_RuleGroupProperty.go
- CfnRuleGroup_RuleOptionProperty.go
- CfnRuleGroup_RuleVariablesProperty.go
- CfnRuleGroup_RulesSourceListProperty.go
- CfnRuleGroup_RulesSourceProperty.go
- CfnRuleGroup_StatefulRuleOptionsProperty.go
- CfnRuleGroup_StatefulRuleProperty.go
- CfnRuleGroup_StatelessRuleProperty.go
- CfnRuleGroup_StatelessRulesAndCustomActionsProperty.go
- CfnRuleGroup_TCPFlagFieldProperty.go
- CfnRuleGroup__checks.go
- CfnTLSInspectionConfiguration.go
- CfnTLSInspectionConfigurationProps.go
- CfnTLSInspectionConfiguration_AddressProperty.go
- CfnTLSInspectionConfiguration_CheckCertificateRevocationStatusProperty.go
- CfnTLSInspectionConfiguration_PortRangeProperty.go
- CfnTLSInspectionConfiguration_ServerCertificateConfigurationProperty.go
- CfnTLSInspectionConfiguration_ServerCertificateProperty.go
- CfnTLSInspectionConfiguration_ServerCertificateScopeProperty.go
- CfnTLSInspectionConfiguration_TLSInspectionConfigurationProperty.go
- CfnTLSInspectionConfiguration__checks.go
- main.go