Show / Hide Table of Contents

Class CfnPolicyPropsMixin

An AWS Firewall Manager policy.

Inheritance
object
Mixin
CfnPolicyPropsMixin
Implements
IMixin
Inherited Members
Mixin.IsMixin(object)
Namespace: Amazon.CDK.Mixins.Preview.AWS.FMS.Mixins
Assembly: Amazon.CDK.Mixins.Preview.dll
Syntax (csharp)
public class CfnPolicyPropsMixin : Mixin, IMixin
Syntax (vb)
Public Class CfnPolicyPropsMixin Inherits Mixin Implements IMixin
Remarks

A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

Firewall Manager provides the following types of policies:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

    CloudformationResource: AWS::FMS::Policy

    Mixin: true

    ExampleMetadata: fixture=_generated

    Examples
    // The code below shows an example of how to instantiate this type.
                 // The values are placeholders you should change.
                 using Amazon.CDK.Mixins.Preview.Mixins;
                 using Amazon.CDK.Mixins.Preview.AWS.FMS.Mixins;
    
                 var cfnPolicyPropsMixin = new CfnPolicyPropsMixin(new CfnPolicyMixinProps {
                     DeleteAllPolicyResources = false,
                     ExcludeMap = new Dictionary<string, string[]?> {
                         { "account", new [] { "account" } },
                         { "orgunit", new [] { "orgunit" } }
                     },
                     ExcludeResourceTags = false,
                     IncludeMap = new Dictionary<string, string[]?> {
                         { "account", new [] { "account" } },
                         { "orgunit", new [] { "orgunit" } }
                     },
                     PolicyDescription = "policyDescription",
                     PolicyName = "policyName",
                     RemediationEnabled = false,
                     ResourcesCleanUp = false,
                     ResourceSetIds = new [] { "resourceSetIds" },
                     ResourceTagLogicalOperator = "resourceTagLogicalOperator",
                     ResourceTags = new [] { new ResourceTagProperty {
                         Key = "key",
                         Value = "value"
                     } },
                     ResourceType = "resourceType",
                     ResourceTypeList = new [] { "resourceTypeList" },
                     SecurityServicePolicyData = new SecurityServicePolicyDataProperty {
                         ManagedServiceData = "managedServiceData",
                         PolicyOption = new PolicyOptionProperty {
                             NetworkAclCommonPolicy = new NetworkAclCommonPolicyProperty {
                                 NetworkAclEntrySet = new NetworkAclEntrySetProperty {
                                     FirstEntries = new [] { new NetworkAclEntryProperty {
                                         CidrBlock = "cidrBlock",
                                         Egress = false,
                                         IcmpTypeCode = new IcmpTypeCodeProperty {
                                             Code = 123,
                                             Type = 123
                                         },
                                         Ipv6CidrBlock = "ipv6CidrBlock",
                                         PortRange = new PortRangeProperty {
                                             From = 123,
                                             To = 123
                                         },
                                         Protocol = "protocol",
                                         RuleAction = "ruleAction"
                                     } },
                                     ForceRemediateForFirstEntries = false,
                                     ForceRemediateForLastEntries = false,
                                     LastEntries = new [] { new NetworkAclEntryProperty {
                                         CidrBlock = "cidrBlock",
                                         Egress = false,
                                         IcmpTypeCode = new IcmpTypeCodeProperty {
                                             Code = 123,
                                             Type = 123
                                         },
                                         Ipv6CidrBlock = "ipv6CidrBlock",
                                         PortRange = new PortRangeProperty {
                                             From = 123,
                                             To = 123
                                         },
                                         Protocol = "protocol",
                                         RuleAction = "ruleAction"
                                     } }
                                 }
                             },
                             NetworkFirewallPolicy = new NetworkFirewallPolicyProperty {
                                 FirewallDeploymentModel = "firewallDeploymentModel"
                             },
                             ThirdPartyFirewallPolicy = new ThirdPartyFirewallPolicyProperty {
                                 FirewallDeploymentModel = "firewallDeploymentModel"
                             }
                         },
                         Type = "type"
                     },
                     Tags = new [] { new PolicyTagProperty {
                         Key = "key",
                         Value = "value"
                     } }
                 }, new CfnPropertyMixinOptions {
                     Strategy = PropertyMergeStrategy.OVERRIDE
                 });

    Synopsis

    Constructors

    CfnPolicyPropsMixin(ICfnPolicyMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::FMS::Policy.

    Properties

    CFN_PROPERTY_KEYS

    An AWS Firewall Manager policy.

    Props

    An AWS Firewall Manager policy.

    Strategy

    An AWS Firewall Manager policy.

    Methods

    ApplyTo(IConstruct)

    Apply the mixin properties to the construct.

    Supports(IConstruct)

    Check if this mixin supports the given construct.

    Constructors

    CfnPolicyPropsMixin(ICfnPolicyMixinProps, ICfnPropertyMixinOptions?)

    Create a mixin to apply properties to AWS::FMS::Policy.

    public CfnPolicyPropsMixin(ICfnPolicyMixinProps props, ICfnPropertyMixinOptions? options = null)
    Parameters
    props ICfnPolicyMixinProps

    L1 properties to apply.

    options ICfnPropertyMixinOptions

    Mixin options.

    Remarks

    A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

    If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

    Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

    Firewall Manager provides the following types of policies:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

      CloudformationResource: AWS::FMS::Policy

      Mixin: true

      ExampleMetadata: fixture=_generated

      Properties

      CFN_PROPERTY_KEYS

      An AWS Firewall Manager policy.

      protected static string[] CFN_PROPERTY_KEYS { get; }
      Property Value

      string[]

      Remarks

      A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

      If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

      Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

      Firewall Manager provides the following types of policies:

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

        CloudformationResource: AWS::FMS::Policy

        Mixin: true

        ExampleMetadata: fixture=_generated

        Examples
        // The code below shows an example of how to instantiate this type.
                     // The values are placeholders you should change.
                     using Amazon.CDK.Mixins.Preview.Mixins;
                     using Amazon.CDK.Mixins.Preview.AWS.FMS.Mixins;
        
                     var cfnPolicyPropsMixin = new CfnPolicyPropsMixin(new CfnPolicyMixinProps {
                         DeleteAllPolicyResources = false,
                         ExcludeMap = new Dictionary<string, string[]?> {
                             { "account", new [] { "account" } },
                             { "orgunit", new [] { "orgunit" } }
                         },
                         ExcludeResourceTags = false,
                         IncludeMap = new Dictionary<string, string[]?> {
                             { "account", new [] { "account" } },
                             { "orgunit", new [] { "orgunit" } }
                         },
                         PolicyDescription = "policyDescription",
                         PolicyName = "policyName",
                         RemediationEnabled = false,
                         ResourcesCleanUp = false,
                         ResourceSetIds = new [] { "resourceSetIds" },
                         ResourceTagLogicalOperator = "resourceTagLogicalOperator",
                         ResourceTags = new [] { new ResourceTagProperty {
                             Key = "key",
                             Value = "value"
                         } },
                         ResourceType = "resourceType",
                         ResourceTypeList = new [] { "resourceTypeList" },
                         SecurityServicePolicyData = new SecurityServicePolicyDataProperty {
                             ManagedServiceData = "managedServiceData",
                             PolicyOption = new PolicyOptionProperty {
                                 NetworkAclCommonPolicy = new NetworkAclCommonPolicyProperty {
                                     NetworkAclEntrySet = new NetworkAclEntrySetProperty {
                                         FirstEntries = new [] { new NetworkAclEntryProperty {
                                             CidrBlock = "cidrBlock",
                                             Egress = false,
                                             IcmpTypeCode = new IcmpTypeCodeProperty {
                                                 Code = 123,
                                                 Type = 123
                                             },
                                             Ipv6CidrBlock = "ipv6CidrBlock",
                                             PortRange = new PortRangeProperty {
                                                 From = 123,
                                                 To = 123
                                             },
                                             Protocol = "protocol",
                                             RuleAction = "ruleAction"
                                         } },
                                         ForceRemediateForFirstEntries = false,
                                         ForceRemediateForLastEntries = false,
                                         LastEntries = new [] { new NetworkAclEntryProperty {
                                             CidrBlock = "cidrBlock",
                                             Egress = false,
                                             IcmpTypeCode = new IcmpTypeCodeProperty {
                                                 Code = 123,
                                                 Type = 123
                                             },
                                             Ipv6CidrBlock = "ipv6CidrBlock",
                                             PortRange = new PortRangeProperty {
                                                 From = 123,
                                                 To = 123
                                             },
                                             Protocol = "protocol",
                                             RuleAction = "ruleAction"
                                         } }
                                     }
                                 },
                                 NetworkFirewallPolicy = new NetworkFirewallPolicyProperty {
                                     FirewallDeploymentModel = "firewallDeploymentModel"
                                 },
                                 ThirdPartyFirewallPolicy = new ThirdPartyFirewallPolicyProperty {
                                     FirewallDeploymentModel = "firewallDeploymentModel"
                                 }
                             },
                             Type = "type"
                         },
                         Tags = new [] { new PolicyTagProperty {
                             Key = "key",
                             Value = "value"
                         } }
                     }, new CfnPropertyMixinOptions {
                         Strategy = PropertyMergeStrategy.OVERRIDE
                     });

        Props

        An AWS Firewall Manager policy.

        protected virtual ICfnPolicyMixinProps Props { get; }
        Property Value

        ICfnPolicyMixinProps

        Remarks

        A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

        If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

        Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

        Firewall Manager provides the following types of policies:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

          CloudformationResource: AWS::FMS::Policy

          Mixin: true

          ExampleMetadata: fixture=_generated

          Examples
          // The code below shows an example of how to instantiate this type.
                       // The values are placeholders you should change.
                       using Amazon.CDK.Mixins.Preview.Mixins;
                       using Amazon.CDK.Mixins.Preview.AWS.FMS.Mixins;
          
                       var cfnPolicyPropsMixin = new CfnPolicyPropsMixin(new CfnPolicyMixinProps {
                           DeleteAllPolicyResources = false,
                           ExcludeMap = new Dictionary<string, string[]?> {
                               { "account", new [] { "account" } },
                               { "orgunit", new [] { "orgunit" } }
                           },
                           ExcludeResourceTags = false,
                           IncludeMap = new Dictionary<string, string[]?> {
                               { "account", new [] { "account" } },
                               { "orgunit", new [] { "orgunit" } }
                           },
                           PolicyDescription = "policyDescription",
                           PolicyName = "policyName",
                           RemediationEnabled = false,
                           ResourcesCleanUp = false,
                           ResourceSetIds = new [] { "resourceSetIds" },
                           ResourceTagLogicalOperator = "resourceTagLogicalOperator",
                           ResourceTags = new [] { new ResourceTagProperty {
                               Key = "key",
                               Value = "value"
                           } },
                           ResourceType = "resourceType",
                           ResourceTypeList = new [] { "resourceTypeList" },
                           SecurityServicePolicyData = new SecurityServicePolicyDataProperty {
                               ManagedServiceData = "managedServiceData",
                               PolicyOption = new PolicyOptionProperty {
                                   NetworkAclCommonPolicy = new NetworkAclCommonPolicyProperty {
                                       NetworkAclEntrySet = new NetworkAclEntrySetProperty {
                                           FirstEntries = new [] { new NetworkAclEntryProperty {
                                               CidrBlock = "cidrBlock",
                                               Egress = false,
                                               IcmpTypeCode = new IcmpTypeCodeProperty {
                                                   Code = 123,
                                                   Type = 123
                                               },
                                               Ipv6CidrBlock = "ipv6CidrBlock",
                                               PortRange = new PortRangeProperty {
                                                   From = 123,
                                                   To = 123
                                               },
                                               Protocol = "protocol",
                                               RuleAction = "ruleAction"
                                           } },
                                           ForceRemediateForFirstEntries = false,
                                           ForceRemediateForLastEntries = false,
                                           LastEntries = new [] { new NetworkAclEntryProperty {
                                               CidrBlock = "cidrBlock",
                                               Egress = false,
                                               IcmpTypeCode = new IcmpTypeCodeProperty {
                                                   Code = 123,
                                                   Type = 123
                                               },
                                               Ipv6CidrBlock = "ipv6CidrBlock",
                                               PortRange = new PortRangeProperty {
                                                   From = 123,
                                                   To = 123
                                               },
                                               Protocol = "protocol",
                                               RuleAction = "ruleAction"
                                           } }
                                       }
                                   },
                                   NetworkFirewallPolicy = new NetworkFirewallPolicyProperty {
                                       FirewallDeploymentModel = "firewallDeploymentModel"
                                   },
                                   ThirdPartyFirewallPolicy = new ThirdPartyFirewallPolicyProperty {
                                       FirewallDeploymentModel = "firewallDeploymentModel"
                                   }
                               },
                               Type = "type"
                           },
                           Tags = new [] { new PolicyTagProperty {
                               Key = "key",
                               Value = "value"
                           } }
                       }, new CfnPropertyMixinOptions {
                           Strategy = PropertyMergeStrategy.OVERRIDE
                       });

          Strategy

          An AWS Firewall Manager policy.

          protected virtual PropertyMergeStrategy Strategy { get; }
          Property Value

          PropertyMergeStrategy

          Remarks

          A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

          If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

          Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

          Firewall Manager provides the following types of policies:

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

            CloudformationResource: AWS::FMS::Policy

            Mixin: true

            ExampleMetadata: fixture=_generated

            Examples
            // The code below shows an example of how to instantiate this type.
                         // The values are placeholders you should change.
                         using Amazon.CDK.Mixins.Preview.Mixins;
                         using Amazon.CDK.Mixins.Preview.AWS.FMS.Mixins;
            
                         var cfnPolicyPropsMixin = new CfnPolicyPropsMixin(new CfnPolicyMixinProps {
                             DeleteAllPolicyResources = false,
                             ExcludeMap = new Dictionary<string, string[]?> {
                                 { "account", new [] { "account" } },
                                 { "orgunit", new [] { "orgunit" } }
                             },
                             ExcludeResourceTags = false,
                             IncludeMap = new Dictionary<string, string[]?> {
                                 { "account", new [] { "account" } },
                                 { "orgunit", new [] { "orgunit" } }
                             },
                             PolicyDescription = "policyDescription",
                             PolicyName = "policyName",
                             RemediationEnabled = false,
                             ResourcesCleanUp = false,
                             ResourceSetIds = new [] { "resourceSetIds" },
                             ResourceTagLogicalOperator = "resourceTagLogicalOperator",
                             ResourceTags = new [] { new ResourceTagProperty {
                                 Key = "key",
                                 Value = "value"
                             } },
                             ResourceType = "resourceType",
                             ResourceTypeList = new [] { "resourceTypeList" },
                             SecurityServicePolicyData = new SecurityServicePolicyDataProperty {
                                 ManagedServiceData = "managedServiceData",
                                 PolicyOption = new PolicyOptionProperty {
                                     NetworkAclCommonPolicy = new NetworkAclCommonPolicyProperty {
                                         NetworkAclEntrySet = new NetworkAclEntrySetProperty {
                                             FirstEntries = new [] { new NetworkAclEntryProperty {
                                                 CidrBlock = "cidrBlock",
                                                 Egress = false,
                                                 IcmpTypeCode = new IcmpTypeCodeProperty {
                                                     Code = 123,
                                                     Type = 123
                                                 },
                                                 Ipv6CidrBlock = "ipv6CidrBlock",
                                                 PortRange = new PortRangeProperty {
                                                     From = 123,
                                                     To = 123
                                                 },
                                                 Protocol = "protocol",
                                                 RuleAction = "ruleAction"
                                             } },
                                             ForceRemediateForFirstEntries = false,
                                             ForceRemediateForLastEntries = false,
                                             LastEntries = new [] { new NetworkAclEntryProperty {
                                                 CidrBlock = "cidrBlock",
                                                 Egress = false,
                                                 IcmpTypeCode = new IcmpTypeCodeProperty {
                                                     Code = 123,
                                                     Type = 123
                                                 },
                                                 Ipv6CidrBlock = "ipv6CidrBlock",
                                                 PortRange = new PortRangeProperty {
                                                     From = 123,
                                                     To = 123
                                                 },
                                                 Protocol = "protocol",
                                                 RuleAction = "ruleAction"
                                             } }
                                         }
                                     },
                                     NetworkFirewallPolicy = new NetworkFirewallPolicyProperty {
                                         FirewallDeploymentModel = "firewallDeploymentModel"
                                     },
                                     ThirdPartyFirewallPolicy = new ThirdPartyFirewallPolicyProperty {
                                         FirewallDeploymentModel = "firewallDeploymentModel"
                                     }
                                 },
                                 Type = "type"
                             },
                             Tags = new [] { new PolicyTagProperty {
                                 Key = "key",
                                 Value = "value"
                             } }
                         }, new CfnPropertyMixinOptions {
                             Strategy = PropertyMergeStrategy.OVERRIDE
                         });

            Methods

            ApplyTo(IConstruct)

            Apply the mixin properties to the construct.

            public override IConstruct ApplyTo(IConstruct construct)
            Parameters
            construct IConstruct
            Returns

            IConstruct

            Overrides
            Mixin.ApplyTo(IConstruct)
            Remarks

            A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

            If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

            Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

            Firewall Manager provides the following types of policies:

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

              CloudformationResource: AWS::FMS::Policy

              Mixin: true

              ExampleMetadata: fixture=_generated

              Supports(IConstruct)

              Check if this mixin supports the given construct.

              public override bool Supports(IConstruct construct)
              Parameters
              construct IConstruct
              Returns

              bool

              Overrides
              Mixin.Supports(IConstruct)
              Remarks

              A Firewall Manager policy is specific to the individual policy type. If you want to enforce multiple policy types across accounts, you can create multiple policies. You can create more than one policy for each type.

              If you add a new account to an organization that you created with AWS Organizations , Firewall Manager automatically applies the policy to the resources in that account that are within scope of the policy.

              Policies require some setup to use. For more information, see the sections on prerequisites and getting started under Firewall Manager prerequisites .

              Firewall Manager provides the following types of policies:

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-fms-policy.html

                CloudformationResource: AWS::FMS::Policy

                Mixin: true

                ExampleMetadata: fixture=_generated

                Implements

                IMixin
                Back to top Generated by DocFX