CreateIpSetRequest.Builder (AWS Java SDK :: Services

All Superinterfaces:

AwsRequest.Builder, Buildable, CopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>, SdkBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>, SdkPojo, SdkRequest.Builder, Wafv2Request.Builder

Enclosing class:

CreateIpSetRequest
```
public static interface CreateIpSetRequest.Builder
extends Wafv2Request.Builder, SdkPojo, CopyableBuilder<CreateIpSetRequest.Builder,CreateIpSetRequest>
```

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method and Description
`CreateIpSetRequest.Builder`	`addresses(Collection<String> addresses)` Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests.
`CreateIpSetRequest.Builder`	`addresses(String... addresses)` Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests.
`CreateIpSetRequest.Builder`	`description(String description)` A description of the IP set that helps with identification.
`CreateIpSetRequest.Builder`	`ipAddressVersion(IPAddressVersion ipAddressVersion)` The version of the IP addresses, either `IPV4` or `IPV6`.
`CreateIpSetRequest.Builder`	`ipAddressVersion(String ipAddressVersion)` The version of the IP addresses, either `IPV4` or `IPV6`.
`CreateIpSetRequest.Builder`	`name(String name)` The name of the IP set.
`CreateIpSetRequest.Builder`	`overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)`
`CreateIpSetRequest.Builder`	`overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)`
`CreateIpSetRequest.Builder`	`scope(Scope scope)` Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
`CreateIpSetRequest.Builder`	`scope(String scope)` Specifies whether this is for an Amazon CloudFront distribution or for a regional application.
`CreateIpSetRequest.Builder`	`tags(Collection<Tag> tags)` An array of key:value pairs to associate with the resource.
`CreateIpSetRequest.Builder`	`tags(Consumer<Tag.Builder>... tags)` An array of key:value pairs to associate with the resource.
`CreateIpSetRequest.Builder`	`tags(Tag... tags)` An array of key:value pairs to associate with the resource.

Methods inherited from interface software.amazon.awssdk.services.wafv2.model.Wafv2Request.Builder
build

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder
overrideConfiguration

Methods inherited from interface software.amazon.awssdk.core.SdkPojo
equalsBySdkFields, sdkFields

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder
copy

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder
applyMutation, build

- Method Detail
  - name
```
CreateIpSetRequest.Builder name(String name)
```
    The name of the IP set. You cannot change the name of an IPSet after you create it.
    
    Parameters:
    
    name - The name of the IP set. You cannot change the name of an IPSet after you create it.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - scope
```
CreateIpSetRequest.Builder scope(String scope)
```
    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
    
    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
    - CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    - API and SDKs - For all calls, use the Region endpoint us-east-1.
    Parameters:
    scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
    
    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
    
    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    
    API and SDKs - For all calls, use the Region endpoint us-east-1.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Scope, Scope
  - scope
```
CreateIpSetRequest.Builder scope(Scope scope)
```
    Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
    
    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
    - CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    - API and SDKs - For all calls, use the Region endpoint us-east-1.
    Parameters:
    scope - Specifies whether this is for an Amazon CloudFront distribution or for a regional application. A regional application can be an Application Load Balancer (ALB), an Amazon API Gateway REST API, an AppSync GraphQL API, an Amazon Cognito user pool, an App Runner service, or an Amazon Web Services Verified Access instance.
    
    To work with CloudFront, you must also specify the Region US East (N. Virginia) as follows:
    
    CLI - Specify the Region when you use the CloudFront scope: --scope=CLOUDFRONT --region=us-east-1.
    
    API and SDKs - For all calls, use the Region endpoint us-east-1.
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    Scope, Scope
  - description
```
CreateIpSetRequest.Builder description(String description)
```
    A description of the IP set that helps with identification.
    
    Parameters:
    
    description - A description of the IP set that helps with identification.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - ipAddressVersion
```
CreateIpSetRequest.Builder ipAddressVersion(String ipAddressVersion)
```
    The version of the IP addresses, either IPV4 or IPV6.
    
    Parameters:
    
    ipAddressVersion - The version of the IP addresses, either IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IPAddressVersion, IPAddressVersion
  - ipAddressVersion
```
CreateIpSetRequest.Builder ipAddressVersion(IPAddressVersion ipAddressVersion)
```
    The version of the IP addresses, either IPV4 or IPV6.
    
    Parameters:
    
    ipAddressVersion - The version of the IP addresses, either IPV4 or IPV6.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    IPAddressVersion, IPAddressVersion
  - addresses
```
CreateIpSetRequest.Builder addresses(Collection<String> addresses)
```
    Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    - For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Example JSON Addresses specifications:
    - Empty array: "Addresses": []
    - Array with one address: "Addresses": ["192.0.2.44/32"]
    - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    - INVALID specification: "Addresses": [""] INVALID
    Parameters:
    addresses - Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    
    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Example JSON Addresses specifications:
    
    Empty array: "Addresses": []
    
    Array with one address: "Addresses": ["192.0.2.44/32"]
    
    Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    
    INVALID specification: "Addresses": [""] INVALID
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - addresses
```
CreateIpSetRequest.Builder addresses(String... addresses)
```
    Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    - For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    - For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    - For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    - For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Example JSON Addresses specifications:
    - Empty array: "Addresses": []
    - Array with one address: "Addresses": ["192.0.2.44/32"]
    - Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    - INVALID specification: "Addresses": [""] INVALID
    Parameters:
    addresses - Contains an array of strings that specifies zero or more IP addresses or blocks of IP addresses that you want WAF to inspect for in incoming requests. All addresses must be specified using Classless Inter-Domain Routing (CIDR) notation. WAF supports all IPv4 and IPv6 CIDR ranges except for /0.
    
    Example address strings:
    
    For requests that originated from the IP address 192.0.2.44, specify 192.0.2.44/32.
    
    For requests that originated from IP addresses from 192.0.2.0 to 192.0.2.255, specify 192.0.2.0/24.
    
    For requests that originated from the IP address 1111:0000:0000:0000:0000:0000:0000:0111, specify 1111:0000:0000:0000:0000:0000:0000:0111/128.
    
    For requests that originated from IP addresses 1111:0000:0000:0000:0000:0000:0000:0000 to 1111:0000:0000:0000:ffff:ffff:ffff:ffff, specify 1111:0000:0000:0000:0000:0000:0000:0000/64.
    
    For more information about CIDR notation, see the Wikipedia entry Classless Inter-Domain Routing.
    
    Example JSON Addresses specifications:
    
    Empty array: "Addresses": []
    
    Array with one address: "Addresses": ["192.0.2.44/32"]
    
    Array with three addresses: "Addresses": ["192.0.2.44/32", "192.0.2.0/24", "192.0.0.0/16"]
    
    INVALID specification: "Addresses": [""] INVALID
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateIpSetRequest.Builder tags(Collection<Tag> tags)
```
    An array of key:value pairs to associate with the resource.
    
    Parameters:
    
    tags - An array of key:value pairs to associate with the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateIpSetRequest.Builder tags(Tag... tags)
```
    An array of key:value pairs to associate with the resource.
    
    Parameters:
    
    tags - An array of key:value pairs to associate with the resource.
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
  - tags
```
CreateIpSetRequest.Builder tags(Consumer<Tag.Builder>... tags)
```
    An array of key:value pairs to associate with the resource.
    This is a convenience method that creates an instance of the Tag.Builder avoiding the need to create one manually via Tag.builder().
    When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to #tags(List).
    
    Parameters:
    
    tags - a consumer that will call methods on Tag.Builder
    
    Returns:
    
    Returns a reference to this object so that method calls can be chained together.
    
    See Also:
    
    #tags(java.util.Collection)
  - overrideConfiguration
```
CreateIpSetRequest.Builder overrideConfiguration(AwsRequestOverrideConfiguration overrideConfiguration)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder
  - overrideConfiguration
```
CreateIpSetRequest.Builder overrideConfiguration(Consumer<AwsRequestOverrideConfiguration.Builder> builderConsumer)
```
    Specified by:
    
    overrideConfiguration in interface AwsRequest.Builder

Interface CreateIpSetRequest.Builder

Method Summary

Methods inherited from interface software.amazon.awssdk.services.wafv2.model.Wafv2Request.Builder

Methods inherited from interface software.amazon.awssdk.awscore.AwsRequest.Builder

Methods inherited from interface software.amazon.awssdk.core.SdkPojo

Methods inherited from interface software.amazon.awssdk.utils.builder.CopyableBuilder

Methods inherited from interface software.amazon.awssdk.utils.builder.SdkBuilder

Method Detail

name

scope

scope

description

ipAddressVersion

ipAddressVersion

addresses

addresses

tags

tags

tags

overrideConfiguration

overrideConfiguration