Class: Aws::WAFV2::Types::ManagedRuleSet

Inherits:
Struct
  • Object
show all
Defined in:
gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb

Overview

A set of rules that is managed by Amazon Web Services and Amazon Web Services Marketplace sellers to provide versioned managed rule groups for customers of WAF.

This is intended for use only by vendors of managed rule sets. Vendors are Amazon Web Services and Amazon Web Services Marketplace sellers.

Vendors, you can use the managed rule set APIs to provide controlled rollout of your versioned managed rule group offerings for your customers. The APIs are ListManagedRuleSets, GetManagedRuleSet, PutManagedRuleSetVersions, and UpdateManagedRuleSetVersionExpiryDate.

Constant Summary collapse

SENSITIVE =
[]

Instance Attribute Summary collapse

Instance Attribute Details

#arnString

The Amazon Resource Name (ARN) of the entity.

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#descriptionString

A description of the set that helps with identification.

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#idString

A unique identifier for the managed rule set. The ID is returned in the responses to commands like list. You provide it to operations like get and update.

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#label_namespaceString

The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set. All labels that are added by rules in the managed rule group have this prefix.

  • The syntax for the label namespace prefix for a managed rule group is the following:

    awswaf:managed:<vendor>:<rule group name>:

  • When a rule with a label matches a web request, WAF adds the fully qualified label to the request. A fully qualified label is made up of the label namespace from the rule group or web ACL where the rule is defined and the label from the rule, separated by a colon:

    <label namespace>:<label from rule>

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#nameString

The name of the managed rule set. You use this, along with the rule set ID, to identify the rule set.

This name is assigned to the corresponding managed rule group, which your customers can access and use.

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

#published_versionsHash<String,Types::ManagedRuleSetVersion>

The versions of this managed rule set that are available for use by customers.

Returns:



5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end

The version that you would like your customers to use.

Returns:

  • (String)


5683
5684
5685
5686
5687
5688
5689
5690
5691
5692
5693
# File 'gems/aws-sdk-wafv2/lib/aws-sdk-wafv2/types.rb', line 5683

class ManagedRuleSet < Struct.new(
  :name,
  :id,
  :arn,
  :description,
  :published_versions,
  :recommended_version,
  :label_namespace)
  SENSITIVE = []
  include Aws::Structure
end