Show / Hide Table of Contents

Class CfnWebACLAssociation

This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

Inheritance
object
CfnElement
CfnRefElement
CfnResource
CfnWebACLAssociation
Implements
IInspectable
IWebACLAssociationRef
IConstruct
IDependable
IEnvironmentAware
Inherited Members
CfnResource.IsCfnResource(object)
CfnResource.AddDeletionOverride(string)
CfnResource.AddDependency(CfnResource)
CfnResource.AddDependsOn(CfnResource)
CfnResource.AddMetadata(string, object)
CfnResource.AddOverride(string, object)
CfnResource.AddPropertyDeletionOverride(string)
CfnResource.AddPropertyOverride(string, object)
CfnResource.ApplyRemovalPolicy(RemovalPolicy?, IRemovalPolicyOptions)
CfnResource.GetAtt(string, ResolutionTypeHint?)
CfnResource.GetMetadata(string)
CfnResource.ObtainDependencies()
CfnResource.ObtainResourceDependencies()
CfnResource.RemoveDependency(CfnResource)
CfnResource.ReplaceDependency(CfnResource, CfnResource)
CfnResource.ShouldSynthesize()
CfnResource.ToString()
CfnResource.ValidateProperties(object)
CfnResource.CfnOptions
CfnResource.CfnResourceType
CfnResource.Env
CfnResource.UpdatedProperites
CfnResource.UpdatedProperties
CfnRefElement.Ref
CfnElement.IsCfnElement(object)
CfnElement.OverrideLogicalId(string)
CfnElement.With(params IMixin[])
CfnElement.CreationStack
CfnElement.LogicalId
CfnElement.Stack
Namespace: Amazon.CDK.AWS.WAFv2
Assembly: Amazon.CDK.Lib.dll
Syntax (csharp)
public class CfnWebACLAssociation : CfnResource, IInspectable, IWebACLAssociationRef, IConstruct, IDependable, IEnvironmentAware
Syntax (vb)
Public Class CfnWebACLAssociation Inherits CfnResource Implements IInspectable, IWebACLAssociationRef, IConstruct, IDependable, IEnvironmentAware
Remarks

For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

Required permissions for customer-managed IAM policies

This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

Temporary inconsistencies during updates

When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

