@Generated(value="com.amazonaws:aws-java-sdk-code-generator") public class UpdateRuleGroupRequest extends AmazonWebServiceRequest implements Serializable, Cloneable
NOOP
Constructor and Description |
---|
UpdateRuleGroupRequest() |
Modifier and Type | Method and Description |
---|---|
UpdateRuleGroupRequest |
clone()
Creates a shallow clone of this object for all fields except the handler context.
|
boolean |
equals(Object obj) |
Boolean |
getAnalyzeRuleGroup()
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing.
|
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.
|
EncryptionConfiguration |
getEncryptionConfiguration()
A complex type that contains settings for encryption of your rule group resources.
|
RuleGroup |
getRuleGroup()
An object that defines the rule group rules.
|
String |
getRuleGroupArn()
The Amazon Resource Name (ARN) of the rule group.
|
String |
getRuleGroupName()
The descriptive name of the rule group.
|
String |
getRules()
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
|
SourceMetadata |
getSourceMetadata()
A complex type that contains metadata about the rule group that your own rule group is copied from.
|
String |
getType()
Indicates whether the rule group is stateless or stateful.
|
String |
getUpdateToken()
A token used for optimistic locking.
|
int |
hashCode() |
Boolean |
isAnalyzeRuleGroup()
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing.
|
Boolean |
isDryRun()
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
void |
setAnalyzeRuleGroup(Boolean analyzeRuleGroup)
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing.
|
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 |
setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
|
void |
setRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
|
void |
setRuleGroupArn(String ruleGroupArn)
The Amazon Resource Name (ARN) of the rule group.
|
void |
setRuleGroupName(String ruleGroupName)
The descriptive name of the rule group.
|
void |
setRules(String rules)
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
|
void |
setSourceMetadata(SourceMetadata sourceMetadata)
A complex type that contains metadata about the rule group that your own rule group is copied from.
|
void |
setType(String type)
Indicates whether the rule group is stateless or stateful.
|
void |
setUpdateToken(String updateToken)
A token used for optimistic locking.
|
String |
toString()
Returns a string representation of this object.
|
UpdateRuleGroupRequest |
withAnalyzeRuleGroup(Boolean analyzeRuleGroup)
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing.
|
UpdateRuleGroupRequest |
withDescription(String description)
A description of the rule group.
|
UpdateRuleGroupRequest |
withDryRun(Boolean dryRun)
Indicates whether you want Network Firewall to just check the validity of the request, rather than run the
request.
|
UpdateRuleGroupRequest |
withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
|
UpdateRuleGroupRequest |
withRuleGroup(RuleGroup ruleGroup)
An object that defines the rule group rules.
|
UpdateRuleGroupRequest |
withRuleGroupArn(String ruleGroupArn)
The Amazon Resource Name (ARN) of the rule group.
|
UpdateRuleGroupRequest |
withRuleGroupName(String ruleGroupName)
The descriptive name of the rule group.
|
UpdateRuleGroupRequest |
withRules(String rules)
A string containing stateful rule group rules specifications in Suricata flat format, with one rule per line.
|
UpdateRuleGroupRequest |
withSourceMetadata(SourceMetadata sourceMetadata)
A complex type that contains metadata about the rule group that your own rule group is copied from.
|
UpdateRuleGroupRequest |
withType(RuleGroupType type)
Indicates whether the rule group is stateless or stateful.
|
UpdateRuleGroupRequest |
withType(String type)
Indicates whether the rule group is stateless or stateful.
|
UpdateRuleGroupRequest |
withUpdateToken(String updateToken)
A token used for optimistic locking.
|
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, withSdkRequestTimeout
public void setUpdateToken(String updateToken)
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy
of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
updateToken
- A token used for optimistic locking. Network Firewall returns a token to your requests that access the
rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation
fails with an InvalidTokenException
. If this happens, retrieve the rule group again to get a
current copy of it with a current token. Reapply your changes as needed, then try the operation again
using the new token.
public String getUpdateToken()
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy
of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the
operation fails with an InvalidTokenException
. If this happens, retrieve the rule group
again to get a current copy of it with a current token. Reapply your changes as needed, then try the
operation again using the new token.
public UpdateRuleGroupRequest withUpdateToken(String updateToken)
A token used for optimistic locking. Network Firewall returns a token to your requests that access the rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token to
ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation fails
with an InvalidTokenException
. If this happens, retrieve the rule group again to get a current copy
of it with a current token. Reapply your changes as needed, then try the operation again using the new token.
updateToken
- A token used for optimistic locking. Network Firewall returns a token to your requests that access the
rule group. The token marks the state of the rule group resource at the time of the request.
To make changes to the rule group, you provide the token in your request. Network Firewall uses the token
to ensure that the rule group hasn't changed since you last retrieved it. If it has changed, the operation
fails with an InvalidTokenException
. If this happens, retrieve the rule group again to get a
current copy of it with a current token. Reapply your changes as needed, then try the operation again
using the new token.
public void setRuleGroupArn(String ruleGroupArn)
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
ruleGroupArn
- The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
public String getRuleGroupArn()
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
You must specify the ARN or the name, and you can specify both.
public UpdateRuleGroupRequest withRuleGroupArn(String ruleGroupArn)
The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
ruleGroupArn
- The Amazon Resource Name (ARN) of the rule group.
You must specify the ARN or the name, and you can specify both.
public 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.
You must specify the ARN or the name, and you can specify both.
ruleGroupName
- The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
public String getRuleGroupName()
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
You must specify the ARN or the name, and you can specify both.
public UpdateRuleGroupRequest withRuleGroupName(String ruleGroupName)
The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
ruleGroupName
- The descriptive name of the rule group. You can't change the name of a rule group after you create it.
You must specify the ARN or the name, and you can specify both.
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 UpdateRuleGroupRequest 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)
A string 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 Suricata flat format 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 string.
rules
- A string 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 Suricata flat format 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 string.
public String getRules()
A string 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 Suricata flat format 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 string.
You must provide either this rules setting or a populated RuleGroup
setting, but not both.
You can provide your rule group specification in Suricata flat format 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 string.
public UpdateRuleGroupRequest withRules(String rules)
A string 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 Suricata flat format 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 string.
rules
- A string 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 Suricata flat format 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 string.
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.
This setting is required for requests that do not include the RuleGroupARN
.
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.
This setting is required for requests that do not include the RuleGroupARN
.
RuleGroupType
public 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.
This setting is required for requests that do not include the RuleGroupARN
.
This setting is required for requests that do not include the RuleGroupARN
.
RuleGroupType
public UpdateRuleGroupRequest 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.
This setting is required for requests that do not include the RuleGroupARN
.
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.
This setting is required for requests that do not include the RuleGroupARN
.
RuleGroupType
public UpdateRuleGroupRequest 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.
This setting is required for requests that do not include the RuleGroupARN
.
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.
This setting is required for requests that do not include the RuleGroupARN
.
RuleGroupType
public 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 UpdateRuleGroupRequest withDescription(String description)
A description of the rule group.
description
- A description of the rule group.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 UpdateRuleGroupRequest 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 void setEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
encryptionConfiguration
- A complex type that contains settings for encryption of your rule group resources.public EncryptionConfiguration getEncryptionConfiguration()
A complex type that contains settings for encryption of your rule group resources.
public UpdateRuleGroupRequest withEncryptionConfiguration(EncryptionConfiguration encryptionConfiguration)
A complex type that contains settings for encryption of your rule group resources.
encryptionConfiguration
- A complex type that contains settings for encryption of your rule group resources.public void setSourceMetadata(SourceMetadata sourceMetadata)
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
sourceMetadata
- A complex type that contains metadata about the rule group that your own rule group is copied from. You
can use the metadata to keep track of updates made to the originating rule group.public SourceMetadata getSourceMetadata()
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
public UpdateRuleGroupRequest withSourceMetadata(SourceMetadata sourceMetadata)
A complex type that contains metadata about the rule group that your own rule group is copied from. You can use the metadata to keep track of updates made to the originating rule group.
sourceMetadata
- A complex type that contains metadata about the rule group that your own rule group is copied from. You
can use the metadata to keep track of updates made to the originating rule group.public void setAnalyzeRuleGroup(Boolean analyzeRuleGroup)
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the
rule group for you. To run the stateless rule group analyzer without updating the rule group, set
DryRun
to TRUE
.
analyzeRuleGroup
- Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule
behavior such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and
then updates the rule group for you. To run the stateless rule group analyzer without updating the rule
group, set DryRun
to TRUE
.public Boolean getAnalyzeRuleGroup()
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the
rule group for you. To run the stateless rule group analyzer without updating the rule group, set
DryRun
to TRUE
.
TRUE
, Network Firewall runs the analysis and
then updates the rule group for you. To run the stateless rule group analyzer without updating the rule
group, set DryRun
to TRUE
.public UpdateRuleGroupRequest withAnalyzeRuleGroup(Boolean analyzeRuleGroup)
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the
rule group for you. To run the stateless rule group analyzer without updating the rule group, set
DryRun
to TRUE
.
analyzeRuleGroup
- Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule
behavior such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and
then updates the rule group for you. To run the stateless rule group analyzer without updating the rule
group, set DryRun
to TRUE
.public Boolean isAnalyzeRuleGroup()
Indicates whether you want Network Firewall to analyze the stateless rules in the rule group for rule behavior
such as asymmetric routing. If set to TRUE
, Network Firewall runs the analysis and then updates the
rule group for you. To run the stateless rule group analyzer without updating the rule group, set
DryRun
to TRUE
.
TRUE
, Network Firewall runs the analysis and
then updates the rule group for you. To run the stateless rule group analyzer without updating the rule
group, set DryRun
to TRUE
.public String toString()
toString
in class Object
Object.toString()
public UpdateRuleGroupRequest clone()
AmazonWebServiceRequest
clone
in class AmazonWebServiceRequest
Object.clone()