Class ProvisionByoipCidrRequest
- java.lang.Object
-
- software.amazon.awssdk.core.SdkRequest
-
- software.amazon.awssdk.awscore.AwsRequest
-
- software.amazon.awssdk.services.ec2.model.Ec2Request
-
- software.amazon.awssdk.services.ec2.model.ProvisionByoipCidrRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>
@Generated("software.amazon.awssdk:codegen") public final class ProvisionByoipCidrRequest extends Ec2Request implements ToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
ProvisionByoipCidrRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description static ProvisionByoipCidrRequest.Builder
builder()
String
cidr()
The public IPv4 or IPv6 address range, in CIDR notation.CidrAuthorizationContext
cidrAuthorizationContext()
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.String
description()
A description for the address range and the address pool.Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.boolean
equals(Object obj)
boolean
equalsBySdkFields(Object obj)
<T> Optional<T>
getValueForField(String fieldName, Class<T> clazz)
int
hashCode()
boolean
hasPoolTagSpecifications()
For responses, this returns true if the service returned a value for the PoolTagSpecifications property.Boolean
multiRegion()
Reserved.String
networkBorderGroup()
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR.List<TagSpecification>
poolTagSpecifications()
The tags to apply to the address pool.Boolean
publiclyAdvertisable()
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.List<SdkField<?>>
sdkFields()
static Class<? extends ProvisionByoipCidrRequest.Builder>
serializableBuilderClass()
ProvisionByoipCidrRequest.Builder
toBuilder()
String
toString()
Returns a string representation of this object.-
Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
-
Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
-
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
-
-
-
Method Detail
-
cidr
public final String cidr()
The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
- Returns:
- The public IPv4 or IPv6 address range, in CIDR notation. The most specific IPv4 prefix that you can specify is /24. The most specific IPv6 address range that you can bring is /48 for CIDRs that are publicly advertisable and /56 for CIDRs that are not publicly advertisable. The address range cannot overlap with another address range that you've brought to this or another Region.
-
cidrAuthorizationContext
public final CidrAuthorizationContext cidrAuthorizationContext()
A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
- Returns:
- A signed document that proves that you are authorized to bring the specified IP address range to Amazon using BYOIP.
-
publiclyAdvertisable
public final Boolean publiclyAdvertisable()
(IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
- Returns:
- (IPv6 only) Indicate whether the address range will be publicly advertised to the internet.
Default: true
-
description
public final String description()
A description for the address range and the address pool.
- Returns:
- A description for the address range and the address pool.
-
dryRun
public final Boolean dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.- Returns:
- Checks whether you have the required permissions for the action, without actually making the request, and
provides an error response. If you have the required permissions, the error response is
DryRunOperation
. Otherwise, it isUnauthorizedOperation
.
-
hasPoolTagSpecifications
public final boolean hasPoolTagSpecifications()
For responses, this returns true if the service returned a value for the PoolTagSpecifications property. This DOES NOT check that the value is non-empty (for which, you should check theisEmpty()
method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
-
poolTagSpecifications
public final List<TagSpecification> poolTagSpecifications()
The tags to apply to the address pool.
Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the
hasPoolTagSpecifications()
method.- Returns:
- The tags to apply to the address pool.
-
multiRegion
public final Boolean multiRegion()
Reserved.
- Returns:
- Reserved.
-
networkBorderGroup
public final String networkBorderGroup()
If you have Local Zones enabled, you can choose a network border group for Local Zones when you provision and advertise a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
-
us-east-1-dfw-2
-
us-west-2-lax-1
-
us-west-2-phx-2
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
- Returns:
- If you have Local
Zones enabled, you can choose a network border group for Local Zones when you provision and advertise
a BYOIPv4 CIDR. Choose the network border group carefully as the EIP and the Amazon Web Services resource
it is associated with must reside in the same network border group.
You can provision BYOIP address ranges to and advertise them in the following Local Zone network border groups:
-
us-east-1-dfw-2
-
us-west-2-lax-1
-
us-west-2-phx-2
You cannot provision or advertise BYOIPv6 address ranges in Local Zones at this time.
-
-
-
toBuilder
public ProvisionByoipCidrRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<ProvisionByoipCidrRequest.Builder,ProvisionByoipCidrRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static ProvisionByoipCidrRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends ProvisionByoipCidrRequest.Builder> serializableBuilderClass()
-
hashCode
public final int hashCode()
- Overrides:
hashCode
in classAwsRequest
-
equals
public final boolean equals(Object obj)
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
public final boolean equalsBySdkFields(Object obj)
- Specified by:
equalsBySdkFields
in interfaceSdkPojo
-
toString
public final String toString()
Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
-
getValueForField
public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)
- Overrides:
getValueForField
in classSdkRequest
-
-