Class CreateVpcRequest
- 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.CreateVpcRequest
-
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateVpcRequest.Builder,CreateVpcRequest>
@Generated("software.amazon.awssdk:codegen") public final class CreateVpcRequest extends Ec2Request implements ToCopyableBuilder<CreateVpcRequest.Builder,CreateVpcRequest>
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static interface
CreateVpcRequest.Builder
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description Boolean
amazonProvidedIpv6CidrBlock()
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.static CreateVpcRequest.Builder
builder()
String
cidrBlock()
The IPv4 network range for the VPC, in CIDR notation.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
hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications property.Tenancy
instanceTenancy()
The tenancy options for instances launched into the VPC.String
instanceTenancyAsString()
The tenancy options for instances launched into the VPC.String
ipv4IpamPoolId()
The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.Integer
ipv4NetmaskLength()
The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.String
ipv6CidrBlock()
The IPv6 CIDR block from the IPv6 address pool.String
ipv6CidrBlockNetworkBorderGroup()
The name of the location from which we advertise the IPV6 CIDR block.String
ipv6IpamPoolId()
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR.Integer
ipv6NetmaskLength()
The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.String
ipv6Pool()
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.Map<String,SdkField<?>>
sdkFieldNameToField()
List<SdkField<?>>
sdkFields()
static Class<? extends CreateVpcRequest.Builder>
serializableBuilderClass()
List<TagSpecification>
tagSpecifications()
The tags to assign to the VPC.CreateVpcRequest.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
-
cidrBlock
public final String cidrBlock()
The IPv4 network range for the VPC, in CIDR notation. For example,
10.0.0.0/16
. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18
, we modify it to100.68.0.0/18
.- Returns:
- The IPv4 network range for the VPC, in CIDR notation. For example,
10.0.0.0/16
. We modify the specified CIDR block to its canonical form; for example, if you specify100.68.0.18/18
, we modify it to100.68.0.0/18
.
-
ipv6Pool
public final String ipv6Pool()
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
- Returns:
- The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.
-
ipv6CidrBlock
public final String ipv6CidrBlock()
The IPv6 CIDR block from the IPv6 address pool. You must also specify
Ipv6Pool
in the request.To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
- Returns:
- The IPv6 CIDR block from the IPv6 address pool. You must also specify
Ipv6Pool
in the request.To let Amazon choose the IPv6 CIDR block for you, omit this parameter.
-
ipv4IpamPoolId
public final String ipv4IpamPoolId()
The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
- Returns:
- The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
-
ipv4NetmaskLength
public final Integer ipv4NetmaskLength()
The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
- Returns:
- The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
-
ipv6IpamPoolId
public final String ipv6IpamPoolId()
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
- Returns:
- The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR. IPAM is a VPC feature that you can use to automate your IP address management workflows including assigning, tracking, troubleshooting, and auditing IP addresses across Amazon Web Services Regions and accounts throughout your Amazon Web Services Organization. For more information, see What is IPAM? in the Amazon VPC IPAM User Guide.
-
ipv6NetmaskLength
public final Integer ipv6NetmaskLength()
The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
- Returns:
- The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool. For more information about IPAM, see What is IPAM? in the Amazon VPC IPAM User Guide.
-
ipv6CidrBlockNetworkBorderGroup
public final String ipv6CidrBlockNetworkBorderGroup()
The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the address to this location.
You must set
AmazonProvidedIpv6CidrBlock
totrue
to use this parameter.- Returns:
- The name of the location from which we advertise the IPV6 CIDR block. Use this parameter to limit the
address to this location.
You must set
AmazonProvidedIpv6CidrBlock
totrue
to use this parameter.
-
hasTagSpecifications
public final boolean hasTagSpecifications()
For responses, this returns true if the service returned a value for the TagSpecifications 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.
-
tagSpecifications
public final List<TagSpecification> tagSpecifications()
The tags to assign to the VPC.
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
hasTagSpecifications()
method.- Returns:
- The tags to assign to the VPC.
-
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
.
-
instanceTenancy
public final Tenancy instanceTenancy()
The tenancy options for instances launched into the VPC. For
default
, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. Fordedicated
, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy ofdedicated
orhost
into a dedicated tenancy VPC.Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy options for instances launched into the VPC. For
default
, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. Fordedicated
, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy ofdedicated
orhost
into a dedicated tenancy VPC.Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
- See Also:
Tenancy
-
instanceTenancyAsString
public final String instanceTenancyAsString()
The tenancy options for instances launched into the VPC. For
default
, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. Fordedicated
, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy ofdedicated
orhost
into a dedicated tenancy VPC.Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
If the service returns an enum value that is not available in the current SDK version,
instanceTenancy
will returnTenancy.UNKNOWN_TO_SDK_VERSION
. The raw value returned by the service is available frominstanceTenancyAsString()
.- Returns:
- The tenancy options for instances launched into the VPC. For
default
, instances are launched with shared tenancy by default. You can launch instances with any tenancy into a shared tenancy VPC. Fordedicated
, instances are launched as dedicated tenancy instances by default. You can only launch instances with a tenancy ofdedicated
orhost
into a dedicated tenancy VPC.Important: The
host
value cannot be used with this parameter. Use thedefault
ordedicated
values only.Default:
default
- See Also:
Tenancy
-
amazonProvidedIpv6CidrBlock
public final Boolean amazonProvidedIpv6CidrBlock()
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
- Returns:
- Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC. You cannot specify the range of IP addresses, or the size of the CIDR block.
-
toBuilder
public CreateVpcRequest.Builder toBuilder()
- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateVpcRequest.Builder,CreateVpcRequest>
- Specified by:
toBuilder
in classEc2Request
-
builder
public static CreateVpcRequest.Builder builder()
-
serializableBuilderClass
public static Class<? extends CreateVpcRequest.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
-
sdkFieldNameToField
public final Map<String,SdkField<?>> sdkFieldNameToField()
- Specified by:
sdkFieldNameToField
in interfaceSdkPojo
-
-