Interface RuleCondition.Builder
-
- All Superinterfaces:
Buildable,CopyableBuilder<RuleCondition.Builder,RuleCondition>,SdkBuilder<RuleCondition.Builder,RuleCondition>,SdkPojo
- Enclosing class:
- RuleCondition
public static interface RuleCondition.Builder extends SdkPojo, CopyableBuilder<RuleCondition.Builder,RuleCondition>
-
-
Method Summary
-
Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy
-
Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build
-
Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields
-
-
-
-
Method Detail
-
field
RuleCondition.Builder field(String field)
The field in the HTTP request. The following are the possible values:
-
http-header -
http-request-method -
host-header -
path-pattern -
query-string -
source-ip
- Parameters:
field- The field in the HTTP request. The following are the possible values:-
http-header -
http-request-method -
host-header -
path-pattern -
query-string -
source-ip
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
values
RuleCondition.Builder values(Collection<String> values)
The condition value. Specify only when
Fieldishost-headerorpath-pattern. Alternatively, to specify multiple host names or multiple path patterns, useHostHeaderConfigorPathPatternConfig.If
Fieldishost-headerand you are not usingHostHeaderConfig, you can specify a single host name (for example, my.example.com) inValues. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If
Fieldispath-patternand you are not usingPathPatternConfig, you can specify a single path pattern (for example, /img/*) inValues. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
- Parameters:
values- The condition value. Specify only whenFieldishost-headerorpath-pattern. Alternatively, to specify multiple host names or multiple path patterns, useHostHeaderConfigorPathPatternConfig.If
Fieldishost-headerand you are not usingHostHeaderConfig, you can specify a single host name (for example, my.example.com) inValues. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If
Fieldispath-patternand you are not usingPathPatternConfig, you can specify a single path pattern (for example, /img/*) inValues. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
values
RuleCondition.Builder values(String... values)
The condition value. Specify only when
Fieldishost-headerorpath-pattern. Alternatively, to specify multiple host names or multiple path patterns, useHostHeaderConfigorPathPatternConfig.If
Fieldishost-headerand you are not usingHostHeaderConfig, you can specify a single host name (for example, my.example.com) inValues. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If
Fieldispath-patternand you are not usingPathPatternConfig, you can specify a single path pattern (for example, /img/*) inValues. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
- Parameters:
values- The condition value. Specify only whenFieldishost-headerorpath-pattern. Alternatively, to specify multiple host names or multiple path patterns, useHostHeaderConfigorPathPatternConfig.If
Fieldishost-headerand you are not usingHostHeaderConfig, you can specify a single host name (for example, my.example.com) inValues. A host name is case insensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
- .
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
If
Fieldispath-patternand you are not usingPathPatternConfig, you can specify a single path pattern (for example, /img/*) inValues. A path pattern is case-sensitive, can be up to 128 characters in length, and can contain any of the following characters.-
A-Z, a-z, 0-9
-
_ - . $ / ~ " ' @ : +
-
& (using &)
-
* (matches 0 or more characters)
-
? (matches exactly 1 character)
-
- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
-
hostHeaderConfig
RuleCondition.Builder hostHeaderConfig(HostHeaderConditionConfig hostHeaderConfig)
Information for a host header condition. Specify only when
Fieldishost-header.- Parameters:
hostHeaderConfig- Information for a host header condition. Specify only whenFieldishost-header.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
hostHeaderConfig
default RuleCondition.Builder hostHeaderConfig(Consumer<HostHeaderConditionConfig.Builder> hostHeaderConfig)
Information for a host header condition. Specify only when
This is a convenience method that creates an instance of theFieldishost-header.HostHeaderConditionConfig.Builderavoiding the need to create one manually viaHostHeaderConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohostHeaderConfig(HostHeaderConditionConfig).- Parameters:
hostHeaderConfig- a consumer that will call methods onHostHeaderConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
hostHeaderConfig(HostHeaderConditionConfig)
-
pathPatternConfig
RuleCondition.Builder pathPatternConfig(PathPatternConditionConfig pathPatternConfig)
Information for a path pattern condition. Specify only when
Fieldispath-pattern.- Parameters:
pathPatternConfig- Information for a path pattern condition. Specify only whenFieldispath-pattern.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
pathPatternConfig
default RuleCondition.Builder pathPatternConfig(Consumer<PathPatternConditionConfig.Builder> pathPatternConfig)
Information for a path pattern condition. Specify only when
This is a convenience method that creates an instance of theFieldispath-pattern.PathPatternConditionConfig.Builderavoiding the need to create one manually viaPathPatternConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed topathPatternConfig(PathPatternConditionConfig).- Parameters:
pathPatternConfig- a consumer that will call methods onPathPatternConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
pathPatternConfig(PathPatternConditionConfig)
-
httpHeaderConfig
RuleCondition.Builder httpHeaderConfig(HttpHeaderConditionConfig httpHeaderConfig)
Information for an HTTP header condition. Specify only when
Fieldishttp-header.- Parameters:
httpHeaderConfig- Information for an HTTP header condition. Specify only whenFieldishttp-header.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpHeaderConfig
default RuleCondition.Builder httpHeaderConfig(Consumer<HttpHeaderConditionConfig.Builder> httpHeaderConfig)
Information for an HTTP header condition. Specify only when
This is a convenience method that creates an instance of theFieldishttp-header.HttpHeaderConditionConfig.Builderavoiding the need to create one manually viaHttpHeaderConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohttpHeaderConfig(HttpHeaderConditionConfig).- Parameters:
httpHeaderConfig- a consumer that will call methods onHttpHeaderConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
httpHeaderConfig(HttpHeaderConditionConfig)
-
queryStringConfig
RuleCondition.Builder queryStringConfig(QueryStringConditionConfig queryStringConfig)
Information for a query string condition. Specify only when
Fieldisquery-string.- Parameters:
queryStringConfig- Information for a query string condition. Specify only whenFieldisquery-string.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
queryStringConfig
default RuleCondition.Builder queryStringConfig(Consumer<QueryStringConditionConfig.Builder> queryStringConfig)
Information for a query string condition. Specify only when
This is a convenience method that creates an instance of theFieldisquery-string.QueryStringConditionConfig.Builderavoiding the need to create one manually viaQueryStringConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed toqueryStringConfig(QueryStringConditionConfig).- Parameters:
queryStringConfig- a consumer that will call methods onQueryStringConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
queryStringConfig(QueryStringConditionConfig)
-
httpRequestMethodConfig
RuleCondition.Builder httpRequestMethodConfig(HttpRequestMethodConditionConfig httpRequestMethodConfig)
Information for an HTTP method condition. Specify only when
Fieldishttp-request-method.- Parameters:
httpRequestMethodConfig- Information for an HTTP method condition. Specify only whenFieldishttp-request-method.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
httpRequestMethodConfig
default RuleCondition.Builder httpRequestMethodConfig(Consumer<HttpRequestMethodConditionConfig.Builder> httpRequestMethodConfig)
Information for an HTTP method condition. Specify only when
This is a convenience method that creates an instance of theFieldishttp-request-method.HttpRequestMethodConditionConfig.Builderavoiding the need to create one manually viaHttpRequestMethodConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tohttpRequestMethodConfig(HttpRequestMethodConditionConfig).- Parameters:
httpRequestMethodConfig- a consumer that will call methods onHttpRequestMethodConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
httpRequestMethodConfig(HttpRequestMethodConditionConfig)
-
sourceIpConfig
RuleCondition.Builder sourceIpConfig(SourceIpConditionConfig sourceIpConfig)
Information for a source IP condition. Specify only when
Fieldissource-ip.- Parameters:
sourceIpConfig- Information for a source IP condition. Specify only whenFieldissource-ip.- Returns:
- Returns a reference to this object so that method calls can be chained together.
-
sourceIpConfig
default RuleCondition.Builder sourceIpConfig(Consumer<SourceIpConditionConfig.Builder> sourceIpConfig)
Information for a source IP condition. Specify only when
This is a convenience method that creates an instance of theFieldissource-ip.SourceIpConditionConfig.Builderavoiding the need to create one manually viaSourceIpConditionConfig.builder().When the
Consumercompletes,SdkBuilder.build()is called immediately and its result is passed tosourceIpConfig(SourceIpConditionConfig).- Parameters:
sourceIpConfig- a consumer that will call methods onSourceIpConditionConfig.Builder- Returns:
- Returns a reference to this object so that method calls can be chained together.
- See Also:
sourceIpConfig(SourceIpConditionConfig)
-
-