@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class CreateRuleGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP| Constructor and Description |
|---|
CreateRuleGroupRequest() |
| Modifier and Type | Method and Description |
|---|---|
CreateRuleGroupRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Integer |
getCapacity()
The maximum operating resources that this rule group can use.
|
String |
getDescription()
A description of the rule group.
|
Boolean |
getDryRun()
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
RuleGroup |
getRuleGroup()
An object that defines the rule group rules.
|
String |
getRuleGroupName()
The descriptive name of the rule group.
|
String |
getRules()
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per
line.
|
List<Tag> |
getTags()
The key:value pairs to associate with the resource.
|
String |
getType()
Indicates whether the rule group is stateless or stateful.
|
int |
hashCode() |
Boolean |
isDryRun()
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
void |
setCapacity(Integer capacity)
The maximum operating resources that this rule group can use.
|
void |
setDescription(String description)
A description of the rule group.
|
void |
setDryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
void |
setRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
|
void |
setRuleGroupName(String ruleGroupName)
The descriptive name of the rule group.
|
void |
setRules(String rules)
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per
line.
|
void |
setTags(Collection<Tag> tags)
The key:value pairs to associate with the resource.
|
void |
setType(String type)
Indicates whether the rule group is stateless or stateful.
|
String |
toString()
Returns a string representation of this object.
|
CreateRuleGroupRequest |
withCapacity(Integer capacity)
The maximum operating resources that this rule group can use.
|
CreateRuleGroupRequest |
withDescription(String description)
A description of the rule group.
|
CreateRuleGroupRequest |
withDryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
CreateRuleGroupRequest |
withRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
|
CreateRuleGroupRequest |
withRuleGroupName(String ruleGroupName)
The descriptive name of the rule group.
|
CreateRuleGroupRequest |
withRules(String rules)
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per
line.
|
CreateRuleGroupRequest |
withTags(Collection<Tag> tags)
The key:value pairs to associate with the resource.
|
CreateRuleGroupRequest |
withTags(Tag... tags)
The key:value pairs to associate with the resource.
|
CreateRuleGroupRequest |
withType(RuleGroupType type)
Indicates whether the rule group is stateless or stateful.
|
CreateRuleGroupRequest |
withType(String type)
Indicates whether the rule group is stateless or stateful.
|
addHandlerContext, getCloneRoot, getCloneSource, getCustomQueryParameters, getCustomRequestHeaders, getGeneralProgressListener, getHandlerContext, getReadLimit, getRequestClientOptions, getRequestCredentials, getRequestCredentialsProvider, getRequestMetricCollector, getSdkClientExecutionTimeout, getSdkRequestTimeout, putCustomQueryParameter, putCustomRequestHeader, setGeneralProgressListener, setRequestCredentials, setRequestCredentialsProvider, setRequestMetricCollector, setSdkClientExecutionTimeout, setSdkRequestTimeout, withGeneralProgressListener, withRequestCredentialsProvider, withRequestMetricCollector, withSdkClientExecutionTimeout, withSdkRequestTimeoutpublic void setRuleGroupName(String ruleGroupName)
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.public String getRuleGroupName()
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
public CreateRuleGroupRequest withRuleGroupName(String ruleGroupName)
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
ruleGroupName - The descriptive name of the rule group. You can't change the name of a rule group after you create it.public void setRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
ruleGroup - An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
public RuleGroup getRuleGroup()
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
You must provide either this rule group setting or a Rules setting, but not both.
public CreateRuleGroupRequest withRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
ruleGroup - An object that defines the rule group rules.
You must provide either this rule group setting or a Rules setting, but not both.
public void setRules(String rules)
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
rules - The name of a file containing stateful rule group rules specifications in Suricata flat format, with one
rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
public String getRules()
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
public CreateRuleGroupRequest withRules(String rules)
The name of a file containing stateful rule group rules specifications in Suricata flat format, with one rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
rules - The name of a file containing stateful rule group rules specifications in Suricata flat format, with one
rule per line. Use this to import your existing Suricata compatible rule groups.
You must provide either this rules setting or a populated RuleGroup setting, but not both.
You can provide your rule group specification in a file through this setting when you create or update your rule group. The call response returns a RuleGroup object that Network Firewall has populated from your file. Network Firewall uses the file contents to populate the rule group rules, but does not maintain a reference to the file or use the file in any way after performing the create or update. If you call DescribeRuleGroup to retrieve the rule group, Network Firewall returns rules settings inside a RuleGroup object.
public void setType(String type)
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.
type - 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.RuleGroupTypepublic String getType()
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.
RuleGroupTypepublic CreateRuleGroupRequest withType(String type)
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.
type - 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.RuleGroupTypepublic CreateRuleGroupRequest withType(RuleGroupType type)
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.
type - 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.RuleGroupTypepublic void setDescription(String description)
A description of the rule group.
description - A description of the rule group.public String getDescription()
A description of the rule group.
public CreateRuleGroupRequest withDescription(String description)
A description of the rule group.
description - A description of the rule group.public void setCapacity(Integer capacity)
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. 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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
capacity - The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by
calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
public Integer getCapacity()
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. 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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
You can retrieve the capacity that would be required for a rule group before you create the rule group by
calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
public CreateRuleGroupRequest withCapacity(Integer capacity)
The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation. 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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by calling
CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
capacity - The maximum operating resources that this rule group can use. Rule group capacity is fixed at creation.
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.
You can retrieve the capacity that would be required for a rule group before you create the rule group by
calling CreateRuleGroup with DryRun set to TRUE.
You can't change or exceed this capacity when you update the rule group, so leave room for your rule group to grow.
Capacity for a stateless rule group
For a stateless rule group, the capacity required is the sum of the capacity requirements of the individual rules that you expect to have in the rule group.
To calculate the capacity requirement of a single rule, multiply the capacity requirement values of each of the rule's match settings:
A match setting with no criteria specified has a value of 1.
A match setting with Any specified has a value of 1.
All other match settings have a value equal to the number of elements provided in the setting. For example, a protocol setting ["UDP"] and a source setting ["10.0.0.0/24"] each have a value of 1. A protocol setting ["UDP","TCP"] has a value of 2. A source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"] has a value of 3.
A rule with no criteria specified in any of its match settings has a capacity requirement of 1. A rule with protocol setting ["UDP","TCP"], source setting ["10.0.0.0/24","10.0.0.1/24","10.0.0.2/24"], and a single specification or no specification for each of the other match settings has a capacity requirement of 6.
Capacity for a stateful rule group
For a stateful rule group, the minimum capacity required is the number of individual rules that you expect to have in the rule group.
public List<Tag> getTags()
The key:value pairs to associate with the resource.
public void setTags(Collection<Tag> tags)
The key:value pairs to associate with the resource.
tags - The key:value pairs to associate with the resource.public CreateRuleGroupRequest withTags(Tag... tags)
The key:value pairs to associate with the resource.
NOTE: This method appends the values to the existing list (if any). Use
setTags(java.util.Collection) or withTags(java.util.Collection) if you want to override the
existing values.
tags - The key:value pairs to associate with the resource.public CreateRuleGroupRequest withTags(Collection<Tag> tags)
The key:value pairs to associate with the resource.
tags - The key:value pairs to associate with the resource.public void setDryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran it with
dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows
you to make sure that you have the required permissions to run the request and that your request parameters are
valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
dryRun - Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran
it with dry run set to FALSE, but doesn't make additions or changes to your resources. This
option allows you to make sure that you have the required permissions to run the request and that your
request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
public Boolean getDryRun()
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran it with
dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows
you to make sure that you have the required permissions to run the request and that your request parameters are
valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
If set to TRUE, Network Firewall checks whether the request can run successfully, but
doesn't actually make the requested changes. The call returns the value that the request would return if
you ran it with dry run set to FALSE, but doesn't make additions or changes to your
resources. This option allows you to make sure that you have the required permissions to run the request
and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
public CreateRuleGroupRequest withDryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran it with
dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows
you to make sure that you have the required permissions to run the request and that your request parameters are
valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
dryRun - Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran
it with dry run set to FALSE, but doesn't make additions or changes to your resources. This
option allows you to make sure that you have the required permissions to run the request and that your
request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
public Boolean isDryRun()
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the request.
If set to TRUE, Network Firewall checks whether the request can run successfully, but doesn't
actually make the requested changes. The call returns the value that the request would return if you ran it with
dry run set to FALSE, but doesn't make additions or changes to your resources. This option allows
you to make sure that you have the required permissions to run the request and that your request parameters are
valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
If set to TRUE, Network Firewall checks whether the request can run successfully, but
doesn't actually make the requested changes. The call returns the value that the request would return if
you ran it with dry run set to FALSE, but doesn't make additions or changes to your
resources. This option allows you to make sure that you have the required permissions to run the request
and that your request parameters are valid.
If set to FALSE, Network Firewall makes the requested changes to your resources.
public String toString()
toString in class ObjectObject.toString()public CreateRuleGroupRequest clone()
AmazonWebServiceRequestclone in class AmazonWebServiceRequestObject.clone()