@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class ManagedRuleSet extends Object implements Serializable, Cloneable, StructuredPojo
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
.
Constructor and Description |
---|
ManagedRuleSet() |
Modifier and Type | Method and Description |
---|---|
ManagedRuleSet |
addPublishedVersionsEntry(String key,
ManagedRuleSetVersion value)
Add a single PublishedVersions entry
|
ManagedRuleSet |
clearPublishedVersionsEntries()
Removes all the entries added into PublishedVersions.
|
ManagedRuleSet |
clone() |
boolean |
equals(Object obj) |
String |
getARN()
The Amazon Resource Name (ARN) of the entity.
|
String |
getDescription()
A description of the set that helps with identification.
|
String |
getId()
A unique identifier for the managed rule set.
|
String |
getLabelNamespace()
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
|
String |
getName()
The name of the managed rule set.
|
Map<String,ManagedRuleSetVersion> |
getPublishedVersions()
The versions of this managed rule set that are available for use by customers.
|
String |
getRecommendedVersion()
The version that you would like your customers to use.
|
int |
hashCode() |
void |
marshall(ProtocolMarshaller protocolMarshaller)
Marshalls this structured data using the given
ProtocolMarshaller . |
void |
setARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
|
void |
setDescription(String description)
A description of the set that helps with identification.
|
void |
setId(String id)
A unique identifier for the managed rule set.
|
void |
setLabelNamespace(String labelNamespace)
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
|
void |
setName(String name)
The name of the managed rule set.
|
void |
setPublishedVersions(Map<String,ManagedRuleSetVersion> publishedVersions)
The versions of this managed rule set that are available for use by customers.
|
void |
setRecommendedVersion(String recommendedVersion)
The version that you would like your customers to use.
|
String |
toString()
Returns a string representation of this object.
|
ManagedRuleSet |
withARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
|
ManagedRuleSet |
withDescription(String description)
A description of the set that helps with identification.
|
ManagedRuleSet |
withId(String id)
A unique identifier for the managed rule set.
|
ManagedRuleSet |
withLabelNamespace(String labelNamespace)
The label namespace prefix for the managed rule groups that are offered to customers from this managed rule set.
|
ManagedRuleSet |
withName(String name)
The name of the managed rule set.
|
ManagedRuleSet |
withPublishedVersions(Map<String,ManagedRuleSetVersion> publishedVersions)
The versions of this managed rule set that are available for use by customers.
|
ManagedRuleSet |
withRecommendedVersion(String recommendedVersion)
The version that you would like your customers to use.
|
public void setName(String name)
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.
name
- 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.
public String getName()
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.
This name is assigned to the corresponding managed rule group, which your customers can access and use.
public ManagedRuleSet withName(String name)
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.
name
- 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.
public void setId(String id)
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
.
id
- 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
.public String getId()
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
.
list
. You provide it to operations like get
and update
.public ManagedRuleSet withId(String id)
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
.
id
- 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
.public void setARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
aRN
- The Amazon Resource Name (ARN) of the entity.public String getARN()
The Amazon Resource Name (ARN) of the entity.
public ManagedRuleSet withARN(String aRN)
The Amazon Resource Name (ARN) of the entity.
aRN
- The Amazon Resource Name (ARN) of the entity.public void setDescription(String description)
A description of the set that helps with identification.
description
- A description of the set that helps with identification.public String getDescription()
A description of the set that helps with identification.
public ManagedRuleSet withDescription(String description)
A description of the set that helps with identification.
description
- A description of the set that helps with identification.public Map<String,ManagedRuleSetVersion> getPublishedVersions()
The versions of this managed rule set that are available for use by customers.
public void setPublishedVersions(Map<String,ManagedRuleSetVersion> publishedVersions)
The versions of this managed rule set that are available for use by customers.
publishedVersions
- The versions of this managed rule set that are available for use by customers.public ManagedRuleSet withPublishedVersions(Map<String,ManagedRuleSetVersion> publishedVersions)
The versions of this managed rule set that are available for use by customers.
publishedVersions
- The versions of this managed rule set that are available for use by customers.public ManagedRuleSet addPublishedVersionsEntry(String key, ManagedRuleSetVersion value)
public ManagedRuleSet clearPublishedVersionsEntries()
public void setRecommendedVersion(String recommendedVersion)
The version that you would like your customers to use.
recommendedVersion
- The version that you would like your customers to use.public String getRecommendedVersion()
The version that you would like your customers to use.
public ManagedRuleSet withRecommendedVersion(String recommendedVersion)
The version that you would like your customers to use.
recommendedVersion
- The version that you would like your customers to use.public void setLabelNamespace(String labelNamespace)
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>
labelNamespace
- 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>
public String getLabelNamespace()
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>
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>
public ManagedRuleSet withLabelNamespace(String labelNamespace)
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>
labelNamespace
- 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>
public String toString()
toString
in class Object
Object.toString()
public ManagedRuleSet clone()
public void marshall(ProtocolMarshaller protocolMarshaller)
StructuredPojo
ProtocolMarshaller
.marshall
in interface StructuredPojo
protocolMarshaller
- Implementation of ProtocolMarshaller
used to marshall this object's data.