Class CreateVpcRequest
- All Implemented Interfaces:
SdkPojo
,ToCopyableBuilder<CreateVpcRequest.Builder,
CreateVpcRequest>
-
Nested Class Summary
-
Method Summary
Modifier and TypeMethodDescriptionfinal Boolean
Requests an Amazon-provided IPv6 CIDR block with a /56 prefix length for the VPC.static CreateVpcRequest.Builder
builder()
final String
The IPv4 network range for the VPC, in CIDR notation.final Boolean
dryRun()
Checks whether you have the required permissions for the action, without actually making the request, and provides an error response.final boolean
final boolean
equalsBySdkFields
(Object obj) Indicates whether some other object is "equal to" this one by SDK fields.final <T> Optional
<T> getValueForField
(String fieldName, Class<T> clazz) Used to retrieve the value of a field from any class that extendsSdkRequest
.final int
hashCode()
final boolean
For responses, this returns true if the service returned a value for the TagSpecifications property.final Tenancy
The tenancy options for instances launched into the VPC.final String
The tenancy options for instances launched into the VPC.final String
The ID of an IPv4 IPAM pool you want to use for allocating this VPC's CIDR.final Integer
The netmask length of the IPv4 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.final String
The IPv6 CIDR block from the IPv6 address pool.final String
The name of the location from which we advertise the IPV6 CIDR block.final String
The ID of an IPv6 IPAM pool which will be used to allocate this VPC an IPv6 CIDR.final Integer
The netmask length of the IPv6 CIDR you want to allocate to this VPC from an Amazon VPC IP Address Manager (IPAM) pool.final String
ipv6Pool()
The ID of an IPv6 address pool from which to allocate the IPv6 CIDR block.static Class
<? extends CreateVpcRequest.Builder> final List
<TagSpecification> The tags to assign to the VPC.Take this object and create a builder that contains all of the current property values of this object.final String
toString()
Returns a string representation of this object.Methods inherited from class software.amazon.awssdk.awscore.AwsRequest
overrideConfiguration
Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy
-
Method Details
-
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
.
-
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.
-
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
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
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
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
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
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.
-
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
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:
-
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:
-
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
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.
-
toBuilder
Description copied from interface:ToCopyableBuilder
Take this object and create a builder that contains all of the current property values of this object.- Specified by:
toBuilder
in interfaceToCopyableBuilder<CreateVpcRequest.Builder,
CreateVpcRequest> - Specified by:
toBuilder
in classEc2Request
- Returns:
- a builder for type T
-
builder
-
serializableBuilderClass
-
hashCode
public final int hashCode()- Overrides:
hashCode
in classAwsRequest
-
equals
- Overrides:
equals
in classAwsRequest
-
equalsBySdkFields
Description copied from interface:SdkPojo
Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in anSdkPojo
class, and is generated based on a service model.If an
SdkPojo
class does not have any inherited fields,equalsBySdkFields
andequals
are essentially the same.- Specified by:
equalsBySdkFields
in interfaceSdkPojo
- Parameters:
obj
- the object to be compared with- Returns:
- true if the other object equals to this object by sdk fields, false otherwise.
-
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
Description copied from class:SdkRequest
Used to retrieve the value of a field from any class that extendsSdkRequest
. The field name specified should match the member name from the corresponding service-2.json model specified in the codegen-resources folder for a given service. The class specifies what class to cast the returned value to. If the returned value is also a modeled class, theSdkRequest.getValueForField(String, Class)
method will again be available.- Overrides:
getValueForField
in classSdkRequest
- Parameters:
fieldName
- The name of the member to be retrieved.clazz
- The class to cast the returned object to.- Returns:
- Optional containing the casted return value
-
sdkFields
-