The following are examples of the temporary inconsistencies that you might notice during change propagation:

    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

    CloudformationResource: AWS::WAFv2::WebACLAssociation

    ExampleMetadata: infused

    Examples
    EventApi api;
                 CfnWebACL webAcl;
    
    
                 // Associate waf with Event API
                 // Associate waf with Event API
                 new CfnWebACLAssociation(this, "WafAssociation", new CfnWebACLAssociationProps {
                     ResourceArn = api.ApiArn,
                     WebAclArn = webAcl.AttrArn
                 });

    Synopsis

    Constructors

    CfnWebACLAssociation(Construct, string, ICfnWebACLAssociationProps)

    Create a new AWS::WAFv2::WebACLAssociation.

    Properties

    CFN_RESOURCE_TYPE_NAME

    The CloudFormation resource type name for this resource class.

    CfnProperties

    This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

    ResourceArn

    The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

    WebAclArn

    The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

    WebAclAssociationRef

    A reference to a WebACLAssociation resource.

    Methods

    Inspect(TreeInspector)

    Examines the CloudFormation resource and discloses attributes.

    IsCfnWebACLAssociation(object)

    Checks whether the given object is a CfnWebACLAssociation.

    RenderProperties(IDictionary<string, object>)

    This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

    Constructors

    CfnWebACLAssociation(Construct, string, ICfnWebACLAssociationProps)

    Create a new AWS::WAFv2::WebACLAssociation.

    public CfnWebACLAssociation(Construct scope, string id, ICfnWebACLAssociationProps props)
    Parameters
    scope Construct

    Scope in which this resource is defined.

    id string

    Construct identifier for this resource (unique in its scope).

    props ICfnWebACLAssociationProps

    Resource properties.

    Remarks

    For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

    Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

    For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

    Required permissions for customer-managed IAM policies

    This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

    Temporary inconsistencies during updates

    When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

    The following are examples of the temporary inconsistencies that you might notice during change propagation:

      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

      CloudformationResource: AWS::WAFv2::WebACLAssociation

      ExampleMetadata: infused

      Properties

      CFN_RESOURCE_TYPE_NAME

      The CloudFormation resource type name for this resource class.

      public static string CFN_RESOURCE_TYPE_NAME { get; }
      Property Value

      string

      Remarks

      For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

      Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

      For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

      Required permissions for customer-managed IAM policies

      This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

      Temporary inconsistencies during updates

      When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

      The following are examples of the temporary inconsistencies that you might notice during change propagation:

        See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

        CloudformationResource: AWS::WAFv2::WebACLAssociation

        ExampleMetadata: infused

        CfnProperties

        This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

        protected override IDictionary<string, object> CfnProperties { get; }
        Property Value

        IDictionary<string, object>

        Overrides
        CfnResource.CfnProperties
        Remarks

        For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

        Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

        For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

        Required permissions for customer-managed IAM policies

        This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

        Temporary inconsistencies during updates

        When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

        The following are examples of the temporary inconsistencies that you might notice during change propagation:

          See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

          CloudformationResource: AWS::WAFv2::WebACLAssociation

          ExampleMetadata: infused

          ResourceArn

          The Amazon Resource Name (ARN) of the resource to associate with the web ACL.

          public virtual string ResourceArn { get; set; }
          Property Value

          string

          Remarks

          For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

          Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

          For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

          Required permissions for customer-managed IAM policies

          This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

          Temporary inconsistencies during updates

          When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

          The following are examples of the temporary inconsistencies that you might notice during change propagation:

            See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

            CloudformationResource: AWS::WAFv2::WebACLAssociation

            ExampleMetadata: infused

            WebAclArn

            The Amazon Resource Name (ARN) of the web ACL that you want to associate with the resource.

            public virtual string WebAclArn { get; set; }
            Property Value

            string

            Remarks

            For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

            Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

            For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

            Required permissions for customer-managed IAM policies

            This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

            Temporary inconsistencies during updates

            When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

            The following are examples of the temporary inconsistencies that you might notice during change propagation:

              See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

              CloudformationResource: AWS::WAFv2::WebACLAssociation

              ExampleMetadata: infused

              WebAclAssociationRef

              A reference to a WebACLAssociation resource.

              public virtual IWebACLAssociationReference WebAclAssociationRef { get; }
              Property Value

              IWebACLAssociationReference

              Remarks

              For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

              Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

              For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

              Required permissions for customer-managed IAM policies

              This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

              Temporary inconsistencies during updates

              When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

              The following are examples of the temporary inconsistencies that you might notice during change propagation:

                See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

                CloudformationResource: AWS::WAFv2::WebACLAssociation

                ExampleMetadata: infused

                Methods

                Inspect(TreeInspector)

                Examines the CloudFormation resource and discloses attributes.

                public virtual void Inspect(TreeInspector inspector)
                Parameters
                inspector TreeInspector

                tree inspector to collect and process attributes.

                Remarks

                For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

                Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

                For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

                Required permissions for customer-managed IAM policies

                This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

                Temporary inconsistencies during updates

                When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

                The following are examples of the temporary inconsistencies that you might notice during change propagation:

                  See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

                  CloudformationResource: AWS::WAFv2::WebACLAssociation

                  ExampleMetadata: infused

                  IsCfnWebACLAssociation(object)

                  Checks whether the given object is a CfnWebACLAssociation.

                  public static bool IsCfnWebACLAssociation(object x)
                  Parameters
                  x object
                  Returns

                  bool

                  Remarks

                  For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

                  Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

                  For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

                  Required permissions for customer-managed IAM policies

                  This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

                  Temporary inconsistencies during updates

                  When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

                  The following are examples of the temporary inconsistencies that you might notice during change propagation:

                    See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

                    CloudformationResource: AWS::WAFv2::WebACLAssociation

                    ExampleMetadata: infused

                    RenderProperties(IDictionary<string, object>)

                    This is the latest version of AWS WAF , named AWS WAF V2, released in November, 2019.

                    protected override IDictionary<string, object> RenderProperties(IDictionary<string, object> props)
                    Parameters
                    props IDictionary<string, object>
                    Returns

                    IDictionary<string, object>

                    Overrides
                    CfnResource.RenderProperties(IDictionary<string, object>)
                    Remarks

                    For information, including how to migrate your AWS WAF resources from the prior release, see the AWS WAF developer guide .

                    Use a web ACL association to define an association between a web ACL and a regional application resource, to protect the resource. A regional application can be an Application Load Balancer (ALB), an REST API, an AWS AppSync GraphQL API, an Amazon Cognito user pool, an AWS App Runner service, an AWS Amplify application, or an AWS Verified Access instance.

                    For Amazon CloudFront , don't use this resource. Instead, use your CloudFront distribution configuration. To associate a web ACL with a distribution, provide the Amazon Resource Name (ARN) of the WebACL to your CloudFront distribution configuration. To disassociate a web ACL, provide an empty ARN. For information, see AWS::CloudFront::Distribution .

                    Required permissions for customer-managed IAM policies

                    This call requires permissions that are specific to the protected resource type. For details, see Permissions for AssociateWebACL in the AWS WAF Developer Guide .

                    Temporary inconsistencies during updates

                    When you create or change a web ACL or other AWS WAF resources, the changes take a small amount of time to propagate to all areas where the resources are stored. The propagation time can be from a few seconds to a number of minutes.

                    The following are examples of the temporary inconsistencies that you might notice during change propagation:

                      See: http://docs.aws.amazon.com/AWSCloudFormation/latest/UserGuide/aws-resource-wafv2-webaclassociation.html

                      CloudformationResource: AWS::WAFv2::WebACLAssociation

                      ExampleMetadata: infused

                      Implements

                      IInspectable
                      IWebACLAssociationRef
                      Constructs.IConstruct
                      Constructs.IDependable
                      IEnvironmentAware
                      Back to top Generated by DocFX